• Inicio
• WP_Customize_Setting

PHP Class WP_Customize_Setting, wordpress

Handles saving and sanitizing of settings. Mostrar archivo Open project: johnpbloch/wordpress Class Usage Examples

Public Properties

Property	Type	Description
$capability	string	Capability required to edit this setting.
$default
$dirty	boolean	This is used to ensure that a setting will be sent from the pane to the preview when loading the Customizer. Normally a setting only is synced to the preview if it has been changed. This allows the setting to be sent from the start.
$id	string	Unique string identifier for the setting.
$manager	WP_Customize_Manager
$sanitize_callback
$sanitize_js_callback
$theme_supports	string	Feature a theme is required to support to enable this setting.
$transport
$type	string
$validate_callback	callback	Server-side sanitization callback for the setting's value.

Protected Properties

Property	Type	Description
$_original_value	mixed	Original non-previewed value stored by the preview method.
$_previewed_blog_id	integer	The ID for the current site when the preview() method was called.
$aggregated_multidimensionals	array	Cache of multidimensional values to improve performance.
$id_data	array
$is_multidimensional_aggregated	boolean	Whether the multidimensional setting is aggregated.
$is_previewed	boolean	Whether or not preview() was called.

Public Methods

Method	Description
__construct ( WP_Customize_Manager $manager, string $id, array $args = [] )	Constructor.
_clear_aggregated_multidimensional_preview_applied_flag ( )	Clear out the previewed-applied flag for a multidimensional-aggregated value whenever its post value is updated.
_multidimensional_preview_filter ( mixed $original ) : mixed	Callback function to filter multidimensional theme mods and options.
_preview_filter ( mixed $original ) : mixed	Callback function to filter non-multidimensional theme mods and options.
check_capabilities ( ) : boolean	Validate user capabilities whether the theme supports the setting.
id_data ( ) : array	Get parsed ID data for multidimensional setting.
is_current_blog_previewed ( ) : boolean	Return true if the current site is not the same as the previewed site.
js_value ( ) : mixed	Sanitize the setting's value for use in JavaScript.
json ( ) : array	Retrieves the data to export to the client via JSON.
post_value ( mixed $default = null ) : mixed	Fetch and sanitize the $_POST value for the setting.
preview ( ) : boolean	Add filters to supply the setting's value when accessed.
reset_aggregated_multidimensionals ( )	Reset $aggregated_multidimensionals static variable.
sanitize ( string | array $value ) : string | array | null | WP_Error	Sanitize an input.
save ( ) : false | void	Checks user capabilities and theme supports, and then saves the value of the setting.
validate ( mixed $value ) : true | WP_Error	Validates an input.
value ( ) : mixed	Fetch the value of the setting.

Protected Methods

Method	Description
_update_option ( )	Deprecated method.
_update_theme_mod ( )	Deprecated method.
aggregate_multidimensional ( )	Set up the setting for aggregated multidimensional values.
get_root_value ( mixed $default = null ) : mixed	Get the root value for a setting, especially for multidimensional ones.
multidimensional ( &$root, $keys, boolean $create = false ) : array | void	Multidimensional helper function.
multidimensional_get ( $root, $keys, mixed $default = null ) : mixed	Will attempt to fetch a specific value from a multidimensional array.
multidimensional_isset ( $root, $keys ) : boolean	Will attempt to check if a specific value in a multidimensional array is set.
multidimensional_replace ( $root, $keys, mixed $value ) : mixed	Will attempt to replace a specific value in a multidimensional array.
set_root_value ( mixed $value ) : boolean	Set the root value for a setting, especially for multidimensional ones.
update ( mixed $value ) : boolean	Save the value of the setting, using the related API.

Method Details

Property Details