* @link https://tareq.co Tareq Hasan */ if (!class_exists('WPB_FP_WeDevs_Settings_API')): class WPB_FP_WeDevs_Settings_API { /** * settings sections array * * @var array */ protected $settings_sections = array(); /** * Settings fields array * * @var array */ protected $settings_fields = array(); public function __construct() { add_action('admin_enqueue_scripts', array($this, 'admin_enqueue_scripts')); } /** * Enqueue scripts and styles */ function admin_enqueue_scripts() { wp_enqueue_style('wp-color-picker'); wp_enqueue_media(); wp_enqueue_script('wp-color-picker'); wp_enqueue_script('jquery'); } /** * Set settings sections * * @param array $sections setting sections array */ function set_sections($sections) { $this->settings_sections = $sections; return $this; } /** * Add a single section * * @param array $section */ function add_section($section) { $this->settings_sections[] = $section; return $this; } /** * Set settings fields * * @param array $fields settings fields array */ function set_fields($fields) { $this->settings_fields = $fields; return $this; } function add_field($section, $field) { $defaults = array( 'name' => '', 'label' => '', 'desc' => '', 'type' => 'text' ); $arg = wp_parse_args($field, $defaults); $this->settings_fields[$section][] = $arg; return $this; } /** * Initialize and registers the settings sections and fields to WordPress * * Usually this should be called at `admin_init` hook. */ function admin_init() { // Register settings sections foreach ($this->settings_sections as $section) { if (false == get_option($section['id'])) { add_option($section['id']); } if (isset($section['desc']) && !empty($section['desc'])) { $section['desc'] = '
' . wp_kses_post($section['desc']) . '
'; $callback = function () use ($section) { echo wp_kses_post($section['desc']); }; } else if (isset($section['callback'])) { $callback = $section['callback']; } else { $callback = null; } add_settings_section( $section['id'], $section['title'], $callback, $section['id'] ); } // Register settings fields foreach ($this->settings_fields as $section => $field) { foreach ($field as $option) { $name = $option['name']; $type = isset($option['type']) ? $option['type'] : 'text'; $label = isset($option['label']) ? $option['label'] : ''; $callback = isset($option['callback']) ? $option['callback'] : array($this, 'callback_' . $type); $args = array( 'id' => $name, 'class' => isset($option['class']) ? $option['class'] : $name, 'label_for' => "{$section}[{$name}]", 'desc' => isset($option['desc']) ? $option['desc'] : '', 'name' => $label, 'section' => $section, 'size' => isset($option['size']) ? $option['size'] : null, 'options' => isset($option['options']) ? $option['options'] : '', 'std' => isset($option['default']) ? $option['default'] : '', 'sanitize_callback' => isset($option['sanitize_callback']) ? $option['sanitize_callback'] : 'sanitize_text_field', 'type' => $type, 'placeholder' => isset($option['placeholder']) ? $option['placeholder'] : '', 'min' => isset($option['min']) ? $option['min'] : '', 'max' => isset($option['max']) ? $option['max'] : '', 'step' => isset($option['step']) ? $option['step'] : '', ); add_settings_field( "{$section}[{$name}]", $label, $callback, $section, $section, $args ); } } // Creates our settings in the options table foreach ($this->settings_sections as $section) { register_setting( $section['id'], $section['id'], array($this, 'sanitize_options') ); } } /** * Get field description for display * * @param array $args settings field args */ public function get_field_description($args) { if (! empty($args['desc'])) { $desc = sprintf('

%s

