Settings implements Registerable, Service
Settings Registry
Tags
Interfaces, Classes and Traits
- Registerable
- Service
Table of Contents
- $plugin : mixed
- __construct() : mixed
- Constructor.
- allowed_options() : array<string|int, mixed>
- Adjust the allowed_options so that single settings keys can be shared across tabs.
- backwards_compatibility() : void
- Add backwards compatibility for specific settings.
- filter_allowed_options() : mixed
- Hook into the allowed_options filter.
- register() : mixed
- {@inheritdoc}
- register_settings() : mixed
- Register our settings parent options with Settings API.
- sanitize_document_display_fields() : array<string|int, string>
- Sanitize the document display fields.
- sanitize_document_fields() : array<string|int, string>
- Sanitize the document post type fields.
- sanitize_document_page() : string
- Sanitize the Document Page setting.
- sanitize_document_slug() : string
- Sanitize the Document Slug setting.
- sanitize_misc_settings() : mixed
- Sanitize the Misc Settings.
- sanitize_search_page_setting() : string
- Sanitize the Search Page setting.
- sanitize_shortcode_settings() : array<string|int, mixed>
- Sanitize the shortcode setting depending on the setting tab.
- sanitize_svg() : mixed
- Sanitize a SVG string.
- get_existing_misc_settings() : array<string|int, mixed>
- Retrieve the existing misc options.
- get_existing_shortcode_options() : array<string|int, mixed>
- Retrieve the existing shortcode options.
Properties
$plugin
private
mixed
$plugin
Tags
Methods
__construct()
Constructor.
public
__construct(Plugin $plugin) : mixed
Parameters
- $plugin : Plugin
Tags
Return values
mixed —allowed_options()
Adjust the allowed_options so that single settings keys can be shared across tabs.
public
allowed_options(array<string|int, mixed> $options) : array<string|int, mixed>
Parameters
- $options : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —backwards_compatibility()
Add backwards compatibility for specific settings.
public
backwards_compatibility() : void
Tags
Return values
void —filter_allowed_options()
Hook into the allowed_options filter.
public
filter_allowed_options() : mixed
Back compatibility ( < 5.5 ) included with 'whitelist_options'.
Tags
Return values
mixed —register()
{@inheritdoc}
public
register() : mixed
Tags
Return values
mixed —register_settings()
Register our settings parent options with Settings API.
public
register_settings() : mixed
Tags
Return values
mixed —sanitize_document_display_fields()
Sanitize the document display fields.
public
sanitize_document_display_fields(mixed $args) : array<string|int, string>
Parameters
- $args : mixed
Tags
Return values
array<string|int, string> —sanitize_document_fields()
Sanitize the document post type fields.
public
sanitize_document_fields(mixed $args) : array<string|int, string>
Parameters
- $args : mixed
Tags
Return values
array<string|int, string> —sanitize_document_page()
Sanitize the Document Page setting.
public
sanitize_document_page(string $page_setting) : string
Parameters
- $page_setting : string
Tags
Return values
string —sanitize_document_slug()
Sanitize the Document Slug setting.
public
sanitize_document_slug(string $slug_setting) : string
Parameters
- $slug_setting : string
Tags
Return values
string —sanitize_misc_settings()
Sanitize the Misc Settings.
public
sanitize_misc_settings(mixed $args) : mixed
Parameters
- $args : mixed
Tags
Return values
mixed —sanitize_search_page_setting()
Sanitize the Search Page setting.
public
sanitize_search_page_setting(string $page_setting) : string
Parameters
- $page_setting : string
Tags
Return values
string —sanitize_shortcode_settings()
Sanitize the shortcode setting depending on the setting tab.
public
sanitize_shortcode_settings(mixed $args) : array<string|int, mixed>
Parameters
- $args : mixed
Tags
Return values
array<string|int, mixed> —sanitize_svg()
Sanitize a SVG string.
public
sanitize_svg(mixed $svg) : mixed
Parameters
- $svg : mixed
Tags
Return values
mixed —get_existing_misc_settings()
Retrieve the existing misc options.
private
get_existing_misc_settings() : array<string|int, mixed>
This is used so we can merge the shared settings from other tabs before WordPress saves the setting.
Tags
Return values
array<string|int, mixed> —get_existing_shortcode_options()
Retrieve the existing shortcode options.
private
get_existing_shortcode_options() : array<string|int, mixed>
This is used so we can merge the shared settings from other tabs before WordPress saves the setting.