3 * Customize API: WP_Customize_Nav_Menu_Setting class
6 * @subpackage Customize
11 * Customize Setting to represent a nav_menu.
13 * Subclass of WP_Customize_Setting to represent a nav_menu taxonomy term, and
14 * the IDs for the nav_menu_items associated with the nav menu.
18 * @see wp_get_nav_menu_object()
19 * @see WP_Customize_Setting
21 class WP_Customize_Nav_Menu_Setting extends WP_Customize_Setting {
23 const ID_PATTERN = '/^nav_menu\[(?P<id>-?\d+)\]$/';
25 const TAXONOMY = 'nav_menu';
27 const TYPE = 'nav_menu';
36 public $type = self::TYPE;
39 * Default setting value.
45 * @see wp_get_nav_menu_object()
47 public $default = array(
61 public $transport = 'postMessage';
64 * The term ID represented by this setting instance.
66 * A negative value represents a placeholder ID for a new menu not yet saved.
75 * Previous (placeholder) term ID used before creating a new menu.
77 * This value will be exported to JS via the {@see 'customize_save_response'} filter
78 * so that JavaScript can update the settings to refer to the newly-assigned
79 * term ID. This value is always negative to indicate it does not refer to
86 * @see WP_Customize_Nav_Menu_Setting::update()
87 * @see WP_Customize_Nav_Menu_Setting::amend_customize_save_response()
89 public $previous_term_id;
92 * Whether or not update() was called.
98 protected $is_updated = false;
101 * Status for calling the update method, used in customize_save_response filter.
103 * See {@see 'customize_save_response'}.
105 * When status is inserted, the placeholder term ID is stored in `$previous_term_id`.
106 * When status is error, the error is stored in `$update_error`.
110 * @var string updated|inserted|deleted|error
112 * @see WP_Customize_Nav_Menu_Setting::update()
113 * @see WP_Customize_Nav_Menu_Setting::amend_customize_save_response()
115 public $update_status;
118 * Any error object returned by wp_update_nav_menu_object() when setting is updated.
124 * @see WP_Customize_Nav_Menu_Setting::update()
125 * @see WP_Customize_Nav_Menu_Setting::amend_customize_save_response()
127 public $update_error;
132 * Any supplied $args override class property defaults.
137 * @param WP_Customize_Manager $manager Bootstrap Customizer instance.
138 * @param string $id An specific ID of the setting. Can be a
139 * theme mod or option name.
140 * @param array $args Optional. Setting arguments.
142 * @throws Exception If $id is not valid for this setting type.
144 public function __construct( WP_Customize_Manager $manager, $id, array $args = array() ) {
145 if ( empty( $manager->nav_menus ) ) {
146 throw new Exception( 'Expected WP_Customize_Manager::$nav_menus to be set.' );
149 if ( ! preg_match( self::ID_PATTERN, $id, $matches ) ) {
150 throw new Exception( "Illegal widget setting ID: $id" );
153 $this->term_id = intval( $matches['id'] );
155 parent::__construct( $manager, $id, $args );
159 * Get the instance data for a given widget setting.
164 * @see wp_get_nav_menu_object()
166 * @return array Instance data.
168 public function value() {
169 if ( $this->is_previewed && $this->_previewed_blog_id === get_current_blog_id() ) {
170 $undefined = new stdClass(); // Symbol.
171 $post_value = $this->post_value( $undefined );
173 if ( $undefined === $post_value ) {
174 $value = $this->_original_value;
176 $value = $post_value;
181 // Note that a term_id of less than one indicates a nav_menu not yet inserted.
182 if ( $this->term_id > 0 ) {
183 $term = wp_get_nav_menu_object( $this->term_id );
186 $value = wp_array_slice_assoc( (array) $term, array_keys( $this->default ) );
188 $nav_menu_options = (array) get_option( 'nav_menu_options', array() );
189 $value['auto_add'] = false;
191 if ( isset( $nav_menu_options['auto_add'] ) && is_array( $nav_menu_options['auto_add'] ) ) {
192 $value['auto_add'] = in_array( $term->term_id, $nav_menu_options['auto_add'] );
197 if ( ! is_array( $value ) ) {
198 $value = $this->default;
205 * Handle previewing the setting.
208 * @since 4.4.0 Added boolean return value
211 * @see WP_Customize_Manager::post_value()
213 * @return bool False if method short-circuited due to no-op.
215 public function preview() {
216 if ( $this->is_previewed ) {
220 $undefined = new stdClass();
221 $is_placeholder = ( $this->term_id < 0 );
222 $is_dirty = ( $undefined !== $this->post_value( $undefined ) );
223 if ( ! $is_placeholder && ! $is_dirty ) {
227 $this->is_previewed = true;
228 $this->_original_value = $this->value();
229 $this->_previewed_blog_id = get_current_blog_id();
231 add_filter( 'wp_get_nav_menus', array( $this, 'filter_wp_get_nav_menus' ), 10, 2 );
232 add_filter( 'wp_get_nav_menu_object', array( $this, 'filter_wp_get_nav_menu_object' ), 10, 2 );
233 add_filter( 'default_option_nav_menu_options', array( $this, 'filter_nav_menu_options' ) );
234 add_filter( 'option_nav_menu_options', array( $this, 'filter_nav_menu_options' ) );
240 * Filters the wp_get_nav_menus() result to ensure the inserted menu object is included, and the deleted one is removed.
245 * @see wp_get_nav_menus()
247 * @param array $menus An array of menu objects.
248 * @param array $args An array of arguments used to retrieve menu objects.
251 public function filter_wp_get_nav_menus( $menus, $args ) {
252 if ( get_current_blog_id() !== $this->_previewed_blog_id ) {
256 $setting_value = $this->value();
257 $is_delete = ( false === $setting_value );
260 // Find the existing menu item's position in the list.
261 foreach ( $menus as $i => $menu ) {
262 if ( (int) $this->term_id === (int) $menu->term_id || (int) $this->previous_term_id === (int) $menu->term_id ) {
269 // Handle deleted menu by removing it from the list.
270 if ( -1 !== $index ) {
271 array_splice( $menus, $index, 1 );
274 // Handle menus being updated or inserted.
275 $menu_obj = (object) array_merge( array(
276 'term_id' => $this->term_id,
277 'term_taxonomy_id' => $this->term_id,
278 'slug' => sanitize_title( $setting_value['name'] ),
281 'taxonomy' => self::TAXONOMY,
285 array_splice( $menus, $index, ( -1 === $index ? 0 : 1 ), array( $menu_obj ) );
288 // Make sure the menu objects get re-sorted after an update/insert.
289 if ( ! $is_delete && ! empty( $args['orderby'] ) ) {
290 $menus = wp_list_sort( $menus, array(
291 $args['orderby'] => 'ASC',
294 // @todo add support for $args['hide_empty'] === true
300 * Temporary non-closure passing of orderby value to function.
306 * @see WP_Customize_Nav_Menu_Setting::filter_wp_get_nav_menus()
307 * @see WP_Customize_Nav_Menu_Setting::_sort_menus_by_orderby()
309 protected $_current_menus_sort_orderby;
312 * Sort menu objects by the class-supplied orderby property.
314 * This is a workaround for a lack of closures.
317 * @deprecated 4.7.0 Use wp_list_sort()
320 * @param object $menu1
321 * @param object $menu2
324 * @see WP_Customize_Nav_Menu_Setting::filter_wp_get_nav_menus()
326 protected function _sort_menus_by_orderby( $menu1, $menu2 ) {
327 _deprecated_function( __METHOD__, '4.7.0', 'wp_list_sort' );
329 $key = $this->_current_menus_sort_orderby;
330 return strcmp( $menu1->$key, $menu2->$key );
334 * Filters the wp_get_nav_menu_object() result to supply the previewed menu object.
336 * Requesting a nav_menu object by anything but ID is not supported.
341 * @see wp_get_nav_menu_object()
343 * @param object|null $menu_obj Object returned by wp_get_nav_menu_object().
344 * @param string $menu_id ID of the nav_menu term. Requests by slug or name will be ignored.
345 * @return object|null
347 public function filter_wp_get_nav_menu_object( $menu_obj, $menu_id ) {
349 get_current_blog_id() === $this->_previewed_blog_id
353 $menu_id === $this->term_id
359 $setting_value = $this->value();
361 // Handle deleted menus.
362 if ( false === $setting_value ) {
366 // Handle sanitization failure by preventing short-circuiting.
367 if ( null === $setting_value ) {
371 $menu_obj = (object) array_merge( array(
372 'term_id' => $this->term_id,
373 'term_taxonomy_id' => $this->term_id,
374 'slug' => sanitize_title( $setting_value['name'] ),
377 'taxonomy' => self::TAXONOMY,
385 * Filters the nav_menu_options option to include this menu's auto_add preference.
390 * @param array $nav_menu_options Nav menu options including auto_add.
391 * @return array (Kaybe) modified nav menu options.
393 public function filter_nav_menu_options( $nav_menu_options ) {
394 if ( $this->_previewed_blog_id !== get_current_blog_id() ) {
395 return $nav_menu_options;
398 $menu = $this->value();
399 $nav_menu_options = $this->filter_nav_menu_options_value(
402 false === $menu ? false : $menu['auto_add']
405 return $nav_menu_options;
411 * Note that parent::sanitize() erroneously does wp_unslash() on $value, but
412 * we remove that in this override.
417 * @param array $value The value to sanitize.
418 * @return array|false|null Null if an input isn't valid. False if it is marked for deletion.
419 * Otherwise the sanitized value.
421 public function sanitize( $value ) {
422 // Menu is marked for deletion.
423 if ( false === $value ) {
428 if ( ! is_array( $value ) ) {
438 $value = array_merge( $default, $value );
439 $value = wp_array_slice_assoc( $value, array_keys( $default ) );
441 $value['name'] = trim( esc_html( $value['name'] ) ); // This sanitization code is used in wp-admin/nav-menus.php.
442 $value['description'] = sanitize_text_field( $value['description'] );
443 $value['parent'] = max( 0, intval( $value['parent'] ) );
444 $value['auto_add'] = ! empty( $value['auto_add'] );
446 if ( '' === $value['name'] ) {
447 $value['name'] = _x( '(unnamed)', 'Missing menu name.' );
450 /** This filter is documented in wp-includes/class-wp-customize-setting.php */
451 return apply_filters( "customize_sanitize_{$this->id}", $value, $this );
455 * Storage for data to be sent back to client in customize_save_response filter.
457 * See {@see 'customize_save_response'}.
463 * @see WP_Customize_Nav_Menu_Setting::amend_customize_save_response()
465 protected $_widget_nav_menu_updates = array();
468 * Create/update the nav_menu term for this setting.
470 * Any created menus will have their assigned term IDs exported to the client
471 * via the {@see 'customize_save_response'} filter. Likewise, any errors will be exported
472 * to the client via the customize_save_response() filter.
474 * To delete a menu, the client can send false as the value.
479 * @see wp_update_nav_menu_object()
481 * @param array|false $value {
482 * The value to update. Note that slug cannot be updated via wp_update_nav_menu_object().
483 * If false, then the menu will be deleted entirely.
485 * @type string $name The name of the menu to save.
486 * @type string $description The term description. Default empty string.
487 * @type int $parent The id of the parent term. Default 0.
488 * @type bool $auto_add Whether pages will auto_add to this menu. Default false.
492 protected function update( $value ) {
493 if ( $this->is_updated ) {
497 $this->is_updated = true;
498 $is_placeholder = ( $this->term_id < 0 );
499 $is_delete = ( false === $value );
501 add_filter( 'customize_save_response', array( $this, 'amend_customize_save_response' ) );
505 // If the current setting term is a placeholder, a delete request is a no-op.
506 if ( $is_placeholder ) {
507 $this->update_status = 'deleted';
509 $r = wp_delete_nav_menu( $this->term_id );
511 if ( is_wp_error( $r ) ) {
512 $this->update_status = 'error';
513 $this->update_error = $r;
515 $this->update_status = 'deleted';
520 // Insert or update menu.
521 $menu_data = wp_array_slice_assoc( $value, array( 'description', 'parent' ) );
522 $menu_data['menu-name'] = $value['name'];
524 $menu_id = $is_placeholder ? 0 : $this->term_id;
525 $r = wp_update_nav_menu_object( $menu_id, wp_slash( $menu_data ) );
526 $original_name = $menu_data['menu-name'];
527 $name_conflict_suffix = 1;
528 while ( is_wp_error( $r ) && 'menu_exists' === $r->get_error_code() ) {
529 $name_conflict_suffix += 1;
530 /* translators: 1: original menu name, 2: duplicate count */
531 $menu_data['menu-name'] = sprintf( __( '%1$s (%2$d)' ), $original_name, $name_conflict_suffix );
532 $r = wp_update_nav_menu_object( $menu_id, wp_slash( $menu_data ) );
535 if ( is_wp_error( $r ) ) {
536 $this->update_status = 'error';
537 $this->update_error = $r;
539 if ( $is_placeholder ) {
540 $this->previous_term_id = $this->term_id;
542 $this->update_status = 'inserted';
544 $this->update_status = 'updated';
547 $auto_add = $value['auto_add'];
551 if ( null !== $auto_add ) {
552 $nav_menu_options = $this->filter_nav_menu_options_value(
553 (array) get_option( 'nav_menu_options', array() ),
557 update_option( 'nav_menu_options', $nav_menu_options );
560 if ( 'inserted' === $this->update_status ) {
561 // Make sure that new menus assigned to nav menu locations use their new IDs.
562 foreach ( $this->manager->settings() as $setting ) {
563 if ( ! preg_match( '/^nav_menu_locations\[/', $setting->id ) ) {
567 $post_value = $setting->post_value( null );
568 if ( ! is_null( $post_value ) && $this->previous_term_id === intval( $post_value ) ) {
569 $this->manager->set_post_value( $setting->id, $this->term_id );
574 // Make sure that any nav_menu widgets referencing the placeholder nav menu get updated and sent back to client.
575 foreach ( array_keys( $this->manager->unsanitized_post_values() ) as $setting_id ) {
576 $nav_menu_widget_setting = $this->manager->get_setting( $setting_id );
577 if ( ! $nav_menu_widget_setting || ! preg_match( '/^widget_nav_menu\[/', $nav_menu_widget_setting->id ) ) {
581 $widget_instance = $nav_menu_widget_setting->post_value(); // Note that this calls WP_Customize_Widgets::sanitize_widget_instance().
582 if ( empty( $widget_instance['nav_menu'] ) || intval( $widget_instance['nav_menu'] ) !== $this->previous_term_id ) {
586 $widget_instance['nav_menu'] = $this->term_id;
587 $updated_widget_instance = $this->manager->widgets->sanitize_widget_js_instance( $widget_instance );
588 $this->manager->set_post_value( $nav_menu_widget_setting->id, $updated_widget_instance );
589 $nav_menu_widget_setting->save();
591 $this->_widget_nav_menu_updates[ $nav_menu_widget_setting->id ] = $updated_widget_instance;
597 * Updates a nav_menu_options array.
602 * @see WP_Customize_Nav_Menu_Setting::filter_nav_menu_options()
603 * @see WP_Customize_Nav_Menu_Setting::update()
605 * @param array $nav_menu_options Array as returned by get_option( 'nav_menu_options' ).
606 * @param int $menu_id The term ID for the given menu.
607 * @param bool $auto_add Whether to auto-add or not.
608 * @return array (Maybe) modified nav_menu_otions array.
610 protected function filter_nav_menu_options_value( $nav_menu_options, $menu_id, $auto_add ) {
611 $nav_menu_options = (array) $nav_menu_options;
612 if ( ! isset( $nav_menu_options['auto_add'] ) ) {
613 $nav_menu_options['auto_add'] = array();
616 $i = array_search( $menu_id, $nav_menu_options['auto_add'] );
617 if ( $auto_add && false === $i ) {
618 array_push( $nav_menu_options['auto_add'], $this->term_id );
619 } elseif ( ! $auto_add && false !== $i ) {
620 array_splice( $nav_menu_options['auto_add'], $i, 1 );
623 return $nav_menu_options;
627 * Export data for the JS client.
632 * @see WP_Customize_Nav_Menu_Setting::update()
634 * @param array $data Additional information passed back to the 'saved' event on `wp.customize`.
635 * @return array Export data.
637 public function amend_customize_save_response( $data ) {
638 if ( ! isset( $data['nav_menu_updates'] ) ) {
639 $data['nav_menu_updates'] = array();
641 if ( ! isset( $data['widget_nav_menu_updates'] ) ) {
642 $data['widget_nav_menu_updates'] = array();
645 $data['nav_menu_updates'][] = array(
646 'term_id' => $this->term_id,
647 'previous_term_id' => $this->previous_term_id,
648 'error' => $this->update_error ? $this->update_error->get_error_code() : null,
649 'status' => $this->update_status,
650 'saved_value' => 'deleted' === $this->update_status ? null : $this->value(),
653 $data['widget_nav_menu_updates'] = array_merge(
654 $data['widget_nav_menu_updates'],
655 $this->_widget_nav_menu_updates
657 $this->_widget_nav_menu_updates = array();