* @link http://tareq.weDevs.com Tareq's Planet * @example src/settings-api.php How to use the class */ if ( !class_exists( 'WeDevs_Settings_API' ) ): class 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 fileds to WordPress * * Usually this should be called at `admin_init` hook. * * This function gets the initiated settings sections and fields. Then * registers them to WordPress and ready for use. */ 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'] = '
'.$section['desc'].'
'; $desc = str_replace('"', '\"', $subsection['desc']); $callback = function() use ($desc) { echo wp_kses( $desc, $this->get_allowed_html() ); }; } else if ( isset( $section['callback'] ) ) { $callback = $section['callback']; } else { $callback = null; } if( array_key_exists('children', $section) && !empty($section['children']) ) { foreach( $section['children'] as $subsection ) { if ( false == get_option( $subsection['id'] ) ) { add_option( $subsection['id'] ); } if ( isset($subsection['desc']) && !empty($subsection['desc']) ) { $subsection['desc'] = '
'.$subsection['desc'].'
'; $desc = str_replace('"', '\"', $subsection['desc']); $callback = function() use ($desc) { echo wp_kses( $desc, $this->get_allowed_html() ); }; } else if ( isset( $subsection['callback'] ) ) { $callback = $subsection['callback']; } else { $callback = null; } add_settings_section( $subsection['id'], $subsection['title'], $callback, $subsection['id'] ); } } add_settings_section( $section['id'], $section['title'], $callback, $section['id'] ); } //register settings fields foreach ( $this->settings_fields as $section => $field ) { foreach ( $field as $option ) { $type = isset( $option['type'] ) ? $option['type'] : 'text'; $args = array( 'id' => $option['name'], 'label_for' => $args['label_for'] = "{$section}[{$option['name']}]", 'desc' => isset( $option['desc'] ) ? $option['desc'] : '', 'name' => $option['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'] : '', 'type' => $type, 'rows' => isset( $option['rows'] ) ? $option['rows'] : null, 'cols' => isset( $option['cols'] ) ? $option['cols'] : null, 'css' => isset( $option['css'] ) ? $option['css'] : null, 'custom_html' => isset( $option['custom_html'] ) ? $option['custom_html'] : null, ); add_settings_field( $section . '[' . $option['name'] . ']', $option['label'], array( $this, 'callback_' . $type ), $section, $section, $args ); } } // creates our settings in the options table foreach ( $this->settings_sections as $section ) { if( array_key_exists('children', $section) && !empty($section['children']) ) { foreach($section['children'] as $subsection) { register_setting( $subsection['id'], $subsection['id'], array( $this, 'sanitize_options' ) ); } } 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

