* @link http://tareq.weDevs.com Tareq's Planet
* @example settings-api.php How to use the class
*/
if ( !class_exists( 'UberMenu_Settings_API' ) ):
class UberMenu_Settings_API {
/**
* settings sections array
*
* @var array
*/
private $settings_sections = array();
/**
* Settings fields array
*
* @var array
*/
private $settings_fields = array();
private $settings_defaults = null;
/**
* Singleton instance
*
* @var object
*/
private static $_instance;
public function __construct() {
add_action( 'admin_enqueue_scripts', array( $this, 'admin_enqueue_scripts' ) );
}
/**
* Enqueue scripts and styles
*/
function admin_enqueue_scripts( $hook ) {
if( $hook == 'appearance_page_ubermenu-settings' ){
wp_enqueue_style( 'wp-color-picker' );
wp_enqueue_script('wp-color-picker');
wp_enqueue_script( 'jquery' );
wp_enqueue_media();
}
}
/**
* 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'].'
';
$callback = create_function('', 'echo "'.str_replace('"', '\"', $section['desc']).'";');
} else {
$callback = '__return_false';
}
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'],
'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'] : '',
);
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 ) {
register_setting( $section['id'], $section['id'], array( $this, 'sanitize_options' ) );
}
}
/**
* 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';
$html = sprintf( ' ', $size, $args['section'], $args['id'], $value );
$html .= sprintf( ' %s ', $args['desc'] );
echo $html;
}
/**
* 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 = sprintf( ' ', $args['section'], $args['id'] );
$html .= sprintf( ' ', $args['section'], $args['id'], $value, checked( $value, 'on', false ) );
$html .= sprintf( ' %3$s ', $args['section'], $args['id'], $args['desc'] );
echo $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'] );
$options = $args['options'];
if( !is_array( $options ) && function_exists( $options ) ){
$options = $options();
}
$html = '';
foreach ( $options as $key => $label ) {
$checked = isset( $value[$key] ) ? $value[$key] : '0';
$html .= sprintf( ' ', $args['section'], $args['id'], $key, checked( $checked, $key, false ) );
$html .= sprintf( ' %3$s ', $args['section'], $args['id'], $label, $key );
}
$html .= sprintf( ' %s', $args['desc'] );
$html .= '
';
echo $html;
}
/**
* Displays a radio 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( ' ', $args['section'], $args['id'], $key, checked( $value, $key, false ) );
$html .= sprintf( ' %3$s ', $args['section'], $args['id'], $label, $key );
}
$html .= sprintf( ' %s', $args['desc'] );
echo $html;
}
function callback_radio_advanced( $args ) {
$value = $this->get_option( $args['id'], $args['section'], $args['std'] );
$options = $args['options'];
if( !is_array( $options ) ){
if( function_exists( $options ) ){
$options = $options();
}
}
$html = '';
foreach ( $options as $group_id => $group_op ) {
foreach( $group_op as $key => $op_data ){
$label = $op_data['name'];
$html .= sprintf( ' ', $args['section'], $args['id'], $key, checked( $value, $key, false ) );
$html .= sprintf( ' %3$s ', $args['section'], $args['id'], $label, $key );
$html .= sprintf( ' %s ', $op_data['desc'] );
}
}
$html .= sprintf( ' %s', $args['desc'] );
echo $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';
$options = $args['options'];
if( !is_array( $options ) && function_exists( $options ) ){
$options = $options();
}
$html = sprintf( '', $size, $args['section'], $args['id'] );
foreach ( $options as $key => $label ) {
$html .= sprintf( '%s ', $key, selected( $value, $key, false ), $label );
}
$html .= sprintf( ' ' );
$html .= sprintf( ' %s ', $args['desc'] );
echo $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';
$html = sprintf( '', $size, $args['section'], $args['id'], $value );
$html .= sprintf( ' %s ', $args['desc'] );
echo $html;
}
/**
* Displays a custom html for a settings field
*
* @param array $args settings field args
*/
function callback_html( $args ) {
if( function_exists( $args['desc'] ) ){
echo $args['desc']();
}
else echo $args['desc'];
}
function callback_func_html( $args ) {
$func = $args['desc']['func'];
if( function_exists( $func ) ){
echo $func( $args['desc']['args'] );
}
}
function callback_header( $args ) {
echo $args['desc'];
}
/**
* Displays a rich text textarea for a settings field
*
* @param array $args settings field args
*/
function callback_wysiwyg( $args ) {
$value = wpautop( $this->get_option( $args['id'], $args['section'], $args['std'] ) );
$size = isset( $args['size'] ) && !is_null( $args['size'] ) ? $args['size'] : '500px';
echo '';
wp_editor( $value, $args['section'] . '[' . $args['id'] . ']', array( 'teeny' => true, 'textarea_rows' => 10 ) );
echo '
';
echo sprintf( ' %s ', $args['desc'] );
}
/**
* 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'] . ']';
$js_id = $args['section'] . '\\\\[' . $args['id'] . '\\\\]';
$html = sprintf( ' ', $size, $args['section'], $args['id'], $value );
$html .= '
';
$html .= sprintf( ' %s ', $args['desc'] );
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['section'], $args['std'] ) );
$size = isset( $args['size'] ) && !is_null( $args['size'] ) ? $args['size'] : 'regular';
$html = sprintf( ' ', $size, $args['section'], $args['id'], $value );
$html .= sprintf( ' %s ', $args['desc'] );
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['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 .= sprintf( ' %s ', $args['desc'] );
echo $html;
}
function callback_color_gradient( $args ) {
$value = esc_attr( $this->get_option( $args['id'], $args['section'], $args['std'] ) );
$size = isset( $args['size'] ) && !is_null( $args['size'] ) ? $args['size'] : 'regular';
$colors = explode( ',' , $value );
$c1 = isset( $colors[0] ) ? $colors[0] : '';
$c2 = isset( $colors[1] ) ? $colors[1] : '';
$html = sprintf( '', $size, $args['section'], $args['id'], $c1, $args['std'] );
$html .= sprintf( '', $size, $args['section'], $args['id'], $c2, $args['std'] );
$html .= sprintf( ' %s ', $args['desc'] );
$html .= sprintf( '', $size, $args['section'], $args['id'], $value, $args['std'] );
echo $html;
}
function callback_image( $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 = '';
$html.= '
';
if( $value ){
$src = wp_get_attachment_image_src( $value , 'medium' );
$html.= ' ';
}
$html.= ' ';
$html.= sprintf( '
', $size, $args['section'], $args['id'], $value );
$html.= sprintf( '
', $size, $args['section'], $args['id'] );
$html .= sprintf( '
%s ', $args['desc'] );
$html.= '
remove ';
$html.= '
';
echo $html;
}
/*
function callback_newfield( $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 .= sprintf( ' %s ', $args['desc'] );
echo $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;
}
// Treat everything that's not an array as a string
if ( !is_array( $option_value ) ) {
$options[ $option_slug ] = sanitize_text_field( $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 _UBERMENU()->get_default( $option , $section );
//return $default;
}
// function set_defaults(){
// $this->settings_defaults = array();
// foreach( $this->settings_fields as $section_id => $ops ){
// $this->settings_defaults[$section_id] = array();
// //$section = $this->settings_defaults[$section_id];
// foreach( $ops as $op ){
// $this->settings_defaults[$section_id][$op['name']] = isset( $op['default'] ) ? $op['default'] : '';
// }
// }
// //shiftp( $this->settings_defaults );
// }
// function get_default( $option , $section ){
// if( $this->settings_defaults == null ) $this->set_defaults();
// $default = '';
// echo '========== ';
// shiftp( $this->settings_defaults );
// //echo "[[$section|$option]] ";
// if( isset( $this->settings_defaults[$section] ) && isset( $this->settings_defaults[$section][$option] ) ){
// $default = $this->settings_defaults[$section][$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 $html;
}
/**
* Show the section settings forms
*
* This function displays every sections in a different form
*/
function show_forms() {
global $wp_settings_sections, $wp_settings_fields;
//up( $wp_settings_sections );
//up( $wp_settings_fields );
?>
script();
}
/* From wp-admin/includes/templates.php 'do_settings_sections()' */
function do_settings_sections( $page ) {
global $wp_settings_sections, $wp_settings_fields;
if ( ! isset( $wp_settings_sections[$page] ) )
return;
foreach ( (array) $wp_settings_sections[$page] as $section ) {
//if ( $section['title'] )
// echo "{$section['title']} \n";
if ( $section['callback'] )
call_user_func( $section['callback'], $section );
if ( ! isset( $wp_settings_fields ) || !isset( $wp_settings_fields[$page] ) || !isset( $wp_settings_fields[$page][$section['id']] ) )
continue;
echo '';
}
}
function do_settings_fields($page, $section) {
global $wp_settings_fields;
if ( ! isset( $wp_settings_fields[$page][$section] ) )
return;
$k = 0;
$fields = $this->settings_fields[$section];
foreach ( (array) $wp_settings_fields[$page][$section] as $field ) {
$class = '';
//$class.= 'uber-field uber-field-'.$this->settings_fields[$section][$k]['type'];
$class.= 'uber-field uber-field-'.$fields[$k]['type'];
//$group = isset( $this->settings_fields[$section][$k]['group'] ) ? $this->settings_fields[$section][$k]['group'] : 'groupless';
$group = isset( $fields[$k]['group'] ) ? $fields[$k]['group'] : 'groupless';
if( is_array( $group ) ){
foreach( $group as $g ){
$class.= ' uber-field-group-'.$g;
}
}
else{
$class.= ' uber-field-group-'.$group;
}
$class.= ' uber-field-'.$fields[$k]['name'];
$class.= '"';
echo '';
if ( !empty($field['args']['label_for']) )
echo '' . $field['title'] . ' ';
else
echo '' . $field['title'] . ' ';
echo '';
call_user_func($field['callback'], $field['args']);
echo ' ';
echo ' ';
$k++;
}
}
/**
* Tabbable JavaScript codes & Initiate Color Picker
*
* This code uses localstorage for displaying active tabs
*/
function script() {
?>