enmi-conf.org: comparison wp/wp-includes/class-wp-customize-setting.php

equal deleted inserted replaced

-:3d4e9c994f10
+:a86126ab1dd4
 * Handles saving and sanitizing of settings.
 *
 * @since 3.4.0
 *
 * @see WP_Customize_Manager
+* @link https://developer.wordpress.org/themes/customize-api
 */
 class WP_Customize_Setting {
 	/**
 	 * Customizer bootstrap instance.
 	 *
 	 * @var string|array
 	 */
 	public $capability = 'edit_theme_options';
 	/**
-	 * Feature a theme is required to support to enable this setting.
+	 * Theme features required to support the setting.
 	 *
 	 * @since 3.4.0
-	 * @var string
+	 * @var string|string[]
 	 */
 	public $theme_supports = '';
 	/**
 	 * The default value for the setting.
 	 * Options for rendering the live preview of changes in Customizer.
 	 *
 	 * Set this value to 'postMessage' to enable a custom JavaScript handler to render changes to this setting
 	 * as opposed to reloading the whole page.
 	 *
-	 * @link https://developer.wordpress.org/themes/customize-api
-	 *
 	 * @since 3.4.0
 	 * @var string
 	 */
 	public $transport = 'refresh';
 	/**
 	 * Callback to convert a Customize PHP setting value to a value that is JSON serializable.
 	 *
 	 * @since 3.4.0
-	 * @var string
+	 * @var callable
 	 */
 	public $sanitize_js_callback = '';
 	/**
 	 * Whether or not the setting is initially dirty when created.
 	 *
 	 * Any supplied $args override class property defaults.
 	 *
 	 * @since 3.4.0
 	 *
-	 * @param WP_Customize_Manager $manager
+	 * @param WP_Customize_Manager $manager Customizer bootstrap instance.
-	 * @param string               $id      An specific ID of the setting. Can be a
+	 * @param string               $id      A specific ID of the setting.
-	 *                                      theme mod or option name.
+	 *                                      Can be a theme mod or option name.
-	 * @param array                $args    Setting arguments.
+	 * @param array                $args    {
+	 *     Optional. Array of properties for the new Setting object. Default empty array.
+	 *
+	 *     @type string          $type                 Type of the setting. Default 'theme_mod'.
+	 *     @type string          $capability           Capability required for the setting. Default 'edit_theme_options'
+	 *     @type string|string[] $theme_supports       Theme features required to support the panel. Default is none.
+	 *     @type string          $default              Default value for the setting. Default is empty string.
+	 *     @type string          $transport            Options for rendering the live preview of changes in Customizer.
+	 *                                                 Using 'refresh' makes the change visible by reloading the whole preview.
+	 *                                                 Using 'postMessage' allows a custom JavaScript to handle live changes.
+	 *                                                 Default is 'refresh'.
+	 *     @type callable        $validate_callback    Server-side validation callback for the setting's value.
+	 *     @type callable        $sanitize_callback    Callback to filter a Customize setting value in un-slashed form.
+	 *     @type callable        $sanitize_js_callback Callback to convert a Customize PHP setting value to a value that is
+	 *                                                 JSON serializable.
+	 *     @type bool            $dirty                Whether or not the setting is initially dirty when created.
+	 * }
 	 */
 	public function __construct( $manager, $id, $args = array() ) {
 		$keys = array_keys( get_object_vars( $this ) );
 		foreach ( $keys as $key ) {
 			if ( isset( $args[ $key ] ) ) {
 	 * Checks user capabilities and theme supports, and then saves
 	 * the value of the setting.
 	 *
 	 * @since 3.4.0
 	 *
-	 * @return false|void False if cap check fails or value isn't set or is invalid.
+	 * @return void|false False if cap check fails or value isn't set or is invalid.
 	 */
 	final public function save() {
 		$value = $this->post_value();
 		if ( ! $this->check_capabilities() || ! isset( $value ) ) {
 	 *
 	 * During a save request prior to save, post_value() provides the new value while value() does not.
 	 *
 	 * @since 3.4.0
 	 *
-	 * @param mixed $default A default value which is used as a fallback. Default is null.
+	 * @param mixed $default A default value which is used as a fallback. Default null.
 	 * @return mixed The default value on failure, otherwise the sanitized and validated value.
 	 */
 	final public function post_value( $default = null ) {
 		return $this->manager->post_value( $this, $default );
 	}
 	 * @since 3.4.0
 	 *
 	 * @return bool False if theme doesn't support the setting or user can't change setting, otherwise true.
 	 */
 	final public function check_capabilities() {
-		if ( $this->capability && ! call_user_func_array( 'current_user_can', (array) $this->capability ) ) {
+		if ( $this->capability && ! current_user_can( $this->capability ) ) {
 			return false;
 		}
-		if ( $this->theme_supports && ! call_user_func_array( 'current_theme_supports', (array) $this->theme_supports ) ) {
+		if ( $this->theme_supports && ! current_theme_supports( ... (array) $this->theme_supports ) ) {
 			return false;
 		}
 		return true;
 	}
 	/**
 	 * Multidimensional helper function.
 	 *
 	 * @since 3.4.0
 	 *
-	 * @param $root
+	 * @param array $root
-	 * @param $keys
+	 * @param array $keys
-	 * @param bool $create Default is false.
+	 * @param bool  $create Default false.
 	 * @return array|void Keys are 'root', 'node', and 'key'.
 	 */
 	final protected function multidimensional( &$root, $keys, $create = false ) {
 		if ( $create && empty( $root ) ) {
 			$root = array();
 			$node = &$node[ $key ];
 		}
 		if ( $create ) {
 			if ( ! is_array( $node ) ) {
-				// account for an array overriding a string or object value
+				// Account for an array overriding a string or object value.
 				$node = array();
 			}
 			if ( ! isset( $node[ $last ] ) ) {
 				$node[ $last ] = array();
 			}
 	/**
 	 * Will attempt to replace a specific value in a multidimensional array.
 	 *
 	 * @since 3.4.0
 	 *
-	 * @param $root
+	 * @param array $root
-	 * @param $keys
+	 * @param array $keys
 	 * @param mixed $value The value to update.
 	 * @return mixed
 	 */
 	final protected function multidimensional_replace( $root, $keys, $value ) {
 		if ( ! isset( $value ) ) {
 	/**
 	 * Will attempt to fetch a specific value from a multidimensional array.
 	 *
 	 * @since 3.4.0
 	 *
-	 * @param $root
+	 * @param array $root
-	 * @param $keys
+	 * @param array $keys
-	 * @param mixed $default A default value which is used as a fallback. Default is null.
+	 * @param mixed $default A default value which is used as a fallback. Default null.
 	 * @return mixed The requested value or the default value.
 	 */
 	final protected function multidimensional_get( $root, $keys, $default = null ) {
 		if ( empty( $keys ) ) { // If there are no keys, test the root.
 			return isset( $root ) ? $root : $default;
 	/**
 	 * Will attempt to check if a specific value in a multidimensional array is set.
 	 *
 	 * @since 3.4.0
 	 *
-	 * @param $root
+	 * @param array $root
-	 * @param $keys
+	 * @param array $keys
 	 * @return bool True if value is set, false if not.
 	 */
 	final protected function multidimensional_isset( $root, $keys ) {
 		$result = $this->multidimensional_get( $root, $keys );
 		return isset( $result );
 }
 /**
 * WP_Customize_Filter_Setting class.
 */
-require_once( ABSPATH . WPINC . '/customize/class-wp-customize-filter-setting.php' );
+require_once ABSPATH . WPINC . '/customize/class-wp-customize-filter-setting.php';
 /**
 * WP_Customize_Header_Image_Setting class.
 */
-require_once( ABSPATH . WPINC . '/customize/class-wp-customize-header-image-setting.php' );
+require_once ABSPATH . WPINC . '/customize/class-wp-customize-header-image-setting.php';
 /**
 * WP_Customize_Background_Image_Setting class.
 */
-require_once( ABSPATH . WPINC . '/customize/class-wp-customize-background-image-setting.php' );
+require_once ABSPATH . WPINC . '/customize/class-wp-customize-background-image-setting.php';
 /**
 * WP_Customize_Nav_Menu_Item_Setting class.
 */
-require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-item-setting.php' );
+require_once ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-item-setting.php';
 /**
 * WP_Customize_Nav_Menu_Setting class.
 */
-require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-setting.php' );
+require_once ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-setting.php';

changeset 16	a86126ab1dd4
parent 9	177826044cd9
child 18	be944660c56a