WP_Customize_Setting

Description

Hooks 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

View on Trac ↗View on GitHub ↗

20#[AllowDynamicProperties]21class WP_Customize_Setting {22	/**23	 * Customizer bootstrap instance.24	 *25	 * @since 3.4.026	 * @var WP_Customize_Manager27	 */28	public $manager;29 30	/**31	 * Unique string identifier for the setting.32	 *33	 * @since 3.4.034	 * @var string35	 */36	public $id;37 38	/**39	 * Type of customize settings.40	 *41	 * @since 3.4.042	 * @var string43	 */44	public $type = 'theme_mod';45 46	/**47	 * Capability required to edit this setting.48	 *49	 * @since 3.4.050	 * @var string|array51	 */52	public $capability = 'edit_theme_options';53 54	/**55	 * Theme features required to support the setting.56	 *57	 * @since 3.4.058	 * @var string|string[]59	 */60	public $theme_supports = '';61 62	/**63	 * The default value for the setting.64	 *65	 * @since 3.4.066	 * @var string67	 */68	public $default = '';69 70	/**71	 * Options for rendering the live preview of changes in Customizer.72	 *73	 * Set this value to 'postMessage' to enable a custom JavaScript handler to render changes to this setting74	 * as opposed to reloading the whole page.75	 *76	 * @since 3.4.077	 * @var string78	 */79	public $transport = 'refresh';80 81	/**82	 * Server-side validation callback for the setting's value.83	 *84	 * @since 4.6.085	 * @var callable86	 */87	public $validate_callback = '';88 89	/**90	 * Callback to filter a Customize setting value in un-slashed form.91	 *92	 * @since 3.4.093	 * @var callable94	 */95	public $sanitize_callback = '';96 97	/**98	 * Callback to convert a Customize PHP setting value to a value that is JSON serializable.99	 *

History

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.7.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.