* @link http://tareq.weDevs.com Tareq's Planet
* @example src/settings-api.php How to use the class
*/
class SettingsAPI
{
/**
* settings sections array
*
* @var array
*/
private $settings_sections = array() ;
/**
* Settings fields array
*
* @var array
*/
private $settingsFields = array() ;
/**
* Singleton instance
*
* @var object
*/
private static $_instance ;
/*
* Name
*/
private $name ;
/*
* Prefix
*/
private $prefix ;
/*
* Constructor
*
* @param string $prefix - unique prefix for CSS classes and other names
*/
public function __construct( $name = '' )
{
add_action( 'admin_enqueue_scripts', array( $this, 'admin_enqueue_scripts' ) );
$this->name = sanitize_title( $name );
$this->prefix = sanitize_title( $name ) . '-';
}
/**
* Enqueue scripts and styles
*/
function admin_enqueue_scripts()
{
if ( Helpers::isSettingsPage() ) {
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->settingsFields = $fields;
return $this;
}
function add_field( $section, $field )
{
$defaults = array(
'name' => '',
'label' => '',
'desc' => '',
'type' => 'text',
);
$arg = wp_parse_args( $field, $defaults );
$this->settingsFields[$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.
*/
public function settings_init()
{
if ( false == get_option( $this->name ) ) {
add_option( $this->name );
}
//Register settings sections
foreach ( $this->settings_sections as $section ) {
if ( isset( $section['desc'] ) && !empty($section['desc']) ) {
$section['desc'] = '' . $section['desc'] . '
';
$callback = function () use( $section ) {
echo $section['desc'] ;
};
} elseif ( isset( $section['callback'] ) ) {
$callback = $section['callback'];
} else {
$callback = null;
}
add_settings_section(
$section['id'],
$section['title'],
$callback,
$section['id']
);
}
//Register settings fields
foreach ( $this->settingsFields as $section => $field ) {
foreach ( $field as $option ) {
$type = ( isset( $option['type'] ) ? $option['type'] : 'text' );
$args = array(
'id' => $option['name'],
'label_for' => $args['label_for'] = "{$this->name}[{$option['name']}]",
'desc' => ( isset( $option['desc'] ) ? $option['desc'] : '' ),
'name' => $option['label'],
'size' => ( isset( $option['size'] ) ? $option['size'] : null ),
'options' => ( isset( $option['options'] ) ? $option['options'] : '' ),
'std' => ( isset( $option['default'] ) ? $option['default'] : '' ),
'class' => ( isset( $option['class'] ) ? $option['class'] : '' ),
'sanitize_callback' => ( isset( $option['sanitize_callback'] ) ? $option['sanitize_callback'] : '' ),
'number_min' => ( isset( $option['number_min'] ) ? (int) $option['number_min'] : null ),
'number_max' => ( isset( $option['number_max'] ) ? (int) $option['number_max'] : null ),
'type' => $type,
'move_dest' => ( isset( $option['move_dest'] ) ? $option['move_dest'] : '' ),
'input_data' => ( isset( $option['input_data'] ) ? $option['input_data'] : '' ),
'disabled' => ( isset( $option['disabled'] ) ? $option['disabled'] : false ),
'textarea_rows' => ( isset( $option['textarea_rows'] ) ? $option['textarea_rows'] : 5 ),
);
add_settings_field(
"{$this->name}[" . $option['name'] . ']',
$option['label'],
array( $this, 'callback_' . $type ),
$section,
$section,
$args
);
}
}
// Creates our settings in the options table
foreach ( $this->settings_sections as $section ) {
register_setting( $section['id'], $this->name, 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']) ) {
$css_class = $this->prefix . 'description-field';
$desc = sprintf( '%s
', $css_class, $args['desc'] );
} else {
$desc = '';
}
return $desc;
}
/**
* Head
*/
function callback_head( $args )
{
echo '' ;
}
/**
* Displays a text field for a settings field
*
* @param array $args settings field args
*/
function callback_text( $args )
{
$value = apply_filters(
'dgwt/wcas/settings/option_value',
esc_attr( $this->get_option( $args['id'], $args['std'] ) ),
$args['std'],
$args
);
$size = ( isset( $args['size'] ) && !is_null( $args['size'] ) ? $args['size'] : 'regular' );
$type = ( isset( $args['type'] ) ? $args['type'] : 'text' );
$disabled = ( !empty($args['disabled']) ? 'disabled' : '' );
$numberMin = ( isset( $args['number_min'] ) ? ' min="' . $args['number_min'] . '"' : '' );
$numberMax = ( isset( $args['number_max'] ) ? ' min="' . $args['number_max'] . '"' : '' );
$html = '';
echo $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 = apply_filters(
'dgwt/wcas/settings/option_value',
esc_attr( $this->get_option( $args['id'], $args['std'] ) ),
$args['std'],
$args
);
$disabled = ( !empty($args['disabled']) ? 'disabled' : '' );
$moveDest = ( empty($args['move_dest']) ? '' : sprintf(
'data-move-dest="%1$s[%2$s]" class="%3$s"',
$this->name,
$args['move_dest'],
'js-dgwt-wcas-move-option'
) );
$html = '';
echo $html ;
}
/**
* Displays a multicheckbox a settings field
*
* @param array $args settings field args
*/
function callback_multicheck( $args )
{
$value = apply_filters(
'dgwt/wcas/settings/option_value',
$this->get_option( $args['id'], $args['std'] ),
$args['std'],
$args
);
$html = '';
echo $html ;
}
/**
* Displays a multicheckbox a settings field
*
* @param array $args settings field args
*/
function callback_radio( $args )
{
$value = apply_filters(
'dgwt/wcas/settings/option_value',
$this->get_option( $args['id'], $args['std'], false ),
$args['std'],
$args
);
$html = '';
echo $html ;
}
/**
* Displays a selectbox for a settings field
*
* @param array $args settings field args
*/
function callback_select( $args )
{
$value = apply_filters(
'dgwt/wcas/settings/option_value',
esc_attr( $this->get_option( $args['id'], $args['std'] ) ),
$args['std'],
$args
);
$size = ( isset( $args['size'] ) && !is_null( $args['size'] ) ? $args['size'] : 'regular' );
$html = sprintf(
'' );
$html .= $this->get_field_description( $args );
echo $html ;
}
/**
* Displays a selectize multiple select for a settings field
*
* @param array $args settings field args
*/
function callback_selectize( $args )
{
$value = apply_filters(
'dgwt/wcas/settings/option_value',
esc_attr( $this->get_option( $args['id'], $args['std'] ) ),
$args['std'],
$args
);
$options = ( !empty($args['options']) && is_array( $args['options'] ) ? $args['options'] : array() );
$nonce = wp_create_nonce( 'dgwt_wcas_get_custom_fields' );
$html = sprintf(
'',
$this->name,
$args['id'],
$value,
http_build_query( $options ),
$nonce
);
$html .= $this->get_field_description( $args );
echo $html ;
}
/**
* Displays a textarea for a settings field
*
* @param array $args settings field args
*/
function callback_textarea( $args )
{
$value = apply_filters(
'dgwt/wcas/settings/option_value',
esc_textarea( $this->get_option( $args['id'], $args['std'] ) ),
$args['std'],
$args
);
$size = ( isset( $args['size'] ) && !is_null( $args['size'] ) ? $args['size'] : 'regular' );
$rows = ( !empty($args['textarea_rows']) && is_numeric( $args['textarea_rows'] ) ? absint( $args['textarea_rows'] ) : 5 );
$html = sprintf(
'',
$size,
$this->name,
$args['id'],
$value,
$rows
);
$html .= $this->get_field_description( $args );
echo $html ;
}
/**
* Displays a textarea for a settings field
*
* @param array $args settings field args
*
* @return void
*/
function callback_html( $args )
{
if ( !empty($args['desc']) ) {
$css_class = $this->prefix . 'description-row';
$desc = sprintf( '%s
', $css_class, $args['desc'] );
} else {
$desc = '';
}
echo $desc ;
}
/**
* 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['std'] );
$size = ( isset( $args['size'] ) && !is_null( $args['size'] ) ? $args['size'] : '500px' );
echo '' ;
$editor_settings = array(
'teeny' => true,
'textarea_name' => $this->name . '[' . $args['id'] . ']',
'textarea_rows' => 10,
);
if ( isset( $args['options'] ) && is_array( $args['options'] ) ) {
$editor_settings = array_merge( $editor_settings, $args['options'] );
}
wp_editor( $value, $this->name . '-' . $args['id'], $editor_settings );
echo '
' ;
echo $this->get_field_description( $args ) ;
}
/**
* 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['std'] ) );
$size = ( isset( $args['size'] ) && !is_null( $args['size'] ) ? $args['size'] : 'regular' );
$id = $this->name . '[' . $args['id'] . ']';
$label = ( isset( $args['options']['button_label'] ) ? $args['options']['button_label'] : __( 'Choose File' ) );
$html = sprintf(
'',
$size,
$this->prefix,
$this->name,
$args['id'],
$value
);
$html .= '';
$html .= $this->get_field_description( $args );
echo $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['std'] ) );
$size = ( isset( $args['size'] ) && !is_null( $args['size'] ) ? $args['size'] : 'regular' );
$html = sprintf(
'',
$size,
$this->name,
$args['id'],
$value
);
$html .= $this->get_field_description( $args );
echo $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['std'] ) );
$size = ( isset( $args['size'] ) && !is_null( $args['size'] ) ? $args['size'] : 'regular' );
$html = sprintf(
'',
$size,
$this->name,
$args['id'],
$value,
$args['std']
);
$html .= $this->get_field_description( $args );
echo $html ;
}
/**
* Displays a color picker field for a settings field
*
* @param array $args settings field args
*/
function callback_desc( $args )
{
$html = '';
if ( isset( $args['desc'] ) && !empty($args['desc']) ) {
$html .= '';
$html .= $args['desc'];
$html .= '
';
}
echo $html ;
}
/**
* Displays a color picker field for a settings field
*
* @param array $args settings field args
*/
function callback_datepicker( $args )
{
$value = esc_attr( $this->get_option( $args['id'], $args['std'] ) );
$size = ( isset( $args['size'] ) && !is_null( $args['size'] ) ? $args['size'] : 'regular' );
$html = sprintf(
'',
$size,
$this->name,
$args['id'],
$value
);
$html .= $this->get_field_description( $args );
echo $html ;
}
/**
* Displays filters rules in settings
*
* @param array $args settings field args
*/
function callback_filters_rules_plug( $args )
{
ob_start();
?>
$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->settingsFields as $section => $options ) {
foreach ( $options as $option ) {
if ( $option['name'] != $slug ) {
continue;
}
// First check if sanitize_callback was added directly to the option
if ( !empty($option['sanitize_callback']) && is_callable( $option['sanitize_callback'] ) ) {
return $option['sanitize_callback'];
}
// Not added? Sanitize it based on a type
switch ( $option['type'] ) {
case 'checkbox':
$sanitize_callback = array( __CLASS__, 'sanitize_checkbox' );
break;
case 'number':
$sanitize_callback = 'intval';
break;
case 'text':
case 'textarea':
$sanitize_callback = 'wp_kses_post';
break;
case 'color':
$sanitize_callback = array( __CLASS__, 'sanitize_color' );
break;
case 'select':
$sanitize_callback = 'sanitize_key';
break;
case 'file':
$sanitize_callback = 'esc_url';
break;
default:
$sanitize_callback = 'wp_kses_post';
}
return ( !empty($sanitize_callback) && is_callable( $sanitize_callback ) ? $sanitize_callback : false );
}
}
return false;
}
/**
* Sanitize checkbox
*
* @param string $value
*
* @return string
*/
public static function sanitize_checkbox( $value )
{
return ( in_array( $value, array( 'on', 'off' ) ) ? $value : '' );
}
/**
* Sanitize color
*
* @param string $value
*
* @return string
*/
public static function sanitize_color( $value )
{
return ( preg_match( '/^#[a-f0-9]{6}$/i', $value ) ? $value : '' );
}
/**
* Sanitize text for "No results" field.
*
* @param string $value
*
* @return string
*/
public static function sanitize_no_results_field( $value )
{
return Helpers::ksesNoResults( $value );
}
/**
* Strip all tags
*
* @param string $value
*
* @return string
*/
public static function strip_all_tags( $value )
{
return wp_strip_all_tags( $value, true );
}
/**
* Sanitize natural numbers
*
* @param string $value
*
* @return int
*/
public static function sanitize_natural_numbers( $value )
{
$number = absint( $value );
return ( $number === 0 ? 1 : $number );
}
/**
* Get the value of a settings field
*
* @param string $option settings field name
* @param string $default default text if it's not found
* @param bool $not_empty allow empty value
*
* @return string
*/
function get_option( $option, $default = '', $allow_empty = true )
{
$options = get_option( $this->name );
$value = $default;
if ( isset( $options[$option] ) ) {
if ( $allow_empty ) {
$value = $options[$option];
} else {
if ( !empty($options[$option]) ) {
$value = $options[$option];
}
}
}
return apply_filters( 'dgwt/wcas/settings/load_value/key=' . $option, $value );
}
/**
* Show navigations as tab
*
* Shows all the settings section labels as tab
*/
function show_navigation()
{
$html = '';
echo $html ;
}
/**
* Show the section settings forms
*
* This function displays every sections in a different form
*/
function show_forms()
{
?>
script();
}
/**
* Tabbable JavaScript codes & Initiate Color Picker
*
* This code uses localstorage for displaying active tabs
*
* @return void
*/
public function script()
{
?>