WordPress Cross Reference

(no description)

File Size:	439 lines (11 kb)
Included or required:	1 time
Referenced:	0 times
Includes or requires:	0 files

Defines 2 classes

WP_Customize_Setting:: (16 methods):
  __construct()
  preview()
  _preview_filter()
  save()
  post_value()
  sanitize()
  update()
  _update_theme_mod()
  _update_option()
  value()
  js_value()
  check_capabilities()
  multidimensional()
  multidimensional_replace()
  multidimensional_get()
  multidimensional_isset()

WP_Customize_Filter_Setting:: (3 methods):
  update()
  update()
  update()

Class: WP_Customize_Setting - X-Ref

Customize Setting Class.

__construct( $manager, $id, $args = array() X-Ref

Constructor.

param: WP_Customize_Manager $manager
param: string $id An specific ID of the setting. Can be a
param: array $args Setting arguments.
return: WP_Customize_Setting

preview() X-Ref

Handle previewing the setting.

_preview_filter( $original ) X-Ref

Callback function to filter the theme mods and options.

param: mixed $original Old value.
return: mixed New or old value.

save() X-Ref

Set the value of the parameter for a specific theme.

return: bool False if cap check fails or value isn't set.

post_value( $default = null ) X-Ref

Fetches, validates, and sanitizes the $_POST value.

param: mixed $default A default value which is used as a fallback. Default is null.
return: mixed The default value on failure, otherwise the sanitized value.

sanitize( $value ) X-Ref

Sanitize an input.

param: mixed $value The value to sanitize.
return: mixed Null if an input isn't valid, otherwise the sanitized value.

update( $value ) X-Ref

Set the value of the parameter for a specific theme.

param: mixed $value The value to update.
return: mixed The result of saving the value.

_update_theme_mod( $value ) X-Ref

Update the theme mod from the value of the parameter.

param: mixed $value The value to update.
return: mixed The result of saving the value.

_update_option( $value ) X-Ref

Update the theme mod from the value of the parameter.

param: mixed $value The value to update.
return: mixed The result of saving the value.

value() X-Ref

Fetch the value of the parameter for a specific theme.

return: mixed The requested value.

js_value() X-Ref

Escape the parameter's value for use in JavaScript.

return: mixed The requested escaped value.

check_capabilities() X-Ref

Check if the theme supports the setting and check user capabilities.

return: bool False if theme doesn't support the setting or user can't change setting, otherwise true.

multidimensional( &$root, $keys, $create = false ) X-Ref

Multidimensional helper function.

param: $root
param: $keys
param: bool $create Default is false.
return: null|array Keys are 'root', 'node', and 'key'.

multidimensional_replace( $root, $keys, $value ) X-Ref

Will attempt to replace a specific value in a multidimensional array.

param: $root
param: $keys
param: mixed $value The value to update.
return:

multidimensional_get( $root, $keys, $default = null ) X-Ref

Will attempt to fetch a specific value from a multidimensional array.

param: $root
param: $keys
param: $default A default value which is used as a fallback. Default is null.
return: mixed The requested value or the default value.

multidimensional_isset( $root, $keys ) X-Ref

Will attempt to check if a specific value in a multidimensional array is set.

param: $root
param: $keys
return: bool True if value is set, false if not.

Class: WP_Customize_Filter_Setting - X-Ref

A setting that is used to filter a value, but will not save the results.

Results should be properly handled using another setting or callback.

update( $value ) X-Ref

param: $value

update( $value ) X-Ref

param: $value

/wp-includes/ -> class-wp-customize-setting.php (summary)

Defines 2 classes