__( 'Interface', 'admin-help-docs' ),
'content_output' => __( 'Content & Output', 'admin-help-docs' ),
'access_control' => __( 'Access Control', 'admin-help-docs' ),
'advanced' => __( 'Advanced', 'admin-help-docs' ),
];
return apply_filters( 'helpdocs_settings_boxes', $boxes );
} // End setting_boxes()
/**
* Returns all settings fields.
*/
public static function setting_fields( $defaults_only = false ) : array {
$themes = [];
foreach ( Colors::themes() as $key => $theme ) {
$themes[ $key ] = $theme[ 'label' ];
}
$themes[ 'custom' ] = __( 'Custom (Use the color pickers below to customize)', 'admin-help-docs' );
$top_placements = [];
foreach ( self::top_placements() as $key => $label ) {
$top_placements[] = [
'value' => $key,
'label' => $label,
];
}
$legacy_cap = get_option( 'helpdocs_user_view_cap' );
$current_type = get_option( 'helpdocs_user_view_type' );
$view_default = ( false !== $legacy_cap && false === $current_type ) ? 'capability' : 'role';
$fields = [
// Interface
[
'name' => 'menu_title',
'label' => __( 'Menu Title', 'admin-help-docs' ),
'type' => 'text',
'sanitize' => 'sanitize_text_field',
'box' => 'interface',
'default' => 'Help Docs',
],
[
'name' => 'dashicon',
'label' => __( 'Menu Icon', 'admin-help-docs' ) . ' — View Dashicons ',
'type' => 'select',
'choices' => Helpers::get_dashicons(),
'sanitize' => 'sanitize_text_field',
'box' => 'interface',
'default' => 'editor-help',
],
[
'name' => 'menu_position',
'label' => __( 'Menu Position', 'admin-help-docs' ),
'desc' => __( '1 = Above Dashboard, 2 = Under Dashboard, 999 = Bottom, etc.', 'admin-help-docs' ),
'type' => 'number',
'sanitize' => 'absint',
'box' => 'interface',
'default' => Menu::$default_menu_position,
],
[
'name' => 'page_title',
'label' => __( 'Page Title', 'admin-help-docs' ),
'type' => 'text',
'sanitize' => 'sanitize_text_field',
'box' => 'interface',
'default' => Bootstrap::name(),
],
[
'name' => 'logo',
'label' => __( 'Page Logo', 'admin-help-docs' ),
'desc' => __( 'Preferred size: 100x100 pixels. Accepted formats: jpg | jpeg | png | webp', 'admin-help-docs' ),
'type' => 'text',
'sanitize' => 'sanitize_text_field',
'box' => 'interface',
'default' => Helpers::get_default_logo_url(),
],
[
'name' => 'doc_logo',
'label' => __( 'Help Doc Logo', 'admin-help-docs' ),
'desc' => __( 'You can also change the logo on all of the help docs, which may differ from the page logo if the background is contrasted. For example a light logo on dark background at the top of the page, and a dark logo on a light background on the help docs themselves. You can also disable the help doc logo from the Content & Output settings on the right. The preferred size of the image is 100x100 pixels. Accepted formats: jpg | jpeg | png | webp', 'admin-help-docs' ),
'type' => 'text',
'sanitize' => 'sanitize_text_field',
'box' => 'interface',
'default' => Helpers::get_default_logo_url(),
],
[
'name' => 'themes',
'label' => __( 'Color Theme', 'admin-help-docs' ),
'type' => 'select',
'choices' => $themes,
'sanitize' => 'sanitize_text_field',
'box' => 'interface',
'default' => 'custom',
],
[
'name' => 'contact_form',
'label' => __( 'Enable Support Contact Form', 'admin-help-docs' ),
'desc' => sprintf(
/* translators: %s is the current site admin email address. */
__( 'Adds a simple contact form within the Help Docs menu, allowing clients to reach out for support directly. Emails will be sent from %s. This feature utilizes wp_mail() for delivery. To ensure reliable inbox placement, using a dedicated provider like WP Mail SMTP (with Brevo) is advised, along with WP Mail Logging for tracking sent messages.', 'admin-help-docs' ),
'' . esc_html( get_option( 'admin_email' ) ) . ''
),
'type' => 'checkbox',
'sanitize' => 'sanitize_checkbox',
'box' => 'interface',
'default' => false,
'has_condition' => true,
],
[
'name' => 'contact_name',
'label' => __( 'Support Contact Name', 'admin-help-docs' ),
'desc' => __( 'Enter the name that clients can use to reach you. This will be displayed on the contact form page. Can be a business or personal name.', 'admin-help-docs' ),
'type' => 'text',
'sanitize' => 'sanitize_text_field',
'box' => 'interface',
'default' => '',
'condition' => [ 'contact_form' => true ],
],
[
'name' => 'contact_emails',
'label' => __( 'Support Contact Email(s)', 'admin-help-docs' ),
'desc' => __( 'Enter the email address(es) that will receive messages from the contact form. Separate multiple emails with commas.', 'admin-help-docs' ),
'type' => 'text',
'sanitize' => 'sanitize_text_field',
'box' => 'interface',
'default' => implode( ', ', Helpers::get_all_admin_emails() ),
'condition' => [ 'contact_form' => true ],
],
[
'name' => 'contact_phone',
'label' => __( 'Support Contact Phone Number', 'admin-help-docs' ),
'desc' => __( 'Enter a phone number that clients can use to reach you. This will be displayed on the contact form page.', 'admin-help-docs' ),
'type' => 'text',
'sanitize' => 'sanitize_text_field',
'box' => 'interface',
'default' => '',
'condition' => [ 'contact_form' => true ],
],
[
'name' => 'admin_bar',
'label' => __( 'Enable Admin Bar Menu for Backend', 'admin-help-docs' ),
'type' => 'checkbox',
'sanitize' => 'sanitize_checkbox',
'box' => 'interface',
'default' => false,
],
[
'name' => 'admin_bar_frontend',
'label' => __( 'Enable Admin Bar Menu for Frontend', 'admin-help-docs' ),
'type' => 'checkbox',
'sanitize' => 'sanitize_checkbox',
'box' => 'interface',
'default' => false,
],
[
'name' => 'replace_dashboard',
'label' => __( 'Replace WordPress Dashboard with a Help Doc', 'admin-help-docs' ),
'desc' => __( 'Replace the default WordPress dashboard with a custom help docs page. To add docs, set their locations to "WordPress Dashboard (Replaces Dashboard Entirely)". Warning: Replacing the WordPress dashboard entirely may affect other plugins and functionality. No other widgets or dashboard elements will be displayed.', 'admin-help-docs' ),
'type' => 'checkbox',
'sanitize' => 'sanitize_checkbox',
'box' => 'interface',
'default' => false,
],
[
'name' => 'dashboard_toc',
'label' => __( 'Enable Dashboard Table of Contents Widget', 'admin-help-docs' ),
'desc' => __( 'Adds a dashboard widget with a table of contents for the docs on the Main Documentation Page.', 'admin-help-docs' ),
'type' => 'checkbox',
'sanitize' => 'sanitize_checkbox',
'box' => 'interface',
'default' => false,
],
[
'name' => 'gutenberg_editor',
'label' => __( 'Use Gutenberg Editor', 'admin-help-docs' ),
'desc' => __( 'Adds support for the Gutenberg editor for the documentation. Default is the classic editor.', 'admin-help-docs' ),
'type' => 'checkbox',
'sanitize' => 'sanitize_checkbox',
'box' => 'interface',
'default' => false,
],
// Content & Output
[
'name' => 'admin_bar_include_content',
'label' => __( 'Include Doc Content in Admin Bar', 'admin-help-docs' ),
'desc' => __( 'Includes a snippet of the document content in the admin bar.', 'admin-help-docs' ),
'type' => 'checkbox',
'sanitize' => 'sanitize_checkbox',
'box' => 'content_output',
'default' => false,
],
[
'name' => 'default_doc',
'label' => __( 'Default Document on Main Docs Page', 'admin-help-docs' ),
'type' => 'select',
'choices' => Helpers::get_main_helpdoc_options(),
'sanitize' => 'sanitize_text_field',
'box' => 'content_output',
],
[
'name' => 'hide_doc_meta',
'label' => __( 'Hide Document Meta on Main Docs Page', 'admin-help-docs' ),
'desc' => __( 'Includes created and last modified dates and authors.', 'admin-help-docs' ),
'type' => 'checkbox',
'sanitize' => 'sanitize_checkbox',
'box' => 'content_output',
'default' => false,
],
[
'name' => 'auto_htoc',
'label' => __( 'Auto-Generate Table of Contents on Main Docs Page', 'admin-help-docs' ),
'desc' => __( 'Automatically generate a table of contents from headings (H2–H6) at the top of each documentation page.', 'admin-help-docs' ),
'type' => 'checkbox',
'sanitize' => 'sanitize_checkbox',
'box' => 'content_output',
'default' => false,
],
[
'name' => 'curly_quotes',
'label' => __( 'Disable Curly Quotes on Main Docs Page', 'admin-help-docs' ),
'desc' => __( 'WP automatically converts straight quotes (") to curly quotes (”), which makes sharing code difficult.', 'admin-help-docs' ),
'type' => 'checkbox',
'sanitize' => 'sanitize_checkbox',
'box' => 'content_output',
'default' => false,
],
[
'name' => 'enqueue_frontend_styles',
'label' => __( 'Use Frontend Stylesheets on Main Docs Page', 'admin-help-docs' ),
'desc' => __( 'Adds support for your frontend styles in the backend by enqueueing them while on the Main Docs Page.', 'admin-help-docs' ),
'type' => 'checkbox',
'sanitize' => 'sanitize_checkbox',
'box' => 'content_output',
'default' => false,
],
[
'name' => 'main_docs_css',
'label' => __( 'Main Docs Page CSS', 'admin-help-docs' ),
'desc' => __( 'Add CSS here to style the Main Documentation Page specifically. You must use CSS selectors.', 'admin-help-docs' ),
'type' => 'textarea',
'sanitize' => 'sanitize_custom_css',
'box' => 'content_output',
'default' => '',
],
[
'name' => 'include_logo_on_docs',
'label' => __( 'Include Logo on Help Docs', 'admin-help-docs' ),
'desc' => __( 'Includes the site logo on individual help docs that are not on the Main Docs Page.', 'admin-help-docs' ),
'type' => 'checkbox',
'sanitize' => 'sanitize_checkbox',
'box' => 'content_output',
'default' => true,
],
[
'name' => 'top_location_type',
'label' => __( 'Top Location Placement', 'admin-help-docs' ),
'type' => 'select',
'choices' => $top_placements,
'sanitize' => 'sanitize_key',
'box' => 'content_output',
'default' => 'admin_notices',
],
[
'name' => 'footer_left',
'label' => __( 'Left Footer Text', 'admin-help-docs' ),
'desc' => __( 'Supports HTML. Default: "Thank you for creating with WordPress."', 'admin-help-docs' ),
'type' => 'textarea',
'sanitize' => 'wp_kses_post',
'box' => 'content_output',
'default' => '',
],
[
'name' => 'footer_right',
'label' => __( 'Right Footer Text', 'admin-help-docs' ),
'desc' => __( 'Use {version} to display the current WordPress version', 'admin-help-docs' ),
'type' => 'textarea',
'sanitize' => 'wp_kses_post',
'box' => 'content_output',
'default' => 'Version {version}',
],
// Access & Permissions
[
'name' => 'api',
'label' => __( 'Allow Public by Default', 'admin-help-docs' ),
'type' => 'checkbox',
'sanitize' => 'sanitize_checkbox',
'box' => 'access_control',
'default' => false,
],
[
'name' => 'api_key',
'label' => __( 'Public Access API Key (Optional)', 'admin-help-docs' ),
'desc' => __( 'If you enable "Allow Public" above or on individual docs, you can optionally require an API key for access. This adds a layer of security by ensuring that only users with the key can import your documentation. To use, generate a key here and enter it into the import on your other site where you are importing the docs. Leave empty to allow public access without a key.', 'admin-help-docs' ),
'type' => 'api_key',
'sanitize' => 'sanitize_text_field',
'box' => 'access_control',
'default' => false,
],
[
'name' => 'user_view_type',
'label' => __( 'Requirement Type to View Docs', 'admin-help-docs' ),
'type' => 'select',
'choices' => [
'capability' => __( 'Capability', 'admin-help-docs' ),
'role' => __( 'Role', 'admin-help-docs' ),
],
'sanitize' => 'sanitize_text_field',
'box' => 'access_control',
'default' => $view_default,
'has_condition' => true,
],
[
'name' => 'user_view_cap',
'label' => __( 'Default Capability Required to View Docs', 'admin-help-docs' ) . ' — View a list of capabilities. ',
'desc' => __( 'Use manage_options for admins only. You can also override this setting on a per-document basis.', 'admin-help-docs' ),
'type' => 'text',
'sanitize' => 'sanitize_text_field',
'box' => 'access_control',
'default' => 'manage_options',
'condition' => [ 'user_view_type' => 'capability' ],
],
[
'name' => 'view_roles',
'label' => __( 'Additional Default Roles Required to View Docs', 'admin-help-docs' ),
'desc' => __( 'Admins can view all docs regardless of this setting. You can also override this setting on a per-document basis.', 'admin-help-docs' ),
'type' => 'checkboxes',
'choices' => Helpers::get_role_options(),
'sanitize' => 'sanitize_checkboxes',
'box' => 'access_control',
'condition' => [ 'user_view_type' => 'role' ],
],
[
'name' => 'user_edit_type',
'label' => __( 'Requirement Type to Edit Docs', 'admin-help-docs' ),
'type' => 'select',
'choices' => [
'capability' => __( 'Capability', 'admin-help-docs' ),
'role' => __( 'Role', 'admin-help-docs' ),
],
'sanitize' => 'sanitize_text_field',
'box' => 'access_control',
'default' => 'role',
'has_condition' => true,
],
[
'name' => 'user_edit_cap',
'label' => __( 'Capability Required to Edit Docs', 'admin-help-docs' ) . ' — View a list of capabilities. ',
'desc' => __( 'Use manage_options for admins only.', 'admin-help-docs' ),
'type' => 'text',
'sanitize' => 'sanitize_text_field',
'box' => 'access_control',
'default' => 'manage_options',
'condition' => [ 'user_edit_type' => 'capability' ],
],
[
'name' => 'edit_roles',
'label' => __( 'Additional Roles Required to Edit Docs', 'admin-help-docs' ),
'desc' => __( 'Admins can edit all docs regardless of this setting.', 'admin-help-docs' ),
'type' => 'checkboxes',
'choices' => Helpers::get_role_options(),
'sanitize' => 'sanitize_checkboxes',
'box' => 'access_control',
'condition' => [ 'user_edit_type' => 'role' ],
],
// Advanced
[
'name' => 'remove_on_uninstall',
'label' => __( 'Remove All Plugin Data on Uninstall', 'admin-help-docs' ),
'desc' => __( 'Deletes all plugin settings and documentation permanently when the plugin is deleted.', 'admin-help-docs' ),
'type' => 'checkbox',
'sanitize' => 'sanitize_checkbox',
'box' => 'advanced',
'default' => false,
],
[
'name' => 'flush_cache',
'label' => __( 'System Cache Management', 'admin-help-docs' ),
'type' => 'html',
'box' => 'advanced',
'content' => '',
],
[
'name' => 'upload_download_colors',
'label' => __( 'Upload/Download Colors', 'admin-help-docs' ),
'desc' => __( 'Export your current color settings as a JSON file for backup or transfer to another site. You can also import color settings from a JSON file exported from this plugin. Note: Importing settings will overwrite your current color settings.', 'admin-help-docs' ),
'type' => 'html',
'box' => 'advanced',
'content' => ' ',
],
[
'name' => 'upload_download_settings',
'label' => __( 'Upload/Download Settings', 'admin-help-docs' ),
'desc' => __( 'Export your current settings as a JSON file for backup or transfer to another site. You can also import settings from a JSON file exported from this plugin. Note: Importing settings will overwrite your current settings.', 'admin-help-docs' ),
'type' => 'html',
'box' => 'advanced',
'content' => ' ',
],
[
'name' => 'reset_settings',
'label' => __( 'Reset Settings', 'admin-help-docs' ),
'desc' => __( 'This will not delete any documentation, but it will reset all settings to their defaults.', 'admin-help-docs' ),
'type' => 'html',
'box' => 'advanced',
'content' => ' ',
],
];
// Colors
$color_fields = [];
$colors = Colors::defaults();
foreach ( $colors as $key => $color ) {
if ( strpos( $key, 'subheader' ) !== false ) {
continue;
}
$color_fields[] = [
'name' => 'color_' . $key,
'label' => $color[ 'label' ],
'type' => 'color',
'sanitize' => 'sanitize_text_field',
'box' => 'interface',
'default' => $color[ 'color' ],
];
}
$themes_index = false;
foreach ( $fields as $index => $field ) {
if ( isset( $field[ 'name' ] ) && 'themes' === $field[ 'name' ] ) {
$themes_index = $index;
break;
}
}
if ( false !== $themes_index ) {
array_splice( $fields, $themes_index + 1, 0, $color_fields );
} else {
$fields = array_merge( $fields, $color_fields );
}
// Only get the name, type and default for each field
if ( $defaults_only ) {
foreach ( $fields as $index => $field ) {
$fields[ $index ] = [
'name' => $field[ 'name' ],
'type' => $field[ 'type' ],
'default' => $field[ 'default' ] ?? null,
];
}
}
return apply_filters( 'helpdocs_settings_fields', $fields );
} // End setting_fields()
/**
* Returns available placements for top docs.
*
* @return array
*/
public static function top_placements() : array {
return [
'admin_notices' => __( 'Just Above Page Title', 'admin-help-docs' ),
'in_admin_header' => __( 'Very Top of Page (Above All Content)', 'admin-help-docs' ),
];
} // End top_placements()
/**
* The single instance of the class
*
* @var self|null
*/
private static ?Settings $instance = null;
/**
* Get the singleton instance
*
* @return self
*/
public static function instance() : self {
return self::$instance ??= new self();
} // End instance()
/**
* Constructor
*/
private function __construct() {
add_action( 'helpdocs_subheader_left', [ $this, 'render_save_reminder' ] );
add_action( 'wp_ajax_helpdocs_save_settings', [ $this, 'ajax_save_settings' ] );
add_action( 'wp_ajax_helpdocs_flush_cache', [ $this, 'ajax_flush_cache' ] );
} // End __construct()
/**
* Render a reminder to save settings after changes are made
*
* @param string $current_tab The current active tab
*/
public function render_save_reminder( $current_tab ) {
if ( $current_tab === 'settings' ) {
echo '' . esc_html__( 'Remember to click "Save" after making changes to your settings.', 'admin-help-docs' ) . '';
}
} // End render_save_reminder()
/**
* Render the tab
*/
public function render_tab() {
$fields = $this->setting_fields();
$boxes = [];
$box_labels = $this->setting_boxes();
// Group fields by box
foreach ( $fields as $field ) {
$boxes[ $field[ 'box' ] ][] = $field;
}
echo '';
foreach ( $boxes as $box_id => $fields ) {
echo '
';
echo '';
echo '
';
$in_color_group = false;
foreach ( $fields as $index => $field ) {
$is_color = ( $field[ 'type' ] === 'color' );
$render_fn = "render_field_{$field[ 'type' ]}";
if ( $is_color && ! $in_color_group ) {
echo '
';
$in_color_group = true;
}
if ( ! $is_color && $in_color_group ) {
echo '
';
$in_color_group = false;
}
if ( method_exists( $this, $render_fn ) ) {
$this->{$render_fn}( $field );
}
$is_last = ( $index === array_key_last( $fields ) );
if ( $is_last && $in_color_group ) {
echo '
';
$in_color_group = false;
}
}
echo '
data-condition-field=""
data-condition-value=""
>
render_field_label( $field, $field[ 'name' ] ); ?>
placeholder="">
get_field_value( $field[ 'name' ] );
$value = $this->sanitize_field( $field, $value );
$conditional_class = '';
$data_condition_field = '';
$data_condition_value = '';
if ( ! empty( $field[ 'condition' ] ) ) {
$condition_field = key( $field[ 'condition' ] );
$expected_value = current( $field[ 'condition' ] );
$target_value = $this->get_field_value( $condition_field );
if ( $target_value != $expected_value ) {
$conditional_class = ' condition-hide';
}
$data_condition_field = $condition_field;
$data_condition_value = $expected_value;
}
$required = ! empty( $field[ 'required' ] ) ? ' required' : '';
$field_id = str_starts_with( $field[ 'name' ], 'footer' ) ? 'helpdocs_' . $field[ 'name' ] : $field[ 'name' ];
?>
data-condition-field=""
data-condition-value=""
>
render_field_label( $field, $field[ 'name' ] ); ?>
sanitize_field( $field, $value );
?>
sanitize_field( $field, $value );
// Strip dashicons
$value = str_replace( 'dashicons-', '', $value );
$has_condition = isset( $field[ 'has_condition' ] ) && $field[ 'has_condition' ];
$conditional_class = $has_condition ? ' has-condition' : '';
$required = ! empty( $field[ 'required' ] ) ? ' required' : '';
?>
render_field_label( $field, $field[ 'name' ] ); ?>
sanitize_field( $field, $value );
$has_condition = isset( $field[ 'has_condition' ] ) && $field[ 'has_condition' ];
$conditional_class = $has_condition ? ' has-condition' : '';
$required = ! empty( $field[ 'required' ] ) ? ' required' : '';
?>
get_field_value( $field[ 'name' ] );
$values = (array) $this->sanitize_field( $field, $values );
$conditional_class = '';
$data_condition_field = '';
$data_condition_value = '';
if ( ! empty( $field[ 'condition' ] ) ) {
$condition_field = key( $field[ 'condition' ] );
$expected_value = current( $field[ 'condition' ] );
$target_value = $this->get_field_value( $condition_field );
if ( $target_value != $expected_value ) {
$conditional_class = ' condition-hide';
}
$data_condition_field = $condition_field;
$data_condition_value = $expected_value;
}
?>
get_field_value( $condition_field );
if ( $target_value != $expected_value ) {
$conditional_class = ' condition-hide';
}
$data_condition_field = $condition_field;
$data_condition_value = $expected_value;
}
// Allow file types to be filterable
$default_types = '.jpg,.jpeg,.png,.pdf,.zip';
$accepted_types = apply_filters( 'helpdocs_support_file_types', $default_types, $field );
$required = ! empty( $field[ 'required' ] ) ? ' required' : '';
?>
data-condition-field=""
data-condition-value=""
>
render_field_label( $field, $field[ 'name' ] ); ?>
multiple>
$max_total_size ) {
wp_send_json_error( sprintf( __( 'The total size of attachments exceeds %dMB.', 'admin-help-docs' ), $max_total_mb ) );
}
// Second Pass: Process uploads
foreach ( $files[ 'name' ] as $key => $value ) {
if ( $files[ 'name' ][ $key ] ) {
$file = [
'name' => $files[ 'name' ][ $key ],
'type' => $files[ 'type' ][ $key ],
'tmp_name' => $files[ 'tmp_name' ][ $key ],
'error' => $files[ 'error' ][ $key ],
'size' => $files[ 'size' ][ $key ],
];
require_once( ABSPATH . 'wp-admin/includes/file.php' );
$upload_overrides = [ 'test_form' => false ];
$movefile = wp_handle_upload( $file, $upload_overrides );
if ( $movefile && ! isset( $movefile[ 'error' ] ) ) {
$attachments[] = $movefile[ 'file' ];
}
}
}
}
return $attachments;
} // End sanitize_files()
/**
* Render an API Key field with Generate, Copy, and Clear actions
* * @param array $field The field definition array
*/
public function render_field_api_key( $field ) {
$value = $this->get_field_value( $field[ 'name' ] );
if ( ( is_null( $value ) || $value === '' ) && isset( $field[ 'default' ] ) ) {
$value = $field[ 'default' ];
}
$value = $this->sanitize_field( $field, $value );
$conditional_class = '';
$data_condition_field = '';
$data_condition_value = '';
if ( ! empty( $field[ 'condition' ] ) ) {
$condition_field = key( $field[ 'condition' ] );
$expected_value = current( $field[ 'condition' ] );
$target_value = $this->get_field_value( $condition_field );
if ( $target_value != $expected_value ) {
$conditional_class = ' condition-hide';
}
$data_condition_field = $condition_field;
$data_condition_value = $expected_value;
}
?>
data-condition-field=""
data-condition-value=""
>
render_field_label( $field, $field[ 'name' ] ); ?>
' . esc_html__( 'No API Key Generated', 'admin-help-docs' ) . ''; ?>
true,
'id' => true,
'class' => true,
];
$allowed_html[ 'input' ] = [
'type' => true,
'id' => true,
'name' => true,
'accept' => true,
'style' => true,
'value' => true,
'class' => true,
];
$allowed_html[ 'label' ][ 'for' ] = true;
echo wp_kses( ( $field[ 'content' ] ?? '' ), $allowed_html );
?>
sanitize_field( $field, $raw_value );
}
continue;
}
if ( isset( $_POST[ 'settings' ][ $post_key ] ) ) {
// Sanitize below based on field type, but first get the raw value for checkboxes
$raw_value = wp_unslash( $_POST[ 'settings' ][ $post_key ] ); // phpcs:ignore
} else {
// If it's a checkbox group and nothing is checked, default to empty array
if ( $field[ 'type' ] === 'checkboxes' ) {
$raw_value = [];
} elseif ( $field[ 'type' ] === 'checkbox' ) {
$raw_value = 0;
} else {
continue;
}
}
// Determine type and sanitize accordingly
if ( $field[ 'type' ] === 'checkbox' ) {
$value = $this->sanitize_checkbox( $raw_value );
} elseif ( $field[ 'type' ] === 'checkboxes' ) {
$value = $this->sanitize_checkboxes( (array) $raw_value );
} elseif ( $field[ 'sanitize' ] === 'sanitize_custom_css' ) {
$value = $this->sanitize_custom_css( $raw_value );
} else {
$value = $this->sanitize_field( $field, $raw_value );
// If text field is empty, fall back to default
if ( $field[ 'type' ] === 'text' && $value === '' && isset( $field[ 'default' ] ) ) {
$value = $field[ 'default' ];
}
}
$updated = update_option( $post_key, $value );
if ( $updated === false && get_option( $post_key ) != $value ) {
$errors[] = $name;
}
}
// Before saving all colors, update the CSS variable storage if needed
Colors::convert_color_storage();
if ( ! empty( $colors_to_save ) ) {
$updated_colors = update_option( 'helpdocs_colors', $colors_to_save );
if ( $updated_colors === false && get_option( 'helpdocs_colors' ) !== $colors_to_save ) {
$errors[] = 'colors';
}
}
// Flush the cache so changes show immediately
Helpers::flush_permissions_cache();
if ( empty( $errors ) ) {
wp_send_json_success();
} else {
wp_send_json_error( 'Failed to save: ' . implode( ', ', $errors ) );
}
} // End ajax_save_settings()
/**
* AJAX handler to flush system cache
*/
public function ajax_flush_cache() {
check_ajax_referer( 'helpdocs_settings_nonce', 'nonce' );
if ( ! Helpers::user_can_edit() ) {
wp_send_json_error( __( 'You do not have permission to perform this action.', 'admin-help-docs' ) );
}
Helpers::flush_location_cache();
wp_send_json_success( __( 'Cache cleared successfully.', 'admin-help-docs' ) );
} // End ajax_flush_cache()
/**
* Prevent cloning and unserializing
*/
public function __clone() {}
public function __wakeup() {}
}
Settings::instance();