', $args['desc'] ); } else { $desc = ''; } return $desc; } /** * Displays a custom html for a settings field * * @param array $args settings field args */ function callback_custom_html( $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'; // $html = $args['custom_html']; // $html .= $this->get_field_description( $args ); call_user_func($args['custom_html']); } /** * 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'; $html = sprintf( '', $type, $size, $args['section'], $args['id'], $value ); $html .= $this->get_field_description( $args ); echo wp_kses( $html, $this->get_allowed_html() ); } /** * 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 ) { $this->callback_text( $args ); } /** * 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( '', $args['desc'] ); $html .= '
'; echo wp_kses( $html, $this->get_allowed_html() ); } /** * Displays a multicheckbox a settings field * * @param array $args settings field args */ function callback_multicheck( $args ) { $value = $this->get_option( $args['id'], $args['section'], $args['std'] ); $html = '
'; foreach ( $args['options'] as $key => $label ) { $checked = isset( $value[$key] ) ? $value[$key] : '0'; $html .= sprintf( '
', $label ); } $html .= $this->get_field_description( $args ); $html .= '
'; echo wp_kses( $html, $this->get_allowed_html() ); } /** * Displays a multicheckbox 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( '
', $label ); } $html .= $this->get_field_description( $args ); $html .= '
'; echo wp_kses( $html, $this->get_allowed_html() ); } /** * 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 wp_kses( $html, $this->get_allowed_html() ); } /** * Displays a selectbox for a settings field * * @param array $args settings field args */ function callback_selectm( $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 wp_kses( $html, $this->get_allowed_html() ); } /** * 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'; $rows = isset( $args['rows'] ) && !is_null( $args['rows'] ) ? $args['rows'] : '5'; $cols = isset( $args['cols'] ) && !is_null( $args['cols'] ) ? $args['cols'] : '55'; $css = isset( $args['css'] ) && !is_null( $args['css'] ) ? 'style="'.$args['css'].';"' : ''; $html = sprintf( '', $size, $args['section'], $args['id'], $value ); $html .= $this->get_field_description( $args ); echo wp_kses( $html, $this->get_allowed_html() ); } /** * Displays a textarea for a settings field * * @param array $args settings field args * @return string */ function callback_html( $args ) { echo wp_kses( $this->get_field_description( $args ), $this->get_allowed_html() ); } /** * 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 wp_kses( $this->get_field_description( $args ), $this->get_allowed_html() ); } /** * 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'; $html = sprintf( '', $size, $args['section'], $args['id'], $value ); $html .= ''; $html .= $this->get_field_description( $args ); echo wp_kses( $html, $this->get_allowed_html() ); } /** * 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( '', $size, $args['section'], $args['id'], $value ); $html .= $this->get_field_description( $args ); echo wp_kses( $html, $this->get_allowed_html() ); } /** * 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( '', $size, $args['section'], $args['id'], $value, $args['std'] ); $html .= $this->get_field_description( $args ); echo wp_kses( $html, $this->get_allowed_html() ); } /** * Sanitize callback for Settings API */ function sanitize_options( $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 = '

'; foreach ( $this->settings_sections as $tab ) { $html .= sprintf( '%2$s', $tab['id'], $tab['title'] ); } $html .= '

'; echo wp_kses( $html, $this->get_allowed_html() ); } /** * Show the section settings forms * * This function displays every sections in a different form */ function show_forms() { ?>
settings_sections as $form ) { ?>
script(); do_action('notifysms_load_javascripts'); } /** * Tabbable JavaScript codes & Initiate Color Picker * * This code uses localstorage for displaying active tabs */ function script() { ?> array(), 'label' => array( 'for' => array(), ), 'input' => array( 'type' => array(), 'class' => array(), 'id' => array(), 'name' => array(), 'value' => array(), 'checked' => array(), 'style' => array(), 'data-default-color' => array(), ), 'a' => array( 'href' => array(), 'title' => array(), 'id' => array(), 'class' => array(), 'target' => array(), ), 'b' => array(), 'div' => array( 'class' => array(), 'id' => array(), 'style' => array(), ), 'br' => array(), 'p' => array( 'class' => array(), 'style' => array(), ), 'button' => array( 'type' => array(), 'data-attr-type' => array(), 'id' => array(), 'class' => array(), 'data-attr-target' => array(), ), 'span' => array( 'class' => array(), 'style' => array(), 'id' => array(), ), 'strong' => array(), 'ul' => array( 'class' => array(), 'id' => array(), ), 'q' => array( 'cite' => true, ), 'dl' => array(), 'dt' => array(), 'em' => array(), 'h1' => array( 'class' => array(), ), 'h2' => array( 'class' => array(), ), 'h3' => array( 'class' => array(), ), 'h4' => array( 'class' => array(), ), 'h5' => array( 'class' => array(), ), 'h6' => array( 'class' => array(), ), 'i' => array(), 'img' => array( 'alt' => true, 'class' => true, 'height' => true, 'src' => true, 'width' => true, ), 'li' => array(), 'ol' => array( 'class' => array(), 'id' => array(), ), 'blockquote' => array( 'cite' => array(), ), 'cite' => array(), 'code' => array(), 'del' => array( 'datetime' => array(), ), 'dd' => array(), 'abbr' => array( 'title' => array(), ), 'select' => array( 'class' => array(), 'name' => array(), 'id' => array(), 'multiple' => array(), ), 'option' => array( 'value' => array(), 'selected' => array(), ), 'textarea' => array( 'rows' => array(), 'cols' => array(), 'class' => array(), 'style' => array(), 'id' => array(), 'name' => array(), ), 'textarea_name' => array(), 'textarea_rows' => array(), 'teeny' => array(), ); } } endif;