WP_Customize_Setting

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0).

Hooks and filters fired · 8

Every hook that fires from inside WP_Customize_Setting, in the order it appears in the class, grouped by the method that fires it.

Properties · 17

$managerWP_Customize_Managerpublic

Customizer bootstrap instance.

$idstringpublic

Unique string identifier for the setting.

$typestringpublic

Type of customize settings.

$capabilitystring|arraypublic

Capability required to edit this setting.

$theme_supportsstring|string[]public

Theme features required to support the setting.

$defaultstringpublic

The default value for the setting.

$transportstringpublic

Options for rendering the live preview of changes in Customizer.

$validate_callbackcallablepublic

Server-side validation callback for the setting's value.

$sanitize_callbackcallablepublic

Callback to filter a Customize setting value in un-slashed form.

$sanitize_js_callbackcallablepublic

Callback to convert a Customize PHP setting value to a value that is JSON serializable.

$dirtyboolpublic

Whether or not the setting is initially dirty when created.

$id_dataarrayprotected

ID Data.

$is_previewedboolprotected

Whether or not preview() was called.

$aggregated_multidimensionalsarrayprotected static

Cache of multidimensional values to improve performance.

$is_multidimensional_aggregatedboolprotected

Whether the multidimensional setting is aggregated.

$_previewed_blog_idintprotected

The ID for the current site when the preview() method was called.

$_original_valuemixedprotected

Original non-previewed value stored by the preview method.

Methods · 26

• __construct()Constructor.
• id_data()Get parsed ID data for multidimensional setting.
• aggregate_multidimensional()Set up the setting for aggregated multidimensional values.
• reset_aggregated_multidimensionals()Reset `$aggregated_multidimensionals` static variable.
• is_current_blog_previewed()Return true if the current site is not the same as the previewed site.
• preview()Add filters to supply the setting's value when accessed.
• _clear_aggregated_multidimensional_preview_applied_flag()Clear out the previewed-applied flag for a multidimensional-aggregated value whenever its post value is updated.
• _preview_filter()Callback function to filter non-multidimensional theme mods and options.
• _multidimensional_preview_filter()Callback function to filter multidimensional theme mods and options.
• save()Checks user capabilities and theme supports, and then saves the value of the setting.
• post_value()Fetch and sanitize the $_POST value for the setting.
• sanitize()Sanitize an input.
• validate()Validates an input.
• get_root_value()Get the root value for a setting, especially for multidimensional ones.
• set_root_value()Set the root value for a setting, especially for multidimensional ones.
• update()Save the value of the setting, using the related API.
• _update_theme_mod()Deprecated method.
• _update_option()Deprecated method.
• value()Fetch the value of the setting.
• js_value()Sanitize the setting's value for use in JavaScript.
• json()Retrieves the data to export to the client via JSON.
• check_capabilities()Validate user capabilities whether the theme supports the setting.
• multidimensional()Multidimensional helper function.
• multidimensional_replace()Will attempt to replace a specific value in a multidimensional array.
• multidimensional_get()Will attempt to fetch a specific value from a multidimensional array.
• multidimensional_isset()Will attempt to check if a specific value in a multidimensional array is set.

Source code

View on Trac ↗View on GitHub ↗

25#[AllowDynamicProperties]26class WP_Customize_Setting {27	/**28	 * Customizer bootstrap instance.29	 *30	 * @since 3.4.031	 * @var WP_Customize_Manager32	 */33	public $manager;34 35	/**36	 * Unique string identifier for the setting.37	 *38	 * @since 3.4.039	 * @var string40	 */41	public $id;42 43	/**44	 * Type of customize settings.45	 *46	 * @since 3.4.047	 * @var string48	 */49	public $type = 'theme_mod';50 51	/**52	 * Capability required to edit this setting.53	 *54	 * @since 3.4.055	 * @var string|array56	 */57	public $capability = 'edit_theme_options';58 59	/**60	 * Theme features required to support the setting.61	 *62	 * @since 3.4.063	 * @var string|string[]64	 */65	public $theme_supports = '';66 67	/**68	 * The default value for the setting.69	 *70	 * @since 3.4.071	 * @var string72	 */73	public $default = '';74 75	/**76	 * Options for rendering the live preview of changes in Customizer.77	 *78	 * Set this value to 'postMessage' to enable a custom JavaScript handler to render changes to this setting79	 * as opposed to reloading the whole page.80	 *81	 * @since 3.4.082	 * @var string83	 */84	public $transport = 'refresh';85 86	/**87	 * Server-side validation callback for the setting's value.88	 *89	 * @since 4.6.090	 * @var callable91	 */92	public $validate_callback = '';93 94	/**95	 * Callback to filter a Customize setting value in un-slashed form.96	 *97	 * @since 3.4.098	 * @var callable99	 */100	public $sanitize_callback = '';101 102	/**103	 * Callback to convert a Customize PHP setting value to a value that is JSON serializable.104	 *

Changelog

Introduced in 3.4.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/class-wp-customize-setting.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.