WP_Customize_Setting
class WP_Customize_Setting
// Constructor: function Object() { [native code] } Customize Setting class.
Methods 26 methods
| Method / Return | Description |
|---|---|
| __construct() void | Constructor.
Parameters: $manager: mixed, $id: mixed, $args: mixed |
| id_data() array | Get parsed ID data for multidimensional setting. |
| aggregate_multidimensional() void | Set up the setting for aggregated multidimensional values. |
| reset_aggregated_multidimensionals() void | Reset `$aggregated_multidimensionals` static variable. |
| is_current_blog_previewed() bool | Return true if the current site is not the same as the previewed site. |
| preview() bool | Add filters to supply the setting's value when accessed. |
| _clear_aggregated_multidimensional_preview_applied_flag() void | Clear out the previewed-applied flag for a multidimensional-aggregated value whenever its post value is updated. |
| _preview_filter() mixed | Callback function to filter non-multidimensional theme mods and options.
Parameters: $original: mixed |
| _multidimensional_preview_filter() mixed | Callback function to filter multidimensional theme mods and options.
Parameters: $original: mixed |
| save() (void | Checks user capabilities and theme supports, and then saves |
| post_value() mixed | Fetch and sanitize the $_POST value for the setting.
Parameters: $default_value: mixed |
| sanitize() (string | Sanitize an input.
Parameters: $value: mixed |
| validate() (true | Validates an input.
Parameters: $value: mixed |
| get_root_value() mixed | Get the root value for a setting, especially for multidimensional ones.
Parameters: $default_value: mixed |
| set_root_value() bool | Set the root value for a setting, especially for multidimensional ones.
Parameters: $value: mixed |
| update() bool | Save the value of the setting, using the related API.
Parameters: $value: mixed |
| _update_theme_mod() void | Deprecated method. |
| _update_option() void | Deprecated method. |
| value() mixed | Fetch the value of the setting. |
| js_value() mixed | Sanitize the setting's value for use in JavaScript. |
| json() array | Retrieves the data to export to the client via JSON. |
| check_capabilities() bool | Validate user capabilities whether the theme supports the setting. |
| multidimensional() (array | Multidimensional helper function.
Parameters: $root: mixed, $keys: mixed, $create: mixed |
| multidimensional_replace() mixed | Will attempt to replace a specific value in a multidimensional array.
Parameters: $root: mixed, $keys: mixed, $value: mixed |
| multidimensional_get() mixed | Will attempt to fetch a specific value from a multidimensional array.
Parameters: $root: mixed, $keys: mixed, $default_value: mixed |
| multidimensional_isset() bool | Will attempt to check if a specific value in a multidimensional array is set.
Parameters: $root: mixed, $keys: mixed |
Properties
| Property / Type | Description |
|---|---|
| $manager mixed public | No description available. |
| $id mixed public | No description available. |
| $type mixed public | No description available. |
| $capability mixed public | No description available. |
| $theme_supports mixed public | No description available. |
| $default mixed public | No description available. |
| $transport mixed public | No description available. |
| $validate_callback mixed public | No description available. |
| $sanitize_callback mixed public | No description available. |
| $sanitize_js_callback mixed public | No description available. |
| $dirty mixed public | No description available. |
| $id_data mixed public | No description available. |
| $is_previewed mixed public | No description available. |
| $aggregated_multidimensionals mixed public | No description available. |
| $is_multidimensional_aggregated mixed public | No description available. |
| $_previewed_blog_id mixed public | No description available. |
| $_original_value mixed public | No description available. |