', wp_kses_post($args['desc'])); } else { $desc = ''; } return $desc; } /** * Displays a text field for a settings field * * @param array $args settings field args */ function callback_text($args) { $value = esc_attr($this->get_option($args['id'], $args['section'], $args['std'])); $size = isset($args['size']) && !is_null($args['size']) ? $args['size'] : 'regular'; $type = isset($args['type']) ? $args['type'] : 'text'; $placeholder = empty($args['placeholder']) ? '' : ' placeholder="' . esc_attr($args['placeholder']) . '"'; $html = sprintf( '', esc_attr($type), esc_attr($size), esc_attr($args['section']), esc_attr($args['id']), $value, $placeholder ); $html .= $this->get_field_description($args); echo $html; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped } /** * Displays a url field for a settings field * * @param array $args settings field args */ function callback_url($args) { $this->callback_text($args); } /** * Displays a number field for a settings field * * @param array $args settings field args */ function callback_number($args) { $value = esc_attr($this->get_option($args['id'], $args['section'], $args['std'])); $size = isset($args['size']) && !is_null($args['size']) ? $args['size'] : 'regular'; $type = isset($args['type']) ? $args['type'] : 'number'; $placeholder = empty($args['placeholder']) ? '' : ' placeholder="' . esc_attr($args['placeholder']) . '"'; $min = ($args['min'] == '') ? '' : ' min="' . esc_attr($args['min']) . '"'; $max = ($args['max'] == '') ? '' : ' max="' . esc_attr($args['max']) . '"'; $step = ($args['step'] == '') ? '' : ' step="' . esc_attr($args['step']) . '"'; $html = sprintf( '', esc_attr($type), esc_attr($size), esc_attr($args['section']), esc_attr($args['id']), $value, $placeholder, $min, $max, $step ); $html .= $this->get_field_description($args); echo $html; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped } /** * Displays a checkbox for a settings field * * @param array $args settings field args */ function callback_checkbox($args) { $value = esc_attr($this->get_option($args['id'], $args['section'], $args['std'])); $html = '
'; $html .= sprintf('', wp_kses_post($args['desc'])); $html .= '
'; echo $html; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped } /** * Displays a multicheckbox for a settings field * * @param array $args settings field args */ function callback_multicheck($args) { $value = $this->get_option($args['id'], $args['section'], $args['std']); $html = '
'; $html .= sprintf( '', esc_attr($args['section']), esc_attr($args['id']) ); foreach ($args['options'] as $key => $label) { $checked = isset($value[$key]) ? $value[$key] : '0'; $html .= sprintf( '
', esc_html($label)); } $html .= $this->get_field_description($args); $html .= '
'; echo $html; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped } /** * Displays a radio button for a settings field * * @param array $args settings field args */ function callback_radio($args) { $value = $this->get_option($args['id'], $args['section'], $args['std']); $html = '
'; foreach ($args['options'] as $key => $label) { $html .= sprintf( '
', esc_html($label)); } $html .= $this->get_field_description($args); $html .= '
'; echo $html; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped } /** * Displays a selectbox for a settings field * * @param array $args settings field args */ function callback_select($args) { $value = esc_attr($this->get_option($args['id'], $args['section'], $args['std'])); $size = isset($args['size']) && !is_null($args['size']) ? $args['size'] : 'regular'; $html = sprintf( ''); $html .= $this->get_field_description($args); echo $html; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped } /** * Displays a textarea for a settings field * * @param array $args settings field args */ function callback_textarea($args) { $value = esc_textarea($this->get_option($args['id'], $args['section'], $args['std'])); $size = isset($args['size']) && !is_null($args['size']) ? $args['size'] : 'regular'; $placeholder = empty($args['placeholder']) ? '' : ' placeholder="' . esc_attr($args['placeholder']) . '"'; $html = sprintf( '', esc_attr($size), esc_attr($args['section']), esc_attr($args['id']), $placeholder, $value ); $html .= $this->get_field_description($args); echo $html; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped } /** * Displays the html for a settings field * * @param array $args settings field args * @return string */ function callback_html($args) { echo $this->get_field_description($args); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped } /** * Displays a rich text textarea for a settings field * * @param array $args settings field args */ function callback_wysiwyg($args) { $value = $this->get_option($args['id'], $args['section'], $args['std']); $size = isset($args['size']) && !is_null($args['size']) ? $args['size'] : '500px'; echo '
'; $editor_settings = array( 'teeny' => true, 'textarea_name' => $args['section'] . '[' . $args['id'] . ']', 'textarea_rows' => 10 ); if (isset($args['options']) && is_array($args['options'])) { $editor_settings = array_merge($editor_settings, $args['options']); } wp_editor($value, $args['section'] . '-' . $args['id'], $editor_settings); echo '
'; echo $this->get_field_description($args); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped } /** * Displays a file upload field for a settings field * * @param array $args settings field args */ function callback_file($args) { $value = esc_attr($this->get_option($args['id'], $args['section'], $args['std'])); $size = isset($args['size']) && !is_null($args['size']) ? $args['size'] : 'regular'; $id = $args['section'] . '[' . $args['id'] . ']'; $label = isset($args['options']['button_label']) ? $args['options']['button_label'] : __('Choose File', 'advance-portfolio-grid'); $html = sprintf( '', esc_attr($size), esc_attr($args['section']), esc_attr($args['id']), $value ); $html .= ''; $html .= $this->get_field_description($args); echo $html; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped } /** * Displays a password field for a settings field * * @param array $args settings field args */ function callback_password($args) { $value = esc_attr($this->get_option($args['id'], $args['section'], $args['std'])); $size = isset($args['size']) && !is_null($args['size']) ? $args['size'] : 'regular'; $html = sprintf( '', esc_attr($size), esc_attr($args['section']), esc_attr($args['id']), $value ); $html .= $this->get_field_description($args); echo $html; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped } /** * Displays a color picker field for a settings field * * @param array $args settings field args */ function callback_color($args) { $value = esc_attr($this->get_option($args['id'], $args['section'], $args['std'])); $size = isset($args['size']) && !is_null($args['size']) ? $args['size'] : 'regular'; $html = sprintf( '', esc_attr($size), esc_attr($args['section']), esc_attr($args['id']), $value, esc_attr($args['std']) ); $html .= $this->get_field_description($args); echo $html; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped } /** * Displays a select box for creating the pages select box * * @param array $args settings field args */ function callback_pages($args) { $dropdown_args = array( 'selected' => esc_attr($this->get_option($args['id'], $args['section'], $args['std'])), 'name' => $args['section'] . '[' . $args['id'] . ']', 'id' => $args['section'] . '[' . $args['id'] . ']', 'echo' => 0 ); $html = wp_dropdown_pages($dropdown_args); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped echo $html; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped } /** * Sanitize callback for Settings API * * @return mixed */ function sanitize_options($options) { if (!$options) { return $options; } foreach ($options as $option_slug => $option_value) { $sanitize_callback = $this->get_sanitize_callback($option_slug); // If callback is set, call it if ($sanitize_callback) { $options[$option_slug] = call_user_func($sanitize_callback, $option_value); continue; } } return $options; } /** * Get sanitization callback for given option slug * * @param string $slug option slug * * @return mixed string or bool false */ function get_sanitize_callback($slug = '') { if (empty($slug)) { return false; } // Iterate over registered fields and see if we can find proper callback foreach ($this->settings_fields as $section => $options) { foreach ($options as $option) { if ($option['name'] != $slug) { continue; } // Return the callback name return isset($option['sanitize_callback']) && is_callable($option['sanitize_callback']) ? $option['sanitize_callback'] : false; } } return false; } /** * Get the value of a settings field * * @param string $option settings field name * @param string $section the section name this field belongs to * @param string $default default text if it's not found * @return string */ function get_option($option, $section, $default = '') { $options = get_option($section); if (isset($options[$option])) { return $options[$option]; } return $default; } /** * Show navigations as tab * * Shows all the settings section labels as tab */ function show_navigation() { $html = ''; echo $html; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped } /** * Show the section settings forms * * This function displays every sections in a different form */ function show_forms() { ?>
settings_sections as $form) { ?>
script(); } /** * Tabbable JavaScript codes & Initiate Color Picker * * This code uses localstorage for displaying active tabs */ function script() { ?> _style_fix(); } function _style_fix() { global $wp_version; if (version_compare($wp_version, '3.8', '<=')): ?>