Settings_API_Helper
in package
implements
Registerable, Conditional
Helper functions for the WordPress Settings API.
Tags
Interfaces, Classes and Traits
- Registerable
- An object that can be registered with WordPress via the Plugin API, i.e. add_action() and add_filter().
- Conditional
- An object which is loaded conditionally.
Table of Contents
- $plugin : Plugin
- $scripts : Settings_Scripts
- __construct() : mixed
- add_settings_fields() : mixed
- add_settings_section() : mixed
- is_required() : bool
- Is this object required?
- register() : mixed
- settings_field_checkbox() : mixed
- settings_field_color() : mixed
- settings_field_color_size() : mixed
- settings_field_help_note() : mixed
- settings_field_hidden() : mixed
- settings_field_multicheckbox() : mixed
- settings_field_number() : mixed
- settings_field_radio() : mixed
- settings_field_select() : mixed
- settings_field_text() : mixed
- settings_field_textarea() : mixed
- custom_attributes() : mixed
- field_description() : mixed
- field_tooltip() : mixed
- get_custom_attributes() : mixed
- get_value() : mixed
- sanitize_tooltip() : mixed
Properties
$plugin
private
Plugin
$plugin
The plugin object.
$scripts
private
Settings_Scripts
$scripts
Responsible for registering any additional settings scripts.
Methods
__construct()
public
__construct(Plugin $plugin) : mixed
Parameters
- $plugin : Plugin
Return values
mixed —add_settings_fields()
public
static add_settings_fields(mixed $settings, mixed $section, mixed $page) : mixed
Parameters
- $settings : mixed
- $section : mixed
- $page : mixed
Return values
mixed —add_settings_section()
public
static add_settings_section(mixed $section, mixed $page, mixed $title, mixed $description_callback[, mixed $settings = false ]) : mixed
Parameters
- $section : mixed
- $page : mixed
- $title : mixed
- $description_callback : mixed
- $settings : mixed = false
Return values
mixed —is_required()
Is this object required?
public
is_required() : bool
Return values
bool —true if required, false otherwise.
register()
public
register() : mixed
Return values
mixed —settings_field_checkbox()
public
static settings_field_checkbox(mixed $args) : mixed
Parameters
- $args : mixed
Return values
mixed —settings_field_color()
public
static settings_field_color(mixed $args) : mixed
Parameters
- $args : mixed
Return values
mixed —settings_field_color_size()
public
static settings_field_color_size(mixed $args) : mixed
Parameters
- $args : mixed
Return values
mixed —settings_field_help_note()
public
static settings_field_help_note(mixed $args) : mixed
Parameters
- $args : mixed
Return values
mixed —settings_field_hidden()
public
static settings_field_hidden(mixed $args) : mixed
Parameters
- $args : mixed
Return values
mixed —settings_field_multicheckbox()
public
static settings_field_multicheckbox(mixed $args) : mixed
Parameters
- $args : mixed
Return values
mixed —settings_field_number()
public
static settings_field_number(mixed $args) : mixed
Parameters
- $args : mixed
Return values
mixed —settings_field_radio()
public
static settings_field_radio(mixed $args) : mixed
Parameters
- $args : mixed
Return values
mixed —settings_field_select()
public
static settings_field_select(mixed $args) : mixed
Parameters
- $args : mixed
Return values
mixed —settings_field_text()
public
static settings_field_text(mixed $args) : mixed
Parameters
- $args : mixed
Return values
mixed —settings_field_textarea()
public
static settings_field_textarea(mixed $args) : mixed
Parameters
- $args : mixed
Return values
mixed —custom_attributes()
private
static custom_attributes(mixed $args) : mixed
Parameters
- $args : mixed
Return values
mixed —field_description()
private
static field_description(mixed $args) : mixed
Parameters
- $args : mixed
Return values
mixed —field_tooltip()
private
static field_tooltip(mixed $args) : mixed
Parameters
- $args : mixed
Return values
mixed —get_custom_attributes()
private
static get_custom_attributes(mixed $args) : mixed
Parameters
- $args : mixed
Return values
mixed —get_value()
private
static get_value(mixed $option[, mixed $default = false ]) : mixed
Parameters
- $option : mixed
- $default : mixed = false
Return values
mixed —sanitize_tooltip()
private
static sanitize_tooltip(mixed $content) : mixed
Parameters
- $content : mixed