public $manager;
/**
+ * Unique string identifier for the setting.
+ *
* @access public
* @var string
*/
*
* @var callback
*/
+ public $validate_callback = '';
public $sanitize_callback = '';
public $sanitize_js_callback = '';
*/
public $dirty = false;
+ /**
+ * @var array
+ */
protected $id_data = array();
+ /**
+ * Whether or not preview() was called.
+ *
+ * @since 4.4.0
+ * @access protected
+ * @var bool
+ */
+ protected $is_previewed = false;
+
+ /**
+ * Cache of multidimensional values to improve performance.
+ *
+ * @since 4.4.0
+ * @access protected
+ * @var array
+ * @static
+ */
+ protected static $aggregated_multidimensionals = array();
+
+ /**
+ * Whether the multidimensional setting is aggregated.
+ *
+ * @since 4.4.0
+ * @access protected
+ * @var bool
+ */
+ protected $is_multidimensional_aggregated = false;
+
/**
* Constructor.
*
public function __construct( $manager, $id, $args = array() ) {
$keys = array_keys( get_object_vars( $this ) );
foreach ( $keys as $key ) {
- if ( isset( $args[ $key ] ) )
+ if ( isset( $args[ $key ] ) ) {
$this->$key = $args[ $key ];
+ }
}
$this->manager = $manager;
$this->id = $id;
// Parse the ID for array keys.
- $this->id_data[ 'keys' ] = preg_split( '/\[/', str_replace( ']', '', $this->id ) );
- $this->id_data[ 'base' ] = array_shift( $this->id_data[ 'keys' ] );
+ $this->id_data['keys'] = preg_split( '/\[/', str_replace( ']', '', $this->id ) );
+ $this->id_data['base'] = array_shift( $this->id_data['keys'] );
// Rebuild the ID.
$this->id = $this->id_data[ 'base' ];
- if ( ! empty( $this->id_data[ 'keys' ] ) )
- $this->id .= '[' . implode( '][', $this->id_data[ 'keys' ] ) . ']';
+ if ( ! empty( $this->id_data[ 'keys' ] ) ) {
+ $this->id .= '[' . implode( '][', $this->id_data['keys'] ) . ']';
+ }
- if ( $this->sanitize_callback )
+ if ( $this->validate_callback ) {
+ add_filter( "customize_validate_{$this->id}", $this->validate_callback, 10, 3 );
+ }
+ if ( $this->sanitize_callback ) {
add_filter( "customize_sanitize_{$this->id}", $this->sanitize_callback, 10, 2 );
-
- if ( $this->sanitize_js_callback )
+ }
+ if ( $this->sanitize_js_callback ) {
add_filter( "customize_sanitize_js_{$this->id}", $this->sanitize_js_callback, 10, 2 );
+ }
+
+ if ( 'option' === $this->type || 'theme_mod' === $this->type ) {
+ // Other setting types can opt-in to aggregate multidimensional explicitly.
+ $this->aggregate_multidimensional();
+
+ // Allow option settings to indicate whether they should be autoloaded.
+ if ( 'option' === $this->type && isset( $args['autoload'] ) ) {
+ self::$aggregated_multidimensionals[ $this->type ][ $this->id_data['base'] ]['autoload'] = $args['autoload'];
+ }
+ }
+ }
+
+ /**
+ * Get parsed ID data for multidimensional setting.
+ *
+ * @since 4.4.0
+ * @access public
+ *
+ * @return array {
+ * ID data for multidimensional setting.
+ *
+ * @type string $base ID base
+ * @type array $keys Keys for multidimensional array.
+ * }
+ */
+ final public function id_data() {
+ return $this->id_data;
+ }
+
+ /**
+ * Set up the setting for aggregated multidimensional values.
+ *
+ * When a multidimensional setting gets aggregated, all of its preview and update
+ * calls get combined into one call, greatly improving performance.
+ *
+ * @since 4.4.0
+ * @access protected
+ */
+ protected function aggregate_multidimensional() {
+ $id_base = $this->id_data['base'];
+ if ( ! isset( self::$aggregated_multidimensionals[ $this->type ] ) ) {
+ self::$aggregated_multidimensionals[ $this->type ] = array();
+ }
+ if ( ! isset( self::$aggregated_multidimensionals[ $this->type ][ $id_base ] ) ) {
+ self::$aggregated_multidimensionals[ $this->type ][ $id_base ] = array(
+ 'previewed_instances' => array(), // Calling preview() will add the $setting to the array.
+ 'preview_applied_instances' => array(), // Flags for which settings have had their values applied.
+ 'root_value' => $this->get_root_value( array() ), // Root value for initial state, manipulated by preview and update calls.
+ );
+ }
+
+ if ( ! empty( $this->id_data['keys'] ) ) {
+ // Note the preview-applied flag is cleared at priority 9 to ensure it is cleared before a deferred-preview runs.
+ add_action( "customize_post_value_set_{$this->id}", array( $this, '_clear_aggregated_multidimensional_preview_applied_flag' ), 9 );
+ $this->is_multidimensional_aggregated = true;
+ }
}
/**
- * The ID for the current blog when the preview() method was called.
+ * Reset `$aggregated_multidimensionals` static variable.
+ *
+ * This is intended only for use by unit tests.
+ *
+ * @since 4.5.0
+ * @access public
+ * @ignore
+ */
+ static public function reset_aggregated_multidimensionals() {
+ self::$aggregated_multidimensionals = array();
+ }
+
+ /**
+ * The ID for the current site when the preview() method was called.
*
* @since 4.2.0
* @access protected
protected $_previewed_blog_id;
/**
- * Return true if the current blog is not the same as the previewed blog.
+ * Return true if the current site is not the same as the previewed site.
*
* @since 4.2.0
* @access public
protected $_original_value;
/**
- * Handle previewing the setting.
+ * Add filters to supply the setting's value when accessed.
+ *
+ * If the setting already has a pre-existing value and there is no incoming
+ * post value for the setting, then this method will short-circuit since
+ * there is no change to preview.
*
* @since 3.4.0
+ * @since 4.4.0 Added boolean return value.
+ * @access public
+ *
+ * @return bool False when preview short-circuits due no change needing to be previewed.
*/
public function preview() {
- if ( ! isset( $this->_original_value ) ) {
- $this->_original_value = $this->value();
- }
if ( ! isset( $this->_previewed_blog_id ) ) {
$this->_previewed_blog_id = get_current_blog_id();
}
- switch( $this->type ) {
+ // Prevent re-previewing an already-previewed setting.
+ if ( $this->is_previewed ) {
+ return true;
+ }
+
+ $id_base = $this->id_data['base'];
+ $is_multidimensional = ! empty( $this->id_data['keys'] );
+ $multidimensional_filter = array( $this, '_multidimensional_preview_filter' );
+
+ /*
+ * Check if the setting has a pre-existing value (an isset check),
+ * and if doesn't have any incoming post value. If both checks are true,
+ * then the preview short-circuits because there is nothing that needs
+ * to be previewed.
+ */
+ $undefined = new stdClass();
+ $needs_preview = ( $undefined !== $this->post_value( $undefined ) );
+ $value = null;
+
+ // Since no post value was defined, check if we have an initial value set.
+ if ( ! $needs_preview ) {
+ if ( $this->is_multidimensional_aggregated ) {
+ $root = self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['root_value'];
+ $value = $this->multidimensional_get( $root, $this->id_data['keys'], $undefined );
+ } else {
+ $default = $this->default;
+ $this->default = $undefined; // Temporarily set default to undefined so we can detect if existing value is set.
+ $value = $this->value();
+ $this->default = $default;
+ }
+ $needs_preview = ( $undefined === $value ); // Because the default needs to be supplied.
+ }
+
+ // If the setting does not need previewing now, defer to when it has a value to preview.
+ if ( ! $needs_preview ) {
+ if ( ! has_action( "customize_post_value_set_{$this->id}", array( $this, 'preview' ) ) ) {
+ add_action( "customize_post_value_set_{$this->id}", array( $this, 'preview' ) );
+ }
+ return false;
+ }
+
+ switch ( $this->type ) {
case 'theme_mod' :
- add_filter( 'theme_mod_' . $this->id_data[ 'base' ], array( $this, '_preview_filter' ) );
+ if ( ! $is_multidimensional ) {
+ add_filter( "theme_mod_{$id_base}", array( $this, '_preview_filter' ) );
+ } else {
+ if ( empty( self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['previewed_instances'] ) ) {
+ // Only add this filter once for this ID base.
+ add_filter( "theme_mod_{$id_base}", $multidimensional_filter );
+ }
+ self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['previewed_instances'][ $this->id ] = $this;
+ }
break;
case 'option' :
- if ( empty( $this->id_data[ 'keys' ] ) )
- add_filter( 'pre_option_' . $this->id_data[ 'base' ], array( $this, '_preview_filter' ) );
- else {
- add_filter( 'option_' . $this->id_data[ 'base' ], array( $this, '_preview_filter' ) );
- add_filter( 'default_option_' . $this->id_data[ 'base' ], array( $this, '_preview_filter' ) );
+ if ( ! $is_multidimensional ) {
+ add_filter( "pre_option_{$id_base}", array( $this, '_preview_filter' ) );
+ } else {
+ if ( empty( self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['previewed_instances'] ) ) {
+ // Only add these filters once for this ID base.
+ add_filter( "option_{$id_base}", $multidimensional_filter );
+ add_filter( "default_option_{$id_base}", $multidimensional_filter );
+ }
+ self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['previewed_instances'][ $this->id ] = $this;
}
break;
default :
/**
- * Fires when the {@see WP_Customize_Setting::preview()} method is called for settings
+ * Fires when the WP_Customize_Setting::preview() method is called for settings
* not handled as theme_mods or options.
*
* The dynamic portion of the hook name, `$this->id`, refers to the setting ID.
*
* @since 3.4.0
*
- * @param WP_Customize_Setting $this {@see WP_Customize_Setting} instance.
+ * @param WP_Customize_Setting $this WP_Customize_Setting instance.
*/
do_action( "customize_preview_{$this->id}", $this );
/**
- * Fires when the {@see WP_Customize_Setting::preview()} method is called for settings
+ * Fires when the WP_Customize_Setting::preview() method is called for settings
* not handled as theme_mods or options.
*
* The dynamic portion of the hook name, `$this->type`, refers to the setting type.
*
* @since 4.1.0
*
- * @param WP_Customize_Setting $this {@see WP_Customize_Setting} instance.
+ * @param WP_Customize_Setting $this WP_Customize_Setting instance.
*/
do_action( "customize_preview_{$this->type}", $this );
}
+
+ $this->is_previewed = true;
+
+ return true;
}
/**
- * Callback function to filter the theme mods and options.
+ * Clear out the previewed-applied flag for a multidimensional-aggregated value whenever its post value is updated.
+ *
+ * This ensures that the new value will get sanitized and used the next time
+ * that `WP_Customize_Setting::_multidimensional_preview_filter()`
+ * is called for this setting.
+ *
+ * @since 4.4.0
+ * @access private
+ * @see WP_Customize_Manager::set_post_value()
+ * @see WP_Customize_Setting::_multidimensional_preview_filter()
+ */
+ final public function _clear_aggregated_multidimensional_preview_applied_flag() {
+ unset( self::$aggregated_multidimensionals[ $this->type ][ $this->id_data['base'] ]['preview_applied_instances'][ $this->id ] );
+ }
+
+ /**
+ * Callback function to filter non-multidimensional theme mods and options.
*
* If switch_to_blog() was called after the preview() method, and the current
- * blog is now not the same blog, then this method does a no-op and returns
+ * site is now not the same site, then this method does a no-op and returns
* the original value.
*
* @since 3.4.0
- * @uses WP_Customize_Setting::multidimensional_replace()
*
* @param mixed $original Old value.
* @return mixed New or old value.
return $original;
}
- $undefined = new stdClass(); // symbol hack
+ $undefined = new stdClass(); // Symbol hack.
$post_value = $this->post_value( $undefined );
- if ( $undefined === $post_value ) {
- $value = $this->_original_value;
- } else {
+ if ( $undefined !== $post_value ) {
$value = $post_value;
+ } else {
+ /*
+ * Note that we don't use $original here because preview() will
+ * not add the filter in the first place if it has an initial value
+ * and there is no post value.
+ */
+ $value = $this->default;
+ }
+ return $value;
+ }
+
+ /**
+ * Callback function to filter multidimensional theme mods and options.
+ *
+ * For all multidimensional settings of a given type, the preview filter for
+ * the first setting previewed will be used to apply the values for the others.
+ *
+ * @since 4.4.0
+ * @access private
+ *
+ * @see WP_Customize_Setting::$aggregated_multidimensionals
+ * @param mixed $original Original root value.
+ * @return mixed New or old value.
+ */
+ final public function _multidimensional_preview_filter( $original ) {
+ if ( ! $this->is_current_blog_previewed() ) {
+ return $original;
+ }
+
+ $id_base = $this->id_data['base'];
+
+ // If no settings have been previewed yet (which should not be the case, since $this is), just pass through the original value.
+ if ( empty( self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['previewed_instances'] ) ) {
+ return $original;
}
- return $this->multidimensional_replace( $original, $this->id_data['keys'], $value );
+ foreach ( self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['previewed_instances'] as $previewed_setting ) {
+ // Skip applying previewed value for any settings that have already been applied.
+ if ( ! empty( self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['preview_applied_instances'][ $previewed_setting->id ] ) ) {
+ continue;
+ }
+
+ // Do the replacements of the posted/default sub value into the root value.
+ $value = $previewed_setting->post_value( $previewed_setting->default );
+ $root = self::$aggregated_multidimensionals[ $previewed_setting->type ][ $id_base ]['root_value'];
+ $root = $previewed_setting->multidimensional_replace( $root, $previewed_setting->id_data['keys'], $value );
+ self::$aggregated_multidimensionals[ $previewed_setting->type ][ $id_base ]['root_value'] = $root;
+
+ // Mark this setting having been applied so that it will be skipped when the filter is called again.
+ self::$aggregated_multidimensionals[ $previewed_setting->type ][ $id_base ]['preview_applied_instances'][ $previewed_setting->id ] = true;
+ }
+
+ return self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['root_value'];
}
/**
- * Check user capabilities and theme supports, and then save
+ * 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.
+ * @access public
+ *
+ * @return false|void 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 ) )
+ if ( ! $this->check_capabilities() || ! isset( $value ) ) {
return false;
+ }
/**
* Fires when the WP_Customize_Setting::save() method is called.
*
* @since 3.4.0
*
- * @param WP_Customize_Setting $this {@see WP_Customize_Setting} instance.
+ * @param WP_Customize_Setting $this WP_Customize_Setting instance.
*/
- do_action( 'customize_save_' . $this->id_data[ 'base' ], $this );
+ do_action( 'customize_save_' . $this->id_data['base'], $this );
$this->update( $value );
}
/**
* Fetch and sanitize the $_POST value for the setting.
*
+ * 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.
- * @return mixed The default value on failure, otherwise the sanitized value.
+ * @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
*
- * @param string|array $value The value to sanitize.
- * @return string|array|null Null if an input isn't valid, otherwise the sanitized value.
+ * @param string|array $value The value to sanitize.
+ * @return string|array|null|WP_Error Sanitized value, or `null`/`WP_Error` if invalid.
*/
public function sanitize( $value ) {
- $value = wp_unslash( $value );
/**
- * Filter a Customize setting value in un-slashed form.
+ * Filters a Customize setting value in un-slashed form.
*
* @since 3.4.0
*
}
/**
- * Save the value of the setting, using the related API.
+ * Validates an input.
*
- * @since 3.4.0
+ * @since 4.6.0
+ * @access public
*
- * @param mixed $value The value to update.
- * @return mixed The result of saving the value.
+ * @see WP_REST_Request::has_valid_params()
+ *
+ * @param mixed $value Value to validate.
+ * @return true|WP_Error True if the input was validated, otherwise WP_Error.
*/
- protected function update( $value ) {
- switch( $this->type ) {
- case 'theme_mod' :
- return $this->_update_theme_mod( $value );
+ public function validate( $value ) {
+ if ( is_wp_error( $value ) ) {
+ return $value;
+ }
+ if ( is_null( $value ) ) {
+ return new WP_Error( 'invalid_value', __( 'Invalid value.' ) );
+ }
- case 'option' :
- return $this->_update_option( $value );
+ $validity = new WP_Error();
- default :
+ /**
+ * Validates a Customize setting value.
+ *
+ * Plugins should amend the `$validity` object via its `WP_Error::add()` method.
+ *
+ * The dynamic portion of the hook name, `$this->ID`, refers to the setting ID.
+ *
+ * @since 4.6.0
+ *
+ * @param WP_Error $validity Filtered from `true` to `WP_Error` when invalid.
+ * @param mixed $value Value of the setting.
+ * @param WP_Customize_Setting $this WP_Customize_Setting instance.
+ */
+ $validity = apply_filters( "customize_validate_{$this->id}", $validity, $value, $this );
- /**
- * Fires when the {@see WP_Customize_Setting::update()} method is called for settings
- * not handled as theme_mods or options.
- *
- * The dynamic portion of the hook name, `$this->type`, refers to the type of setting.
- *
- * @since 3.4.0
- *
- * @param mixed $value Value of the setting.
- * @param WP_Customize_Setting $this WP_Customize_Setting instance.
- */
- return do_action( 'customize_update_' . $this->type, $value, $this );
+ if ( is_wp_error( $validity ) && empty( $validity->errors ) ) {
+ $validity = true;
}
+ return $validity;
}
/**
- * Update the theme mod from the value of the parameter.
+ * Get the root value for a setting, especially for multidimensional ones.
*
- * @since 3.4.0
+ * @since 4.4.0
+ * @access protected
*
- * @param mixed $value The value to update.
+ * @param mixed $default Value to return if root does not exist.
+ * @return mixed
*/
- protected function _update_theme_mod( $value ) {
- // Handle non-array theme mod.
- if ( empty( $this->id_data[ 'keys' ] ) ) {
- set_theme_mod( $this->id_data[ 'base' ], $value );
- return;
+ protected function get_root_value( $default = null ) {
+ $id_base = $this->id_data['base'];
+ if ( 'option' === $this->type ) {
+ return get_option( $id_base, $default );
+ } else if ( 'theme_mod' ) {
+ return get_theme_mod( $id_base, $default );
+ } else {
+ /*
+ * Any WP_Customize_Setting subclass implementing aggregate multidimensional
+ * will need to override this method to obtain the data from the appropriate
+ * location.
+ */
+ return $default;
}
- // Handle array-based theme mod.
- $mods = get_theme_mod( $this->id_data[ 'base' ] );
- $mods = $this->multidimensional_replace( $mods, $this->id_data[ 'keys' ], $value );
- if ( isset( $mods ) ) {
- set_theme_mod( $this->id_data[ 'base' ], $mods );
+ }
+
+ /**
+ * Set the root value for a setting, especially for multidimensional ones.
+ *
+ * @since 4.4.0
+ * @access protected
+ *
+ * @param mixed $value Value to set as root of multidimensional setting.
+ * @return bool Whether the multidimensional root was updated successfully.
+ */
+ protected function set_root_value( $value ) {
+ $id_base = $this->id_data['base'];
+ if ( 'option' === $this->type ) {
+ $autoload = true;
+ if ( isset( self::$aggregated_multidimensionals[ $this->type ][ $this->id_data['base'] ]['autoload'] ) ) {
+ $autoload = self::$aggregated_multidimensionals[ $this->type ][ $this->id_data['base'] ]['autoload'];
+ }
+ return update_option( $id_base, $value, $autoload );
+ } else if ( 'theme_mod' ) {
+ set_theme_mod( $id_base, $value );
+ return true;
+ } else {
+ /*
+ * Any WP_Customize_Setting subclass implementing aggregate multidimensional
+ * will need to override this method to obtain the data from the appropriate
+ * location.
+ */
+ return false;
}
}
/**
- * Update the option from the value of the setting.
+ * Save the value of the setting, using the related API.
*
* @since 3.4.0
*
* @param mixed $value The value to update.
* @return bool The result of saving the value.
*/
- protected function _update_option( $value ) {
- // Handle non-array option.
- if ( empty( $this->id_data[ 'keys' ] ) )
- return update_option( $this->id_data[ 'base' ], $value );
-
- // Handle array-based options.
- $options = get_option( $this->id_data[ 'base' ] );
- $options = $this->multidimensional_replace( $options, $this->id_data[ 'keys' ], $value );
- if ( isset( $options ) )
- return update_option( $this->id_data[ 'base' ], $options );
+ protected function update( $value ) {
+ $id_base = $this->id_data['base'];
+ if ( 'option' === $this->type || 'theme_mod' === $this->type ) {
+ if ( ! $this->is_multidimensional_aggregated ) {
+ return $this->set_root_value( $value );
+ } else {
+ $root = self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['root_value'];
+ $root = $this->multidimensional_replace( $root, $this->id_data['keys'], $value );
+ self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['root_value'] = $root;
+ return $this->set_root_value( $root );
+ }
+ } else {
+ /**
+ * Fires when the WP_Customize_Setting::update() method is called for settings
+ * not handled as theme_mods or options.
+ *
+ * The dynamic portion of the hook name, `$this->type`, refers to the type of setting.
+ *
+ * @since 3.4.0
+ *
+ * @param mixed $value Value of the setting.
+ * @param WP_Customize_Setting $this WP_Customize_Setting instance.
+ */
+ do_action( "customize_update_{$this->type}", $value, $this );
+
+ return has_action( "customize_update_{$this->type}" );
+ }
+ }
+
+ /**
+ * Deprecated method.
+ *
+ * @since 3.4.0
+ * @deprecated 4.4.0 Deprecated in favor of update() method.
+ */
+ protected function _update_theme_mod() {
+ _deprecated_function( __METHOD__, '4.4.0', __CLASS__ . '::update()' );
+ }
+
+ /**
+ * Deprecated method.
+ *
+ * @since 3.4.0
+ * @deprecated 4.4.0 Deprecated in favor of update() method.
+ */
+ protected function _update_option() {
+ _deprecated_function( __METHOD__, '4.4.0', __CLASS__ . '::update()' );
}
/**
* @return mixed The value.
*/
public function value() {
- // Get the callback that corresponds to the setting type.
- switch( $this->type ) {
- case 'theme_mod' :
- $function = 'get_theme_mod';
- break;
- case 'option' :
- $function = 'get_option';
- break;
- default :
+ $id_base = $this->id_data['base'];
+ $is_core_type = ( 'option' === $this->type || 'theme_mod' === $this->type );
- /**
- * Filter a Customize setting value not handled as a theme_mod or option.
- *
- * The dynamic portion of the hook name, `$this->id_date['base']`, refers to
- * the base slug of the setting name.
- *
- * For settings handled as theme_mods or options, see those corresponding
- * functions for available hooks.
- *
- * @since 3.4.0
- *
- * @param mixed $default The setting default value. Default empty.
- */
- return apply_filters( 'customize_value_' . $this->id_data[ 'base' ], $this->default );
- }
+ if ( ! $is_core_type && ! $this->is_multidimensional_aggregated ) {
- // Handle non-array value
- if ( empty( $this->id_data[ 'keys' ] ) )
- return $function( $this->id_data[ 'base' ], $this->default );
+ // Use post value if previewed and a post value is present.
+ if ( $this->is_previewed ) {
+ $value = $this->post_value( null );
+ if ( null !== $value ) {
+ return $value;
+ }
+ }
- // Handle array-based value
- $values = $function( $this->id_data[ 'base' ] );
- return $this->multidimensional_get( $values, $this->id_data[ 'keys' ], $this->default );
+ $value = $this->get_root_value( $this->default );
+
+ /**
+ * Filters a Customize setting value not handled as a theme_mod or option.
+ *
+ * The dynamic portion of the hook name, `$id_base`, refers to
+ * the base slug of the setting name, initialized from `$this->id_data['base']`.
+ *
+ * For settings handled as theme_mods or options, see those corresponding
+ * functions for available hooks.
+ *
+ * @since 3.4.0
+ * @since 4.6.0 Added the `$this` setting instance as the second parameter.
+ *
+ * @param mixed $default The setting default value. Default empty.
+ * @param WP_Customize_Setting $this The setting instance.
+ */
+ $value = apply_filters( "customize_value_{$id_base}", $value, $this );
+ } elseif ( $this->is_multidimensional_aggregated ) {
+ $root_value = self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['root_value'];
+ $value = $this->multidimensional_get( $root_value, $this->id_data['keys'], $this->default );
+
+ // Ensure that the post value is used if the setting is previewed, since preview filters aren't applying on cached $root_value.
+ if ( $this->is_previewed ) {
+ $value = $this->post_value( $value );
+ }
+ } else {
+ $value = $this->get_root_value( $this->default );
+ }
+ return $value;
}
/**
public function js_value() {
/**
- * Filter a Customize setting value for use in JavaScript.
+ * Filters a Customize setting value for use in JavaScript.
*
* The dynamic portion of the hook name, `$this->id`, refers to the setting ID.
*
* @since 3.4.0
*
* @param mixed $value The setting value.
- * @param WP_Customize_Setting $this {@see WP_Customize_Setting} instance.
+ * @param WP_Customize_Setting $this WP_Customize_Setting instance.
*/
$value = apply_filters( "customize_sanitize_js_{$this->id}", $this->value(), $this );
return $value;
}
+ /**
+ * Retrieves the data to export to the client via JSON.
+ *
+ * @since 4.6.0
+ * @access public
+ *
+ * @return array Array of parameters passed to JavaScript.
+ */
+ public function json() {
+ return array(
+ 'value' => $this->js_value(),
+ 'transport' => $this->transport,
+ 'dirty' => $this->dirty,
+ 'type' => $this->type,
+ );
+ }
+
/**
* Validate user capabilities whether the theme supports the setting.
*
* @param $root
* @param $keys
* @param mixed $value The value to update.
- * @return
+ * @return mixed
*/
final protected function multidimensional_replace( $root, $keys, $value ) {
if ( ! isset( $value ) )
}
}
-/**
- * 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.
- *
- * @since 3.4.0
- *
- * @see WP_Customize_Setting
- */
-class WP_Customize_Filter_Setting extends WP_Customize_Setting {
-
- /**
- * @since 3.4.0
- */
- public function update( $value ) {}
-}
-
-/**
- * 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.
- *
- * @since 3.4.0
- *
- * @see WP_Customize_Setting
- */
-final class WP_Customize_Header_Image_Setting extends WP_Customize_Setting {
- public $id = 'header_image_data';
-
- /**
- * @since 3.4.0
- *
- * @global Custom_Image_Header $custom_image_header
- *
- * @param $value
- */
- public function update( $value ) {
- global $custom_image_header;
-
- // If the value doesn't exist (removed or random),
- // use the header_image value.
- if ( ! $value )
- $value = $this->manager->get_setting('header_image')->post_value();
-
- if ( is_array( $value ) && isset( $value['choice'] ) )
- $custom_image_header->set_header_image( $value['choice'] );
- else
- $custom_image_header->set_header_image( $value );
- }
-}
-
-/**
- * Customizer Background Image Setting class.
- *
- * @since 3.4.0
- *
- * @see WP_Customize_Setting
- */
-final class WP_Customize_Background_Image_Setting extends WP_Customize_Setting {
- public $id = 'background_image_thumb';
-
- /**
- * @since 3.4.0
- *
- * @param $value
- */
- public function update( $value ) {
- remove_theme_mod( 'background_image_thumb' );
- }
-}
-
-/**
- * Customize Setting to represent a nav_menu.
- *
- * Subclass of WP_Customize_Setting to represent a nav_menu taxonomy term, and
- * the IDs for the nav_menu_items associated with the nav menu.
- *
- * @since 4.3.0
- *
- * @see WP_Customize_Setting
- */
-class WP_Customize_Nav_Menu_Item_Setting extends WP_Customize_Setting {
+/** WP_Customize_Filter_Setting class */
+require_once( ABSPATH . WPINC . '/customize/class-wp-customize-filter-setting.php' );
- const ID_PATTERN = '/^nav_menu_item\[(?P<id>-?\d+)\]$/';
+/** WP_Customize_Header_Image_Setting class */
+require_once( ABSPATH . WPINC . '/customize/class-wp-customize-header-image-setting.php' );
- const POST_TYPE = 'nav_menu_item';
+/** WP_Customize_Background_Image_Setting class */
+require_once( ABSPATH . WPINC . '/customize/class-wp-customize-background-image-setting.php' );
- const TYPE = 'nav_menu_item';
+/** WP_Customize_Nav_Menu_Item_Setting class */
+require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-item-setting.php' );
- /**
- * Setting type.
- *
- * @since 4.3.0
- * @access public
- * @var string
- */
- public $type = self::TYPE;
-
- /**
- * Default setting value.
- *
- * @since 4.3.0
- * @access public
- * @var array
- *
- * @see wp_setup_nav_menu_item()
- */
- public $default = array(
- // The $menu_item_data for wp_update_nav_menu_item().
- 'object_id' => 0,
- 'object' => '', // Taxonomy name.
- 'menu_item_parent' => 0, // A.K.A. menu-item-parent-id; note that post_parent is different, and not included.
- 'position' => 0, // A.K.A. menu_order.
- 'type' => 'custom', // Note that type_label is not included here.
- 'title' => '',
- 'url' => '',
- 'target' => '',
- 'attr_title' => '',
- 'description' => '',
- 'classes' => '',
- 'xfn' => '',
- 'status' => 'publish',
- 'original_title' => '',
- 'nav_menu_term_id' => 0, // This will be supplied as the $menu_id arg for wp_update_nav_menu_item().
- // @todo also expose invalid?
- );
-
- /**
- * Default transport.
- *
- * @since 4.3.0
- * @access public
- * @var string
- */
- public $transport = 'postMessage';
-
- /**
- * The post ID represented by this setting instance. This is the db_id.
- *
- * A negative value represents a placeholder ID for a new menu not yet saved.
- *
- * @since 4.3.0
- * @access public
- * @var int
- */
- public $post_id;
-
- /**
- * Storage of pre-setup menu item to prevent wasted calls to wp_setup_nav_menu_item().
- *
- * @since 4.3.0
- * @access protected
- * @var array
- */
- protected $value;
-
- /**
- * Previous (placeholder) post ID used before creating a new menu item.
- *
- * This value will be exported to JS via the customize_save_response filter
- * so that JavaScript can update the settings to refer to the newly-assigned
- * post ID. This value is always negative to indicate it does not refer to
- * a real post.
- *
- * @since 4.3.0
- * @access public
- * @var int
- *
- * @see WP_Customize_Nav_Menu_Item_Setting::update()
- * @see WP_Customize_Nav_Menu_Item_Setting::amend_customize_save_response()
- */
- public $previous_post_id;
-
- /**
- * When previewing or updating a menu item, this stores the previous nav_menu_term_id
- * which ensures that we can apply the proper filters.
- *
- * @since 4.3.0
- * @access public
- * @var int
- */
- public $original_nav_menu_term_id;
-
- /**
- * Whether or not preview() was called.
- *
- * @since 4.3.0
- * @access protected
- * @var bool
- */
- protected $is_previewed = false;
-
- /**
- * Whether or not update() was called.
- *
- * @since 4.3.0
- * @access protected
- * @var bool
- */
- protected $is_updated = false;
-
- /**
- * Status for calling the update method, used in customize_save_response filter.
- *
- * When status is inserted, the placeholder post ID is stored in $previous_post_id.
- * When status is error, the error is stored in $update_error.
- *
- * @since 4.3.0
- * @access public
- * @var string updated|inserted|deleted|error
- *
- * @see WP_Customize_Nav_Menu_Item_Setting::update()
- * @see WP_Customize_Nav_Menu_Item_Setting::amend_customize_save_response()
- */
- public $update_status;
-
- /**
- * Any error object returned by wp_update_nav_menu_item() when setting is updated.
- *
- * @since 4.3.0
- * @access public
- * @var WP_Error
- *
- * @see WP_Customize_Nav_Menu_Item_Setting::update()
- * @see WP_Customize_Nav_Menu_Item_Setting::amend_customize_save_response()
- */
- public $update_error;
-
- /**
- * Constructor.
- *
- * Any supplied $args override class property defaults.
- *
- * @since 4.3.0
- * @access public
- *
- * @param WP_Customize_Manager $manager Bootstrap Customizer instance.
- * @param string $id An specific ID of the setting. Can be a
- * theme mod or option name.
- * @param array $args Optional. Setting arguments.
- *
- * @throws Exception If $id is not valid for this setting type.
- */
- public function __construct( WP_Customize_Manager $manager, $id, array $args = array() ) {
- if ( empty( $manager->nav_menus ) ) {
- throw new Exception( 'Expected WP_Customize_Manager::$nav_menus to be set.' );
- }
-
- if ( ! preg_match( self::ID_PATTERN, $id, $matches ) ) {
- throw new Exception( "Illegal widget setting ID: $id" );
- }
-
- $this->post_id = intval( $matches['id'] );
- add_action( 'wp_update_nav_menu_item', array( $this, 'flush_cached_value' ), 10, 2 );
-
- parent::__construct( $manager, $id, $args );
-
- // Ensure that an initially-supplied value is valid.
- if ( isset( $this->value ) ) {
- $this->populate_value();
- foreach ( array_diff( array_keys( $this->default ), array_keys( $this->value ) ) as $missing ) {
- throw new Exception( "Supplied nav_menu_item value missing property: $missing" );
- }
- }
-
- }
-
- /**
- * Clear the cached value when this nav menu item is updated.
- *
- * @since 4.3.0
- * @access public
- *
- * @param int $menu_id The term ID for the menu.
- * @param int $menu_item_id The post ID for the menu item.
- */
- public function flush_cached_value( $menu_id, $menu_item_id ) {
- unset( $menu_id );
- if ( $menu_item_id === $this->post_id ) {
- $this->value = null;
- }
- }
-
- /**
- * Get the instance data for a given widget setting.
- *
- * @since 4.3.0
- * @access public
- *
- * @see wp_setup_nav_menu_item()
- *
- * @return array|false Instance data array, or false if the item is marked for deletion.
- */
- public function value() {
- if ( $this->is_previewed && $this->_previewed_blog_id === get_current_blog_id() ) {
- $undefined = new stdClass(); // Symbol.
- $post_value = $this->post_value( $undefined );
-
- if ( $undefined === $post_value ) {
- $value = $this->_original_value;
- } else {
- $value = $post_value;
- }
- } else if ( isset( $this->value ) ) {
- $value = $this->value;
- } else {
- $value = false;
-
- // Note that a ID of less than one indicates a nav_menu not yet inserted.
- if ( $this->post_id > 0 ) {
- $post = get_post( $this->post_id );
- if ( $post && self::POST_TYPE === $post->post_type ) {
- $value = (array) wp_setup_nav_menu_item( $post );
- }
- }
-
- if ( ! is_array( $value ) ) {
- $value = $this->default;
- }
-
- // Cache the value for future calls to avoid having to re-call wp_setup_nav_menu_item().
- $this->value = $value;
- $this->populate_value();
- $value = $this->value;
- }
-
- return $value;
- }
-
- /**
- * Ensure that the value is fully populated with the necessary properties.
- *
- * Translates some properties added by wp_setup_nav_menu_item() and removes others.
- *
- * @since 4.3.0
- * @access protected
- *
- * @see WP_Customize_Nav_Menu_Item_Setting::value()
- */
- protected function populate_value() {
- if ( ! is_array( $this->value ) ) {
- return;
- }
-
- if ( isset( $this->value['menu_order'] ) ) {
- $this->value['position'] = $this->value['menu_order'];
- unset( $this->value['menu_order'] );
- }
- if ( isset( $this->value['post_status'] ) ) {
- $this->value['status'] = $this->value['post_status'];
- unset( $this->value['post_status'] );
- }
-
- if ( ! isset( $this->value['original_title'] ) ) {
- $original_title = '';
- if ( 'post_type' === $this->value['type'] ) {
- $original_title = get_the_title( $this->value['object_id'] );
- } elseif ( 'taxonomy' === $this->value['type'] ) {
- $original_title = get_term_field( 'name', $this->value['object_id'], $this->value['object'], 'raw' );
- if ( is_wp_error( $original_title ) ) {
- $original_title = '';
- }
- }
- $this->value['original_title'] = html_entity_decode( $original_title, ENT_QUOTES, get_bloginfo( 'charset' ) );
- }
-
- if ( ! isset( $this->value['nav_menu_term_id'] ) && $this->post_id > 0 ) {
- $menus = wp_get_post_terms( $this->post_id, WP_Customize_Nav_Menu_Setting::TAXONOMY, array(
- 'fields' => 'ids',
- ) );
- if ( ! empty( $menus ) ) {
- $this->value['nav_menu_term_id'] = array_shift( $menus );
- } else {
- $this->value['nav_menu_term_id'] = 0;
- }
- }
-
- foreach ( array( 'object_id', 'menu_item_parent', 'nav_menu_term_id' ) as $key ) {
- if ( ! is_int( $this->value[ $key ] ) ) {
- $this->value[ $key ] = intval( $this->value[ $key ] );
- }
- }
-
- // Remove remaining properties available on a setup nav_menu_item post object which aren't relevant to the setting value.
- $irrelevant_properties = array(
- 'ID',
- 'comment_count',
- 'comment_status',
- 'db_id',
- 'filter',
- 'guid',
- 'ping_status',
- 'pinged',
- 'post_author',
- 'post_content',
- 'post_content_filtered',
- 'post_date',
- 'post_date_gmt',
- 'post_excerpt',
- 'post_mime_type',
- 'post_modified',
- 'post_modified_gmt',
- 'post_name',
- 'post_parent',
- 'post_password',
- 'post_title',
- 'post_type',
- 'to_ping',
- );
- foreach ( $irrelevant_properties as $property ) {
- unset( $this->value[ $property ] );
- }
- }
-
- /**
- * Handle previewing the setting.
- *
- * @since 4.3.0
- * @access public
- *
- * @see WP_Customize_Manager::post_value()
- */
- public function preview() {
- if ( $this->is_previewed ) {
- return;
- }
-
- $this->is_previewed = true;
- $this->_original_value = $this->value();
- $this->original_nav_menu_term_id = $this->_original_value['nav_menu_term_id'];
- $this->_previewed_blog_id = get_current_blog_id();
-
- add_filter( 'wp_get_nav_menu_items', array( $this, 'filter_wp_get_nav_menu_items' ), 10, 3 );
-
- $sort_callback = array( __CLASS__, 'sort_wp_get_nav_menu_items' );
- if ( ! has_filter( 'wp_get_nav_menu_items', $sort_callback ) ) {
- add_filter( 'wp_get_nav_menu_items', array( __CLASS__, 'sort_wp_get_nav_menu_items' ), 1000, 3 );
- }
-
- // @todo Add get_post_metadata filters for plugins to add their data.
- }
-
- /**
- * Filter the wp_get_nav_menu_items() result to supply the previewed menu items.
- *
- * @since 4.3.0
- * @access public
- *
- * @see wp_get_nav_menu_items()
- *
- * @param array $items An array of menu item post objects.
- * @param object $menu The menu object.
- * @param array $args An array of arguments used to retrieve menu item objects.
- * @return array Array of menu items,
- */
- public function filter_wp_get_nav_menu_items( $items, $menu, $args ) {
- $this_item = $this->value();
- $current_nav_menu_term_id = $this_item['nav_menu_term_id'];
- unset( $this_item['nav_menu_term_id'] );
-
- $should_filter = (
- $menu->term_id === $this->original_nav_menu_term_id
- ||
- $menu->term_id === $current_nav_menu_term_id
- );
- if ( ! $should_filter ) {
- return $items;
- }
-
- // Handle deleted menu item, or menu item moved to another menu.
- $should_remove = (
- false === $this_item
- ||
- (
- $this->original_nav_menu_term_id === $menu->term_id
- &&
- $current_nav_menu_term_id !== $this->original_nav_menu_term_id
- )
- );
- if ( $should_remove ) {
- $filtered_items = array();
- foreach ( $items as $item ) {
- if ( $item->db_id !== $this->post_id ) {
- $filtered_items[] = $item;
- }
- }
- return $filtered_items;
- }
-
- $mutated = false;
- $should_update = (
- is_array( $this_item )
- &&
- $current_nav_menu_term_id === $menu->term_id
- );
- if ( $should_update ) {
- foreach ( $items as $item ) {
- if ( $item->db_id === $this->post_id ) {
- foreach ( get_object_vars( $this->value_as_wp_post_nav_menu_item() ) as $key => $value ) {
- $item->$key = $value;
- }
- $mutated = true;
- }
- }
-
- // Not found so we have to append it..
- if ( ! $mutated ) {
- $items[] = $this->value_as_wp_post_nav_menu_item();
- }
- }
-
- return $items;
- }
-
- /**
- * Re-apply the tail logic also applied on $items by wp_get_nav_menu_items().
- *
- * @since 4.3.0
- * @access public
- * @static
- *
- * @see wp_get_nav_menu_items()
- *
- * @param array $items An array of menu item post objects.
- * @param object $menu The menu object.
- * @param array $args An array of arguments used to retrieve menu item objects.
- * @return array Array of menu items,
- */
- public static function sort_wp_get_nav_menu_items( $items, $menu, $args ) {
- // @todo We should probably re-apply some constraints imposed by $args.
- unset( $args['include'] );
-
- // Remove invalid items only in frontend.
- if ( ! is_admin() ) {
- $items = array_filter( $items, '_is_valid_nav_menu_item' );
- }
-
- if ( ARRAY_A === $args['output'] ) {
- $GLOBALS['_menu_item_sort_prop'] = $args['output_key'];
- usort( $items, '_sort_nav_menu_items' );
- $i = 1;
-
- foreach ( $items as $k => $item ) {
- $items[ $k ]->{$args['output_key']} = $i++;
- }
- }
-
- return $items;
- }
-
- /**
- * Get the value emulated into a WP_Post and set up as a nav_menu_item.
- *
- * @since 4.3.0
- * @access public
- *
- * @return WP_Post With wp_setup_nav_menu_item() applied.
- */
- public function value_as_wp_post_nav_menu_item() {
- $item = (object) $this->value();
- unset( $item->nav_menu_term_id );
-
- $item->post_status = $item->status;
- unset( $item->status );
-
- $item->post_type = 'nav_menu_item';
- $item->menu_order = $item->position;
- unset( $item->position );
-
- if ( $item->title ) {
- $item->post_title = $item->title;
- }
-
- $item->ID = $this->post_id;
- $item->db_id = $this->post_id;
- $post = new WP_Post( (object) $item );
-
- if ( empty( $post->post_author ) ) {
- $post->post_author = get_current_user_id();
- }
-
- if ( ! isset( $post->type_label ) ) {
- if ( 'post_type' === $post->type ) {
- $object = get_post_type_object( $post->object );
- if ( $object ) {
- $post->type_label = $object->labels->singular_name;
- } else {
- $post->type_label = $post->object;
- }
- } elseif ( 'taxonomy' == $post->type ) {
- $object = get_taxonomy( $post->object );
- if ( $object ) {
- $post->type_label = $object->labels->singular_name;
- } else {
- $post->type_label = $post->object;
- }
- } else {
- $post->type_label = __( 'Custom Link' );
- }
- }
-
- return $post;
- }
-
- /**
- * Sanitize an input.
- *
- * Note that parent::sanitize() erroneously does wp_unslash() on $value, but
- * we remove that in this override.
- *
- * @since 4.3.0
- * @access public
- *
- * @param array $menu_item_value The value to sanitize.
- * @return array|false|null Null if an input isn't valid. False if it is marked for deletion.
- * Otherwise the sanitized value.
- */
- public function sanitize( $menu_item_value ) {
- // Menu is marked for deletion.
- if ( false === $menu_item_value ) {
- return $menu_item_value;
- }
-
- // Invalid.
- if ( ! is_array( $menu_item_value ) ) {
- return null;
- }
-
- $default = array(
- 'object_id' => 0,
- 'object' => '',
- 'menu_item_parent' => 0,
- 'position' => 0,
- 'type' => 'custom',
- 'title' => '',
- 'url' => '',
- 'target' => '',
- 'attr_title' => '',
- 'description' => '',
- 'classes' => '',
- 'xfn' => '',
- 'status' => 'publish',
- 'original_title' => '',
- 'nav_menu_term_id' => 0,
- );
- $menu_item_value = array_merge( $default, $menu_item_value );
- $menu_item_value = wp_array_slice_assoc( $menu_item_value, array_keys( $default ) );
- $menu_item_value['position'] = max( 0, intval( $menu_item_value['position'] ) );
-
- foreach ( array( 'object_id', 'menu_item_parent', 'nav_menu_term_id' ) as $key ) {
- // Note we need to allow negative-integer IDs for previewed objects not inserted yet.
- $menu_item_value[ $key ] = intval( $menu_item_value[ $key ] );
- }
-
- foreach ( array( 'type', 'object', 'target' ) as $key ) {
- $menu_item_value[ $key ] = sanitize_key( $menu_item_value[ $key ] );
- }
-
- foreach ( array( 'xfn', 'classes' ) as $key ) {
- $value = $menu_item_value[ $key ];
- if ( ! is_array( $value ) ) {
- $value = explode( ' ', $value );
- }
- $menu_item_value[ $key ] = implode( ' ', array_map( 'sanitize_html_class', $value ) );
- }
-
- foreach ( array( 'title', 'attr_title', 'description', 'original_title' ) as $key ) {
- // @todo Should esc_attr() the attr_title as well?
- $menu_item_value[ $key ] = sanitize_text_field( $menu_item_value[ $key ] );
- }
-
- $menu_item_value['url'] = esc_url_raw( $menu_item_value['url'] );
- if ( ! get_post_status_object( $menu_item_value['status'] ) ) {
- $menu_item_value['status'] = 'publish';
- }
-
- /** This filter is documented in wp-includes/class-wp-customize-setting.php */
- return apply_filters( "customize_sanitize_{$this->id}", $menu_item_value, $this );
- }
-
- /**
- * Create/update the nav_menu_item post for this setting.
- *
- * Any created menu items will have their assigned post IDs exported to the client
- * via the customize_save_response filter. Likewise, any errors will be exported
- * to the client via the customize_save_response() filter.
- *
- * To delete a menu, the client can send false as the value.
- *
- * @since 4.3.0
- * @access protected
- *
- * @see wp_update_nav_menu_item()
- *
- * @param array|false $value The menu item array to update. If false, then the menu item will be deleted
- * entirely. See WP_Customize_Nav_Menu_Item_Setting::$default for what the value
- * should consist of.
- * @return null|void
- */
- protected function update( $value ) {
- if ( $this->is_updated ) {
- return;
- }
-
- $this->is_updated = true;
- $is_placeholder = ( $this->post_id < 0 );
- $is_delete = ( false === $value );
-
- // Update the cached value.
- $this->value = $value;
-
- add_filter( 'customize_save_response', array( $this, 'amend_customize_save_response' ) );
-
- if ( $is_delete ) {
- // If the current setting post is a placeholder, a delete request is a no-op.
- if ( $is_placeholder ) {
- $this->update_status = 'deleted';
- } else {
- $r = wp_delete_post( $this->post_id, true );
-
- if ( false === $r ) {
- $this->update_error = new WP_Error( 'delete_failure' );
- $this->update_status = 'error';
- } else {
- $this->update_status = 'deleted';
- }
- // @todo send back the IDs for all associated nav menu items deleted, so these settings (and controls) can be removed from Customizer?
- }
- } else {
-
- // Handle saving menu items for menus that are being newly-created.
- if ( $value['nav_menu_term_id'] < 0 ) {
- $nav_menu_setting_id = sprintf( 'nav_menu[%s]', $value['nav_menu_term_id'] );
- $nav_menu_setting = $this->manager->get_setting( $nav_menu_setting_id );
-
- if ( ! $nav_menu_setting || ! ( $nav_menu_setting instanceof WP_Customize_Nav_Menu_Setting ) ) {
- $this->update_status = 'error';
- $this->update_error = new WP_Error( 'unexpected_nav_menu_setting' );
- return;
- }
-
- if ( false === $nav_menu_setting->save() ) {
- $this->update_status = 'error';
- $this->update_error = new WP_Error( 'nav_menu_setting_failure' );
- return;
- }
-
- if ( $nav_menu_setting->previous_term_id !== intval( $value['nav_menu_term_id'] ) ) {
- $this->update_status = 'error';
- $this->update_error = new WP_Error( 'unexpected_previous_term_id' );
- return;
- }
-
- $value['nav_menu_term_id'] = $nav_menu_setting->term_id;
- }
-
- // Handle saving a nav menu item that is a child of a nav menu item being newly-created.
- if ( $value['menu_item_parent'] < 0 ) {
- $parent_nav_menu_item_setting_id = sprintf( 'nav_menu_item[%s]', $value['menu_item_parent'] );
- $parent_nav_menu_item_setting = $this->manager->get_setting( $parent_nav_menu_item_setting_id );
-
- if ( ! $parent_nav_menu_item_setting || ! ( $parent_nav_menu_item_setting instanceof WP_Customize_Nav_Menu_Item_Setting ) ) {
- $this->update_status = 'error';
- $this->update_error = new WP_Error( 'unexpected_nav_menu_item_setting' );
- return;
- }
-
- if ( false === $parent_nav_menu_item_setting->save() ) {
- $this->update_status = 'error';
- $this->update_error = new WP_Error( 'nav_menu_item_setting_failure' );
- return;
- }
-
- if ( $parent_nav_menu_item_setting->previous_post_id !== intval( $value['menu_item_parent'] ) ) {
- $this->update_status = 'error';
- $this->update_error = new WP_Error( 'unexpected_previous_post_id' );
- return;
- }
-
- $value['menu_item_parent'] = $parent_nav_menu_item_setting->post_id;
- }
-
- // Insert or update menu.
- $menu_item_data = array(
- 'menu-item-object-id' => $value['object_id'],
- 'menu-item-object' => $value['object'],
- 'menu-item-parent-id' => $value['menu_item_parent'],
- 'menu-item-position' => $value['position'],
- 'menu-item-type' => $value['type'],
- 'menu-item-title' => $value['title'],
- 'menu-item-url' => $value['url'],
- 'menu-item-description' => $value['description'],
- 'menu-item-attr-title' => $value['attr_title'],
- 'menu-item-target' => $value['target'],
- 'menu-item-classes' => $value['classes'],
- 'menu-item-xfn' => $value['xfn'],
- 'menu-item-status' => $value['status'],
- );
-
- $r = wp_update_nav_menu_item(
- $value['nav_menu_term_id'],
- $is_placeholder ? 0 : $this->post_id,
- $menu_item_data
- );
-
- if ( is_wp_error( $r ) ) {
- $this->update_status = 'error';
- $this->update_error = $r;
- } else {
- if ( $is_placeholder ) {
- $this->previous_post_id = $this->post_id;
- $this->post_id = $r;
- $this->update_status = 'inserted';
- } else {
- $this->update_status = 'updated';
- }
- }
- }
-
- }
-
- /**
- * Export data for the JS client.
- *
- * @since 4.3.0
- * @access public
- *
- * @see WP_Customize_Nav_Menu_Item_Setting::update()
- *
- * @param array $data Additional information passed back to the 'saved' event on `wp.customize`.
- * @return array Save response data.
- */
- public function amend_customize_save_response( $data ) {
- if ( ! isset( $data['nav_menu_item_updates'] ) ) {
- $data['nav_menu_item_updates'] = array();
- }
-
- $data['nav_menu_item_updates'][] = array(
- 'post_id' => $this->post_id,
- 'previous_post_id' => $this->previous_post_id,
- 'error' => $this->update_error ? $this->update_error->get_error_code() : null,
- 'status' => $this->update_status,
- );
- return $data;
- }
-}
-
-/**
- * Customize Setting to represent a nav_menu.
- *
- * Subclass of WP_Customize_Setting to represent a nav_menu taxonomy term, and
- * the IDs for the nav_menu_items associated with the nav menu.
- *
- * @since 4.3.0
- *
- * @see wp_get_nav_menu_object()
- * @see WP_Customize_Setting
- */
-class WP_Customize_Nav_Menu_Setting extends WP_Customize_Setting {
-
- const ID_PATTERN = '/^nav_menu\[(?P<id>-?\d+)\]$/';
-
- const TAXONOMY = 'nav_menu';
-
- const TYPE = 'nav_menu';
-
- /**
- * Setting type.
- *
- * @since 4.3.0
- * @access public
- * @var string
- */
- public $type = self::TYPE;
-
- /**
- * Default setting value.
- *
- * @since 4.3.0
- * @access public
- * @var array
- *
- * @see wp_get_nav_menu_object()
- */
- public $default = array(
- 'name' => '',
- 'description' => '',
- 'parent' => 0,
- 'auto_add' => false,
- );
-
- /**
- * Default transport.
- *
- * @since 4.3.0
- * @access public
- * @var string
- */
- public $transport = 'postMessage';
-
- /**
- * The term ID represented by this setting instance.
- *
- * A negative value represents a placeholder ID for a new menu not yet saved.
- *
- * @since 4.3.0
- * @access public
- * @var int
- */
- public $term_id;
-
- /**
- * Previous (placeholder) term ID used before creating a new menu.
- *
- * This value will be exported to JS via the customize_save_response filter
- * so that JavaScript can update the settings to refer to the newly-assigned
- * term ID. This value is always negative to indicate it does not refer to
- * a real term.
- *
- * @since 4.3.0
- * @access public
- * @var int
- *
- * @see WP_Customize_Nav_Menu_Setting::update()
- * @see WP_Customize_Nav_Menu_Setting::amend_customize_save_response()
- */
- public $previous_term_id;
-
- /**
- * Whether or not preview() was called.
- *
- * @since 4.3.0
- * @access protected
- * @var bool
- */
- protected $is_previewed = false;
-
- /**
- * Whether or not update() was called.
- *
- * @since 4.3.0
- * @access protected
- * @var bool
- */
- protected $is_updated = false;
-
- /**
- * Status for calling the update method, used in customize_save_response filter.
- *
- * When status is inserted, the placeholder term ID is stored in $previous_term_id.
- * When status is error, the error is stored in $update_error.
- *
- * @since 4.3.0
- * @access public
- * @var string updated|inserted|deleted|error
- *
- * @see WP_Customize_Nav_Menu_Setting::update()
- * @see WP_Customize_Nav_Menu_Setting::amend_customize_save_response()
- */
- public $update_status;
-
- /**
- * Any error object returned by wp_update_nav_menu_object() when setting is updated.
- *
- * @since 4.3.0
- * @access public
- * @var WP_Error
- *
- * @see WP_Customize_Nav_Menu_Setting::update()
- * @see WP_Customize_Nav_Menu_Setting::amend_customize_save_response()
- */
- public $update_error;
-
- /**
- * Constructor.
- *
- * Any supplied $args override class property defaults.
- *
- * @since 4.3.0
- * @access public
- *
- * @param WP_Customize_Manager $manager Bootstrap Customizer instance.
- * @param string $id An specific ID of the setting. Can be a
- * theme mod or option name.
- * @param array $args Optional. Setting arguments.
- *
- * @throws Exception If $id is not valid for this setting type.
- */
- public function __construct( WP_Customize_Manager $manager, $id, array $args = array() ) {
- if ( empty( $manager->nav_menus ) ) {
- throw new Exception( 'Expected WP_Customize_Manager::$nav_menus to be set.' );
- }
-
- if ( ! preg_match( self::ID_PATTERN, $id, $matches ) ) {
- throw new Exception( "Illegal widget setting ID: $id" );
- }
-
- $this->term_id = intval( $matches['id'] );
-
- parent::__construct( $manager, $id, $args );
- }
-
- /**
- * Get the instance data for a given widget setting.
- *
- * @since 4.3.0
- * @access public
- *
- * @see wp_get_nav_menu_object()
- *
- * @return array Instance data.
- */
- public function value() {
- if ( $this->is_previewed && $this->_previewed_blog_id === get_current_blog_id() ) {
- $undefined = new stdClass(); // Symbol.
- $post_value = $this->post_value( $undefined );
-
- if ( $undefined === $post_value ) {
- $value = $this->_original_value;
- } else {
- $value = $post_value;
- }
- } else {
- $value = false;
-
- // Note that a term_id of less than one indicates a nav_menu not yet inserted.
- if ( $this->term_id > 0 ) {
- $term = wp_get_nav_menu_object( $this->term_id );
-
- if ( $term ) {
- $value = wp_array_slice_assoc( (array) $term, array_keys( $this->default ) );
-
- $nav_menu_options = (array) get_option( 'nav_menu_options', array() );
- $value['auto_add'] = false;
-
- if ( isset( $nav_menu_options['auto_add'] ) && is_array( $nav_menu_options['auto_add'] ) ) {
- $value['auto_add'] = in_array( $term->term_id, $nav_menu_options['auto_add'] );
- }
- }
- }
-
- if ( ! is_array( $value ) ) {
- $value = $this->default;
- }
- }
- return $value;
- }
-
- /**
- * Handle previewing the setting.
- *
- * @since 4.3.0
- * @access public
- *
- * @see WP_Customize_Manager::post_value()
- */
- public function preview() {
- if ( $this->is_previewed ) {
- return;
- }
-
- $this->is_previewed = true;
- $this->_original_value = $this->value();
- $this->_previewed_blog_id = get_current_blog_id();
-
- add_filter( 'wp_get_nav_menus', array( $this, 'filter_wp_get_nav_menus' ), 10, 2 );
- add_filter( 'wp_get_nav_menu_object', array( $this, 'filter_wp_get_nav_menu_object' ), 10, 2 );
- add_filter( 'default_option_nav_menu_options', array( $this, 'filter_nav_menu_options' ) );
- add_filter( 'option_nav_menu_options', array( $this, 'filter_nav_menu_options' ) );
- }
-
- /**
- * Filter the wp_get_nav_menus() result to ensure the inserted menu object is included, and the deleted one is removed.
- *
- * @since 4.3.0
- * @access public
- *
- * @see wp_get_nav_menus()
- *
- * @param array $menus An array of menu objects.
- * @param array $args An array of arguments used to retrieve menu objects.
- * @return array
- */
- public function filter_wp_get_nav_menus( $menus, $args ) {
- if ( get_current_blog_id() !== $this->_previewed_blog_id ) {
- return $menus;
- }
-
- $setting_value = $this->value();
- $is_delete = ( false === $setting_value );
- $index = -1;
-
- // Find the existing menu item's position in the list.
- foreach ( $menus as $i => $menu ) {
- if ( (int) $this->term_id === (int) $menu->term_id || (int) $this->previous_term_id === (int) $menu->term_id ) {
- $index = $i;
- break;
- }
- }
-
- if ( $is_delete ) {
- // Handle deleted menu by removing it from the list.
- if ( -1 !== $index ) {
- array_splice( $menus, $index, 1 );
- }
- } else {
- // Handle menus being updated or inserted.
- $menu_obj = (object) array_merge( array(
- 'term_id' => $this->term_id,
- 'term_taxonomy_id' => $this->term_id,
- 'slug' => sanitize_title( $setting_value['name'] ),
- 'count' => 0,
- 'term_group' => 0,
- 'taxonomy' => self::TAXONOMY,
- 'filter' => 'raw',
- ), $setting_value );
-
- array_splice( $menus, $index, ( -1 === $index ? 0 : 1 ), array( $menu_obj ) );
- }
-
- // Make sure the menu objects get re-sorted after an update/insert.
- if ( ! $is_delete && ! empty( $args['orderby'] ) ) {
- $this->_current_menus_sort_orderby = $args['orderby'];
- usort( $menus, array( $this, '_sort_menus_by_orderby' ) );
- }
- // @todo add support for $args['hide_empty'] === true
-
- return $menus;
- }
-
- /**
- * Temporary non-closure passing of orderby value to function.
- *
- * @since 4.3.0
- * @access protected
- * @var string
- *
- * @see WP_Customize_Nav_Menu_Setting::filter_wp_get_nav_menus()
- * @see WP_Customize_Nav_Menu_Setting::_sort_menus_by_orderby()
- */
- protected $_current_menus_sort_orderby;
-
- /**
- * Sort menu objects by the class-supplied orderby property.
- *
- * This is a workaround for a lack of closures.
- *
- * @since 4.3.0
- * @access protected
- * @param object $menu1
- * @param object $menu2
- * @return int
- *
- * @see WP_Customize_Nav_Menu_Setting::filter_wp_get_nav_menus()
- */
- protected function _sort_menus_by_orderby( $menu1, $menu2 ) {
- $key = $this->_current_menus_sort_orderby;
- return strcmp( $menu1->$key, $menu2->$key );
- }
-
- /**
- * Filter the wp_get_nav_menu_object() result to supply the previewed menu object.
- *
- * Requesting a nav_menu object by anything but ID is not supported.
- *
- * @since 4.3.0
- * @access public
- *
- * @see wp_get_nav_menu_object()
- *
- * @param object|null $menu_obj Object returned by wp_get_nav_menu_object().
- * @param string $menu_id ID of the nav_menu term. Requests by slug or name will be ignored.
- * @return object|null
- */
- public function filter_wp_get_nav_menu_object( $menu_obj, $menu_id ) {
- $ok = (
- get_current_blog_id() === $this->_previewed_blog_id
- &&
- is_int( $menu_id )
- &&
- $menu_id === $this->term_id
- );
- if ( ! $ok ) {
- return $menu_obj;
- }
-
- $setting_value = $this->value();
-
- // Handle deleted menus.
- if ( false === $setting_value ) {
- return false;
- }
-
- // Handle sanitization failure by preventing short-circuiting.
- if ( null === $setting_value ) {
- return $menu_obj;
- }
-
- $menu_obj = (object) array_merge( array(
- 'term_id' => $this->term_id,
- 'term_taxonomy_id' => $this->term_id,
- 'slug' => sanitize_title( $setting_value['name'] ),
- 'count' => 0,
- 'term_group' => 0,
- 'taxonomy' => self::TAXONOMY,
- 'filter' => 'raw',
- ), $setting_value );
-
- return $menu_obj;
- }
-
- /**
- * Filter the nav_menu_options option to include this menu's auto_add preference.
- *
- * @since 4.3.0
- * @access public
- *
- * @param array $nav_menu_options Nav menu options including auto_add.
- * @return array (Kaybe) modified nav menu options.
- */
- public function filter_nav_menu_options( $nav_menu_options ) {
- if ( $this->_previewed_blog_id !== get_current_blog_id() ) {
- return $nav_menu_options;
- }
-
- $menu = $this->value();
- $nav_menu_options = $this->filter_nav_menu_options_value(
- $nav_menu_options,
- $this->term_id,
- false === $menu ? false : $menu['auto_add']
- );
-
- return $nav_menu_options;
- }
-
- /**
- * Sanitize an input.
- *
- * Note that parent::sanitize() erroneously does wp_unslash() on $value, but
- * we remove that in this override.
- *
- * @since 4.3.0
- * @access public
- *
- * @param array $value The value to sanitize.
- * @return array|false|null Null if an input isn't valid. False if it is marked for deletion.
- * Otherwise the sanitized value.
- */
- public function sanitize( $value ) {
- // Menu is marked for deletion.
- if ( false === $value ) {
- return $value;
- }
-
- // Invalid.
- if ( ! is_array( $value ) ) {
- return null;
- }
-
- $default = array(
- 'name' => '',
- 'description' => '',
- 'parent' => 0,
- 'auto_add' => false,
- );
- $value = array_merge( $default, $value );
- $value = wp_array_slice_assoc( $value, array_keys( $default ) );
-
- $value['name'] = trim( esc_html( $value['name'] ) ); // This sanitization code is used in wp-admin/nav-menus.php.
- $value['description'] = sanitize_text_field( $value['description'] );
- $value['parent'] = max( 0, intval( $value['parent'] ) );
- $value['auto_add'] = ! empty( $value['auto_add'] );
-
- if ( '' === $value['name'] ) {
- $value['name'] = _x( '(unnamed)', 'Missing menu name.' );
- }
-
- /** This filter is documented in wp-includes/class-wp-customize-setting.php */
- return apply_filters( "customize_sanitize_{$this->id}", $value, $this );
- }
-
- /**
- * Storage for data to be sent back to client in customize_save_response filter.
- *
- * @access protected
- * @since 4.3.0
- * @var array
- *
- * @see WP_Customize_Nav_Menu_Setting::amend_customize_save_response()
- */
- protected $_widget_nav_menu_updates = array();
-
- /**
- * Create/update the nav_menu term for this setting.
- *
- * Any created menus will have their assigned term IDs exported to the client
- * via the customize_save_response filter. Likewise, any errors will be exported
- * to the client via the customize_save_response() filter.
- *
- * To delete a menu, the client can send false as the value.
- *
- * @since 4.3.0
- * @access protected
- *
- * @see wp_update_nav_menu_object()
- *
- * @param array|false $value {
- * The value to update. Note that slug cannot be updated via wp_update_nav_menu_object().
- * If false, then the menu will be deleted entirely.
- *
- * @type string $name The name of the menu to save.
- * @type string $description The term description. Default empty string.
- * @type int $parent The id of the parent term. Default 0.
- * @type bool $auto_add Whether pages will auto_add to this menu. Default false.
- * }
- * @return null|void
- */
- protected function update( $value ) {
- if ( $this->is_updated ) {
- return;
- }
-
- $this->is_updated = true;
- $is_placeholder = ( $this->term_id < 0 );
- $is_delete = ( false === $value );
-
- add_filter( 'customize_save_response', array( $this, 'amend_customize_save_response' ) );
-
- $auto_add = null;
- if ( $is_delete ) {
- // If the current setting term is a placeholder, a delete request is a no-op.
- if ( $is_placeholder ) {
- $this->update_status = 'deleted';
- } else {
- $r = wp_delete_nav_menu( $this->term_id );
-
- if ( is_wp_error( $r ) ) {
- $this->update_status = 'error';
- $this->update_error = $r;
- } else {
- $this->update_status = 'deleted';
- $auto_add = false;
- }
- }
- } else {
- // Insert or update menu.
- $menu_data = wp_array_slice_assoc( $value, array( 'description', 'parent' ) );
- $menu_data['menu-name'] = $value['name'];
-
- $menu_id = $is_placeholder ? 0 : $this->term_id;
- $r = wp_update_nav_menu_object( $menu_id, $menu_data );
- $original_name = $menu_data['menu-name'];
- $name_conflict_suffix = 1;
- while ( is_wp_error( $r ) && 'menu_exists' === $r->get_error_code() ) {
- $name_conflict_suffix += 1;
- /* translators: 1: original menu name, 2: duplicate count */
- $menu_data['menu-name'] = sprintf( __( '%1$s (%2$d)' ), $original_name, $name_conflict_suffix );
- $r = wp_update_nav_menu_object( $menu_id, $menu_data );
- }
-
- if ( is_wp_error( $r ) ) {
- $this->update_status = 'error';
- $this->update_error = $r;
- } else {
- if ( $is_placeholder ) {
- $this->previous_term_id = $this->term_id;
- $this->term_id = $r;
- $this->update_status = 'inserted';
- } else {
- $this->update_status = 'updated';
- }
-
- $auto_add = $value['auto_add'];
- }
- }
-
- if ( null !== $auto_add ) {
- $nav_menu_options = $this->filter_nav_menu_options_value(
- (array) get_option( 'nav_menu_options', array() ),
- $this->term_id,
- $auto_add
- );
- update_option( 'nav_menu_options', $nav_menu_options );
- }
-
- if ( 'inserted' === $this->update_status ) {
- // Make sure that new menus assigned to nav menu locations use their new IDs.
- foreach ( $this->manager->settings() as $setting ) {
- if ( ! preg_match( '/^nav_menu_locations\[/', $setting->id ) ) {
- continue;
- }
-
- $post_value = $setting->post_value( null );
- if ( ! is_null( $post_value ) && $this->previous_term_id === intval( $post_value ) ) {
- $this->manager->set_post_value( $setting->id, $this->term_id );
- $setting->save();
- }
- }
-
- // Make sure that any nav_menu widgets referencing the placeholder nav menu get updated and sent back to client.
- foreach ( array_keys( $this->manager->unsanitized_post_values() ) as $setting_id ) {
- $nav_menu_widget_setting = $this->manager->get_setting( $setting_id );
- if ( ! $nav_menu_widget_setting || ! preg_match( '/^widget_nav_menu\[/', $nav_menu_widget_setting->id ) ) {
- continue;
- }
-
- $widget_instance = $nav_menu_widget_setting->post_value(); // Note that this calls WP_Customize_Widgets::sanitize_widget_instance().
- if ( empty( $widget_instance['nav_menu'] ) || intval( $widget_instance['nav_menu'] ) !== $this->previous_term_id ) {
- continue;
- }
-
- $widget_instance['nav_menu'] = $this->term_id;
- $updated_widget_instance = $this->manager->widgets->sanitize_widget_js_instance( $widget_instance );
- $this->manager->set_post_value( $nav_menu_widget_setting->id, $updated_widget_instance );
- $nav_menu_widget_setting->save();
-
- $this->_widget_nav_menu_updates[ $nav_menu_widget_setting->id ] = $updated_widget_instance;
- }
- }
- }
-
- /**
- * Updates a nav_menu_options array.
- *
- * @since 4.3.0
- * @access protected
- *
- * @see WP_Customize_Nav_Menu_Setting::filter_nav_menu_options()
- * @see WP_Customize_Nav_Menu_Setting::update()
- *
- * @param array $nav_menu_options Array as returned by get_option( 'nav_menu_options' ).
- * @param int $menu_id The term ID for the given menu.
- * @param bool $auto_add Whether to auto-add or not.
- * @return array (Maybe) modified nav_menu_otions array.
- */
- protected function filter_nav_menu_options_value( $nav_menu_options, $menu_id, $auto_add ) {
- $nav_menu_options = (array) $nav_menu_options;
- if ( ! isset( $nav_menu_options['auto_add'] ) ) {
- $nav_menu_options['auto_add'] = array();
- }
-
- $i = array_search( $menu_id, $nav_menu_options['auto_add'] );
- if ( $auto_add && false === $i ) {
- array_push( $nav_menu_options['auto_add'], $this->term_id );
- } elseif ( ! $auto_add && false !== $i ) {
- array_splice( $nav_menu_options['auto_add'], $i, 1 );
- }
-
- return $nav_menu_options;
- }
-
- /**
- * Export data for the JS client.
- *
- * @since 4.3.0
- * @access public
- *
- * @see WP_Customize_Nav_Menu_Setting::update()
- *
- * @param array $data Additional information passed back to the 'saved' event on `wp.customize`.
- * @return array Export data.
- */
- public function amend_customize_save_response( $data ) {
- if ( ! isset( $data['nav_menu_updates'] ) ) {
- $data['nav_menu_updates'] = array();
- }
- if ( ! isset( $data['widget_nav_menu_updates'] ) ) {
- $data['widget_nav_menu_updates'] = array();
- }
-
- $data['nav_menu_updates'][] = array(
- 'term_id' => $this->term_id,
- 'previous_term_id' => $this->previous_term_id,
- 'error' => $this->update_error ? $this->update_error->get_error_code() : null,
- 'status' => $this->update_status,
- 'saved_value' => 'deleted' === $this->update_status ? null : $this->value(),
- );
-
- $data['widget_nav_menu_updates'] = array_merge(
- $data['widget_nav_menu_updates'],
- $this->_widget_nav_menu_updates
- );
- $this->_widget_nav_menu_updates = array();
-
- return $data;
- }
-}
+/** WP_Customize_Nav_Menu_Setting class */
+require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-setting.php' );
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff