settings_sections = $sections;
return $this;
}
/**
* Add a single section
*
* @param array $section The section.
*/
public function add_section( $section ) {
$this->settings_sections[] = $section;
return $this;
}
/**
* Set settings fields
*
* @param array $fields settings fields array.
*/
public function set_fields( $fields ) {
$this->settings_fields = $fields;
return $this;
}
/**
* Add field in settings.
*
* @param array $section the section.
* @param array $field the field.
*/
public 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.
*
* This function gets the initiated settings sections and fields. Then
* registers them to WordPress and ready for use.
*/
public 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 = call_user_func( array( $this, 'get_description' ), $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->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'] : '',
'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
', $args['desc'] );
} else {
$desc = '';
}
return $desc;
}
/**
* Displays a text field for a settings field.
*
* @param array $args settings field args.
*/
public 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="' . $args['placeholder'] . '"';
$html = sprintf( ' ', $type, $size, $args['section'], $args['id'], $value, $placeholder );
$html .= $this->get_field_description( $args );
echo $html; // @codingStandardsIgnoreLine.
}
/**
* Displays a url field for a settings field.
*
* @param array $args settings field args.
*/
public function callback_url( $args ) {
$this->callback_text( $args );
}
/**
* Displays a number field for a settings field.
*
* @param array $args settings field args.
*/
public 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="' . $args['placeholder'] . '"';
$min = empty( $args['min'] ) ? '' : ' min="' . $args['min'] . '"';
$max = empty( $args['max'] ) ? '' : ' max="' . $args['max'] . '"';
$step = empty( $args['max'] ) ? '' : ' step="' . $args['step'] . '"';
$html = sprintf( ' ', $type, $size, $args['section'], $args['id'], $value, $placeholder, $min, $max, $step );
$html .= $this->get_field_description( $args );
echo $html; // @codingStandardsIgnoreLine.
}
/**
* Displays a checkbox for a settings field.
*
* @param array $args settings field args.
*/
public function callback_checkbox( $args ) {
$value = esc_attr( $this->get_option( $args['id'], $args['section'], $args['std'] ) );
$html = '';
$html .= sprintf( '', $args['section'], $args['id'] );
$html .= sprintf( ' ', $args['section'], $args['id'] );
$html .= sprintf( ' ', $args['section'], $args['id'], checked( $value, 'on', false ) );
$html .= sprintf( '%1$s ', $args['desc'] );
$html .= ' ';
echo $html; // @codingStandardsIgnoreLine.
}
/**
* Displays a multi checkbox a settings field.
*
* @param array $args settings field args.
*/
public function callback_multicheck( $args ) {
$value = $this->get_option( $args['id'], $args['section'], $args['std'] );
$html = '';
$html .= sprintf( ' ', $args['section'], $args['id'] );
foreach ( $args['options'] as $key => $label ) {
$checked = isset( $value[ $key ] ) ? $value[ $key ] : '0';
$html .= sprintf( '', $args['section'], $args['id'], $key );
$html .= sprintf( ' ', $args['section'], $args['id'], $key, checked( $checked, $key, false ) );
$html .= sprintf( '%1$s ', $label );
}
$html .= $this->get_field_description( $args );
$html .= ' ';
echo $html; // @codingStandardsIgnoreLine.
}
/**
* Displays a multi checkbox a settings field.
*
* @param array $args settings field args.
*/
public 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 );
$html .= sprintf( ' ', $args['section'], $args['id'], $key, checked( $value, $key, false ) );
$html .= sprintf( '%1$s ', $label );
}
$html .= $this->get_field_description( $args );
$html .= ' ';
echo $html; // @codingStandardsIgnoreLine.
}
/**
* Displays a selectbox for a settings field.
*
* @param array $args settings field args.
*/
public 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( '', $size, $args['section'], $args['id'] );
foreach ( $args['options'] as $key => $label ) {
$html .= sprintf( '%s ', $key, selected( $value, $key, false ), $label );
}
$html .= sprintf( ' ' );
$html .= $this->get_field_description( $args );
echo $html; // @codingStandardsIgnoreLine.
}
/**
* Displays a textarea for a settings field.
*
* @param array $args settings field args.
*/
public 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="' . $args['placeholder'] . '"';
$html = sprintf( '', $size, $args['section'], $args['id'], $placeholder, $value );
$html .= $this->get_field_description( $args );
echo $html; // @codingStandardsIgnoreLine.
}
/**
* Displays a textarea for a settings field.
*
* @param array $args settings field args.
*/
public function callback_html( $args ) {
echo $this->get_field_description( $args ); // @codingStandardsIgnoreLine.
}
/**
* Displays a rich text textarea for a settings field.
*
* @param array $args settings field args.
*/
public 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 ''; // @codingStandardsIgnoreLine.
$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 ); // @codingStandardsIgnoreLine.
}
/**
* Displays a file upload field for a settings field.
*
* @param array $args settings field args.
* @version 3.1.3
*/
public 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', 'wp-headers-and-footers' );
$html = sprintf( ' ', $size, $args['section'], $args['id'], $value );
$html .= ' ';
$html .= $this->get_field_description( $args );
echo $html; // @codingStandardsIgnoreLine.
}
/**
* Displays a password field for a settings field.
*
* @param array $args settings field args.
*/
public 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 $html; // @codingStandardsIgnoreLine.
}
/**
* Displays a color picker field for a settings field.
*
* @param array $args settings field args.
*/
public 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 $html; // @codingStandardsIgnoreLine.
}
/**
* Sanitize callback for Settings API.
*
* @param array $options sanitize option.
* @return mixed
*/
public function sanitize_options( $options ) {
$logger_settings = array();
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;
}
$logger_settings[ 'is_using_' . $option_slug ] = ! empty( trim( $option_value ) ) ? true : false;
}
update_option( 'wpheaderandfooter_basics_logger', $logger_settings );
return $options;
}
/**
* Get sanitization callback for given option slug.
*
* @param string $slug option slug.
*
* @return mixed string or bool false.
*/
public 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 $default the default text if it's not found or settings field name.
*/
public function get_option( $option, $section, $default = '' ) {
$options = get_option( $section );
if ( isset( $options[ $option ] ) ) {
return $options[ $option ];
}
return $default;
}
/**
* Show navigation as tab.
*
* Shows all the settings section labels as tab.
*/
public function show_navigation() {
$html = '';
$count = count( $this->settings_sections );
foreach ( $this->settings_sections as $tab ) {
$html .= sprintf( '%2$s ', $tab['id'], $tab['title'] );
}
$html .= ' ';
echo $html; // @codingStandardsIgnoreLine.
}
/**
* Show the section settings forms.
*
* This function displays every sections in a different form.
*/
public function show_forms() {
?>
script();
}
/**
* Tab able JavaScript codes & Initiate Color Picker.
*
* This code uses local storage for displaying active tabs
*/
public function script() {
?>
style_fix();
}
/**
* The style fix if WP version is less than 5.8
*/
public function style_fix() {
global $wp_version;
if ( version_compare( $wp_version, '3.8', '<=' ) ) :
?>
{$section['title']}\n"; // @codingStandardsIgnoreLine.
echo $section['callback']; // @codingStandardsIgnoreLine.
if ( ! isset( $wp_settings_fields ) || ! isset( $wp_settings_fields[ $page ] ) || ! isset( $wp_settings_fields[ $page ][ $section['id'] ] ) ) {
continue;
}
echo '';
}
}
}
endif;