Settings_API_Helper 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
- $scripts : Settings_Scripts
- Responsible for registering any additional settings scripts.
- __construct() : mixed
- Constructor.
- add_settings_fields() : mixed
- Adds the setting fields to a section.
- add_settings_section() : mixed
- Adds a setting section.
- is_required() : bool
- Is this object required?
- register() : void
- Register this object with WordPress.
- settings_field_checkbox() : mixed
- Checkbox field.
- settings_field_color() : mixed
- Color field.
- settings_field_color_size() : mixed
- Color & Size field.
- settings_field_help_note() : mixed
- Settings field help note (alias description).
- settings_field_hidden() : mixed
- Hidden field.
- settings_field_multicheckbox() : mixed
- Multicheckbox field.
- settings_field_number() : mixed
- Number field.
- settings_field_radio() : mixed
- Radio field.
- settings_field_select() : mixed
- Select field.
- settings_field_text() : mixed
- Text field.
- settings_field_textarea() : mixed
- Textarea field.
- custom_attributes() : mixed
- Output custom attributes.
- field_description() : mixed
- Output field description.
- field_tooltip() : mixed
- Tooltip field.
- get_custom_attributes() : string
- Retrieve custom attributes.
- get_value() : mixed
- Retrieve the value for an option.
Properties
$scripts
Responsible for registering any additional settings scripts.
private
Settings_Scripts
$scripts
Methods
__construct()
Constructor.
public
__construct(Plugin $plugin) : mixed
Parameters
- $plugin : Plugin
Return values
mixed —add_settings_fields()
Adds the setting fields to a section.
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()
Adds a setting section.
public
static add_settings_section(string $section, string $page, string $title, mixed $description_callback[, bool $settings = false ]) : mixed
Parameters
- $section : string
- $page : string
- $title : string
- $description_callback : mixed
- $settings : bool = false
Return values
mixed —is_required()
Is this object required?
public
is_required() : bool
Return values
bool —true if required, false otherwise.
register()
Register this object with WordPress.
public
register() : void
Return values
void —settings_field_checkbox()
Checkbox field.
public
static settings_field_checkbox(array<string|int, mixed> $args) : mixed
Parameters
- $args : array<string|int, mixed>
Return values
mixed —settings_field_color()
Color field.
public
static settings_field_color(array<string|int, mixed> $args) : mixed
Parameters
- $args : array<string|int, mixed>
Return values
mixed —settings_field_color_size()
Color & Size field.
public
static settings_field_color_size(array<string|int, mixed> $args) : mixed
Parameters
- $args : array<string|int, mixed>
Return values
mixed —settings_field_help_note()
Settings field help note (alias description).
public
static settings_field_help_note(array<string|int, mixed> $args) : mixed
Parameters
- $args : array<string|int, mixed>
Return values
mixed —settings_field_hidden()
Hidden field.
public
static settings_field_hidden(array<string|int, mixed> $args) : mixed
Parameters
- $args : array<string|int, mixed>
Return values
mixed —settings_field_multicheckbox()
Multicheckbox field.
public
static settings_field_multicheckbox(array<string|int, mixed> $args) : mixed
Parameters
- $args : array<string|int, mixed>
Return values
mixed —settings_field_number()
Number field.
public
static settings_field_number(array<string|int, mixed> $args) : mixed
Parameters
- $args : array<string|int, mixed>
Return values
mixed —settings_field_radio()
Radio field.
public
static settings_field_radio(array<string|int, mixed> $args) : mixed
Parameters
- $args : array<string|int, mixed>
Return values
mixed —settings_field_select()
Select field.
public
static settings_field_select(array<string|int, mixed> $args) : mixed
Parameters
- $args : array<string|int, mixed>
Return values
mixed —settings_field_text()
Text field.
public
static settings_field_text(array<string|int, mixed> $args) : mixed
Parameters
- $args : array<string|int, mixed>
Return values
mixed —settings_field_textarea()
Textarea field.
public
static settings_field_textarea(array<string|int, mixed> $args) : mixed
Parameters
- $args : array<string|int, mixed>
Return values
mixed —custom_attributes()
Output custom attributes.
private
static custom_attributes(array<string|int, mixed> $args) : mixed
Parameters
- $args : array<string|int, mixed>
Return values
mixed —field_description()
Output field description.
private
static field_description(array<string|int, mixed> $args) : mixed
Parameters
- $args : array<string|int, mixed>
Return values
mixed —field_tooltip()
Tooltip field.
private
static field_tooltip(array<string|int, mixed> $args) : mixed
Parameters
- $args : array<string|int, mixed>
Return values
mixed —get_custom_attributes()
Retrieve custom attributes.
private
static get_custom_attributes(array<string|int, mixed> $args) : string
Parameters
- $args : array<string|int, mixed>
Return values
string —get_value()
Retrieve the value for an option.
private
static get_value(string $option[, mixed $default = false ]) : mixed
Parameters
- $option : string
- $default : mixed = false