PHP Class WeDevs_Settings_API

Exibir arquivo Open project: tareq1988/wordpress-settings-api-class Class Usage Examples

Protected Properties

Property Type Description
$settings_fields array Settings fields array
$settings_sections array settings sections array

Public Methods

Method Description
__construct ( )
_style_fix ( )
add_field ( $section, $field )
add_section ( array $section ) Add a single section
admin_enqueue_scripts ( ) Enqueue scripts and styles
admin_init ( ) Initialize and registers the settings sections and fileds to WordPress
callback_checkbox ( array $args ) Displays a checkbox for a settings field
callback_color ( array $args ) Displays a color picker field for a settings field
callback_file ( array $args ) Displays a file upload field for a settings field
callback_html ( array $args ) : string Displays a textarea for a settings field
callback_multicheck ( array $args ) Displays a multicheckbox a settings field
callback_number ( array $args ) Displays a number field for a settings field
callback_password ( array $args ) Displays a password field for a settings field
callback_radio ( array $args ) Displays a multicheckbox a settings field
callback_select ( array $args ) Displays a selectbox for a settings field
callback_text ( array $args ) Displays a text field for a settings field
callback_textarea ( array $args ) Displays a textarea for a settings field
callback_url ( array $args ) Displays a url field for a settings field
callback_wysiwyg ( array $args ) Displays a rich text textarea for a settings field
get_field_description ( array $args ) Get field description for display
get_option ( string $option, string $section, string $default = '' ) : string Get the value of a settings field
get_sanitize_callback ( string $slug = '' ) : mixed Get sanitization callback for given option slug
sanitize_options ( $options ) : mixed Sanitize callback for Settings API
script ( ) Tabbable JavaScript codes & Initiate Color Picker
set_fields ( array $fields ) Set settings fields
set_sections ( array $sections ) Set settings sections
show_forms ( ) Show the section settings forms
show_navigation ( ) Show navigations as tab

Method Details

__construct() public method

public __construct ( )

_style_fix() public method

public _style_fix ( )

add_field() public method

public add_field ( $section, $field )

add_section() public method

Add a single section
public add_section ( array $section )
$section array

admin_enqueue_scripts() public method

Enqueue scripts and styles
public admin_enqueue_scripts ( )

admin_init() public method

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 admin_init ( )

callback_checkbox() public method

Displays a checkbox for a settings field
public callback_checkbox ( array $args )
$args array settings field args

callback_color() public method

Displays a color picker field for a settings field
public callback_color ( array $args )
$args array settings field args

callback_file() public method

Displays a file upload field for a settings field
public callback_file ( array $args )
$args array settings field args

callback_html() public method

Displays a textarea for a settings field
public callback_html ( array $args ) : string
$args array settings field args
return string

callback_multicheck() public method

Displays a multicheckbox a settings field
public callback_multicheck ( array $args )
$args array settings field args

callback_number() public method

Displays a number field for a settings field
public callback_number ( array $args )
$args array settings field args

callback_password() public method

Displays a password field for a settings field
public callback_password ( array $args )
$args array settings field args

callback_radio() public method

Displays a multicheckbox a settings field
public callback_radio ( array $args )
$args array settings field args

callback_select() public method

Displays a selectbox for a settings field
public callback_select ( array $args )
$args array settings field args

callback_text() public method

Displays a text field for a settings field
public callback_text ( array $args )
$args array settings field args

callback_textarea() public method

Displays a textarea for a settings field
public callback_textarea ( array $args )
$args array settings field args

callback_url() public method

Displays a url field for a settings field
public callback_url ( array $args )
$args array settings field args

callback_wysiwyg() public method

Displays a rich text textarea for a settings field
public callback_wysiwyg ( array $args )
$args array settings field args

get_field_description() public method

Get field description for display
public get_field_description ( array $args )
$args array settings field args

get_option() public method

Get the value of a settings field
public get_option ( string $option, string $section, string $default = '' ) : string
$option string settings field name
$section string the section name this field belongs to
$default string default text if it's not found
return string

get_sanitize_callback() public method

Get sanitization callback for given option slug
public get_sanitize_callback ( string $slug = '' ) : mixed
$slug string option slug
return mixed string or bool false

sanitize_options() public method

Sanitize callback for Settings API
public sanitize_options ( $options ) : mixed
return mixed

script() public method

This code uses localstorage for displaying active tabs
public script ( )

set_fields() public method

Set settings fields
public set_fields ( array $fields )
$fields array settings fields array

set_sections() public method

Set settings sections
public set_sections ( array $sections )
$sections array setting sections array

show_forms() public method

This function displays every sections in a different form
public show_forms ( )

show_navigation() public method

Shows all the settings section labels as tab
public show_navigation ( )

Property Details

$settings_fields protected_oe property

Settings fields array
protected array $settings_fields
return array

$settings_sections protected_oe property

settings sections array
protected array $settings_sections
return array