3 * Navigation Menu functions
6 * @subpackage Nav_Menus
11 * Returns a navigation menu object.
15 * @param string $menu Menu ID, slug, or name - or the menu object.
16 * @return object|false False if $menu param isn't supplied or term does not exist, menu object if successful.
18 function wp_get_nav_menu_object( $menu ) {
21 if ( is_object( $menu ) ) {
25 if ( $menu && ! $menu_obj ) {
26 $menu_obj = get_term( $menu, 'nav_menu' );
29 $menu_obj = get_term_by( 'slug', $menu, 'nav_menu' );
33 $menu_obj = get_term_by( 'name', $menu, 'nav_menu' );
37 if ( ! $menu_obj || is_wp_error( $menu_obj ) ) {
42 * Filter the nav_menu term retrieved for wp_get_nav_menu_object().
46 * @param object|false $menu_obj Term from nav_menu taxonomy, or false if nothing had been found.
47 * @param string $menu The menu ID, slug, or name passed to wp_get_nav_menu_object().
49 return apply_filters( 'wp_get_nav_menu_object', $menu_obj, $menu );
53 * Check if the given ID is a navigation menu.
55 * Returns true if it is; false otherwise.
59 * @param int|string $menu The menu to check (ID, slug, or name).
60 * @return bool Whether the menu exists.
62 function is_nav_menu( $menu ) {
66 $menu_obj = wp_get_nav_menu_object( $menu );
70 ! is_wp_error( $menu_obj ) &&
71 ! empty( $menu_obj->taxonomy ) &&
72 'nav_menu' == $menu_obj->taxonomy
80 * Registers navigation menu locations for a theme.
84 * @global array $_wp_registered_nav_menus
86 * @param array $locations Associative array of menu location identifiers (like a slug) and descriptive text.
88 function register_nav_menus( $locations = array() ) {
89 global $_wp_registered_nav_menus;
91 add_theme_support( 'menus' );
93 $_wp_registered_nav_menus = array_merge( (array) $_wp_registered_nav_menus, $locations );
97 * Unregisters a navigation menu location for a theme.
99 * @global array $_wp_registered_nav_menus
101 * @param string $location The menu location identifier.
102 * @return bool True on success, false on failure.
104 function unregister_nav_menu( $location ) {
105 global $_wp_registered_nav_menus;
107 if ( is_array( $_wp_registered_nav_menus ) && isset( $_wp_registered_nav_menus[$location] ) ) {
108 unset( $_wp_registered_nav_menus[$location] );
109 if ( empty( $_wp_registered_nav_menus ) ) {
110 _remove_theme_support( 'menus' );
118 * Registers a navigation menu location for a theme.
122 * @param string $location Menu location identifier, like a slug.
123 * @param string $description Menu location descriptive text.
125 function register_nav_menu( $location, $description ) {
126 register_nav_menus( array( $location => $description ) );
129 * Returns all registered navigation menu locations in a theme.
133 * @global array $_wp_registered_nav_menus
137 function get_registered_nav_menus() {
138 global $_wp_registered_nav_menus;
139 if ( isset( $_wp_registered_nav_menus ) )
140 return $_wp_registered_nav_menus;
145 * Returns an array with the registered navigation menu locations and the menu assigned to it
151 function get_nav_menu_locations() {
152 $locations = get_theme_mod( 'nav_menu_locations' );
153 return ( is_array( $locations ) ) ? $locations : array();
157 * Determines whether a registered nav menu location has a menu assigned to it.
161 * @param string $location Menu location identifier.
162 * @return bool Whether location has a menu.
164 function has_nav_menu( $location ) {
165 $has_nav_menu = false;
167 $registered_nav_menus = get_registered_nav_menus();
168 if ( isset( $registered_nav_menus[ $location ] ) ) {
169 $locations = get_nav_menu_locations();
170 $has_nav_menu = ! empty( $locations[ $location ] );
174 * Filter whether a nav menu is assigned to the specified location.
178 * @param bool $has_nav_menu Whether there is a menu assigned to a location.
179 * @param string $location Menu location.
181 return apply_filters( 'has_nav_menu', $has_nav_menu, $location );
185 * Determines whether the given ID is a nav menu item.
189 * @param int $menu_item_id The ID of the potential nav menu item.
190 * @return bool Whether the given ID is that of a nav menu item.
192 function is_nav_menu_item( $menu_item_id = 0 ) {
193 return ( ! is_wp_error( $menu_item_id ) && ( 'nav_menu_item' == get_post_type( $menu_item_id ) ) );
197 * Creates a navigation menu.
199 * Note that `$menu_name` is expected to be pre-slashed.
203 * @param string $menu_name Menu name.
204 * @return int|WP_Error Menu ID on success, WP_Error object on failure.
206 function wp_create_nav_menu( $menu_name ) {
207 // expected_slashed ($menu_name)
208 return wp_update_nav_menu_object( 0, array( 'menu-name' => $menu_name ) );
212 * Delete a Navigation Menu.
216 * @param string $menu Menu ID, slug, or name.
217 * @return bool|WP_Error True on success, false or WP_Error object on failure.
219 function wp_delete_nav_menu( $menu ) {
220 $menu = wp_get_nav_menu_object( $menu );
224 $menu_objects = get_objects_in_term( $menu->term_id, 'nav_menu' );
225 if ( ! empty( $menu_objects ) ) {
226 foreach ( $menu_objects as $item ) {
227 wp_delete_post( $item );
231 $result = wp_delete_term( $menu->term_id, 'nav_menu' );
233 // Remove this menu from any locations.
234 $locations = get_nav_menu_locations();
235 foreach ( $locations as $location => $menu_id ) {
236 if ( $menu_id == $menu->term_id )
237 $locations[ $location ] = 0;
239 set_theme_mod( 'nav_menu_locations', $locations );
241 if ( $result && !is_wp_error($result) )
244 * Fires after a navigation menu has been successfully deleted.
248 * @param int $term_id ID of the deleted menu.
250 do_action( 'wp_delete_nav_menu', $menu->term_id );
256 * Save the properties of a menu or create a new menu with those properties.
258 * Note that `$menu_data` is expected to be pre-slashed.
262 * @param int $menu_id The ID of the menu or "0" to create a new menu.
263 * @param array $menu_data The array of menu data.
264 * @return int|WP_Error Menu ID on success, WP_Error object on failure.
266 function wp_update_nav_menu_object( $menu_id = 0, $menu_data = array() ) {
267 // expected_slashed ($menu_data)
268 $menu_id = (int) $menu_id;
270 $_menu = wp_get_nav_menu_object( $menu_id );
273 'description' => ( isset( $menu_data['description'] ) ? $menu_data['description'] : '' ),
274 'name' => ( isset( $menu_data['menu-name'] ) ? $menu_data['menu-name'] : '' ),
275 'parent' => ( isset( $menu_data['parent'] ) ? (int) $menu_data['parent'] : 0 ),
279 // double-check that we're not going to have one menu take the name of another
280 $_possible_existing = get_term_by( 'name', $menu_data['menu-name'], 'nav_menu' );
282 $_possible_existing &&
283 ! is_wp_error( $_possible_existing ) &&
284 isset( $_possible_existing->term_id ) &&
285 $_possible_existing->term_id != $menu_id
287 return new WP_Error( 'menu_exists',
288 /* translators: %s: menu name */
289 sprintf( __( 'The menu name %s conflicts with another menu name. Please try another.' ),
290 '<strong>' . esc_html( $menu_data['menu-name'] ) . '</strong>'
295 // menu doesn't already exist, so create a new menu
296 if ( ! $_menu || is_wp_error( $_menu ) ) {
297 $menu_exists = get_term_by( 'name', $menu_data['menu-name'], 'nav_menu' );
299 if ( $menu_exists ) {
300 return new WP_Error( 'menu_exists',
301 /* translators: %s: menu name */
302 sprintf( __( 'The menu name %s conflicts with another menu name. Please try another.' ),
303 '<strong>' . esc_html( $menu_data['menu-name'] ) . '</strong>'
308 $_menu = wp_insert_term( $menu_data['menu-name'], 'nav_menu', $args );
310 if ( is_wp_error( $_menu ) )
314 * Fires after a navigation menu is successfully created.
318 * @param int $term_id ID of the new menu.
319 * @param array $menu_data An array of menu data.
321 do_action( 'wp_create_nav_menu', $_menu['term_id'], $menu_data );
323 return (int) $_menu['term_id'];
326 if ( ! $_menu || ! isset( $_menu->term_id ) )
329 $menu_id = (int) $_menu->term_id;
331 $update_response = wp_update_term( $menu_id, 'nav_menu', $args );
333 if ( is_wp_error( $update_response ) )
334 return $update_response;
336 $menu_id = (int) $update_response['term_id'];
339 * Fires after a navigation menu has been successfully updated.
343 * @param int $menu_id ID of the updated menu.
344 * @param array $menu_data An array of menu data.
346 do_action( 'wp_update_nav_menu', $menu_id, $menu_data );
351 * Save the properties of a menu item or create a new one.
353 * The menu-item-title, menu-item-description, and menu-item-attr-title are expected
354 * to be pre-slashed since they are passed directly into `wp_insert_post()`.
358 * @param int $menu_id The ID of the menu. Required. If "0", makes the menu item a draft orphan.
359 * @param int $menu_item_db_id The ID of the menu item. If "0", creates a new menu item.
360 * @param array $menu_item_data The menu item's data.
361 * @return int|WP_Error The menu item's database ID or WP_Error object on failure.
363 function wp_update_nav_menu_item( $menu_id = 0, $menu_item_db_id = 0, $menu_item_data = array() ) {
364 $menu_id = (int) $menu_id;
365 $menu_item_db_id = (int) $menu_item_db_id;
367 // make sure that we don't convert non-nav_menu_item objects into nav_menu_item objects
368 if ( ! empty( $menu_item_db_id ) && ! is_nav_menu_item( $menu_item_db_id ) )
369 return new WP_Error( 'update_nav_menu_item_failed', __( 'The given object ID is not that of a menu item.' ) );
371 $menu = wp_get_nav_menu_object( $menu_id );
373 if ( ! $menu && 0 !== $menu_id ) {
374 return new WP_Error( 'invalid_menu_id', __( 'Invalid menu ID.' ) );
377 if ( is_wp_error( $menu ) ) {
382 'menu-item-db-id' => $menu_item_db_id,
383 'menu-item-object-id' => 0,
384 'menu-item-object' => '',
385 'menu-item-parent-id' => 0,
386 'menu-item-position' => 0,
387 'menu-item-type' => 'custom',
388 'menu-item-title' => '',
389 'menu-item-url' => '',
390 'menu-item-description' => '',
391 'menu-item-attr-title' => '',
392 'menu-item-target' => '',
393 'menu-item-classes' => '',
394 'menu-item-xfn' => '',
395 'menu-item-status' => '',
398 $args = wp_parse_args( $menu_item_data, $defaults );
400 if ( 0 == $menu_id ) {
401 $args['menu-item-position'] = 1;
402 } elseif ( 0 == (int) $args['menu-item-position'] ) {
403 $menu_items = 0 == $menu_id ? array() : (array) wp_get_nav_menu_items( $menu_id, array( 'post_status' => 'publish,draft' ) );
404 $last_item = array_pop( $menu_items );
405 $args['menu-item-position'] = ( $last_item && isset( $last_item->menu_order ) ) ? 1 + $last_item->menu_order : count( $menu_items );
408 $original_parent = 0 < $menu_item_db_id ? get_post_field( 'post_parent', $menu_item_db_id ) : 0;
410 if ( 'custom' != $args['menu-item-type'] ) {
411 /* if non-custom menu item, then:
412 * use original object's URL
413 * blank default title to sync with original object's
416 $args['menu-item-url'] = '';
418 $original_title = '';
419 if ( 'taxonomy' == $args['menu-item-type'] ) {
420 $original_parent = get_term_field( 'parent', $args['menu-item-object-id'], $args['menu-item-object'], 'raw' );
421 $original_title = get_term_field( 'name', $args['menu-item-object-id'], $args['menu-item-object'], 'raw' );
422 } elseif ( 'post_type' == $args['menu-item-type'] ) {
424 $original_object = get_post( $args['menu-item-object-id'] );
425 $original_parent = (int) $original_object->post_parent;
426 $original_title = $original_object->post_title;
427 } elseif ( 'post_type_archive' == $args['menu-item-type'] ) {
428 $original_object = get_post_type_object( $args['menu-item-object'] );
429 if ( $original_object ) {
430 $original_title = $original_object->labels->archives;
434 if ( $args['menu-item-title'] == $original_title )
435 $args['menu-item-title'] = '';
437 // hack to get wp to create a post object when too many properties are empty
438 if ( '' == $args['menu-item-title'] && '' == $args['menu-item-description'] )
439 $args['menu-item-description'] = ' ';
442 // Populate the menu item object
444 'menu_order' => $args['menu-item-position'],
446 'post_content' => $args['menu-item-description'],
447 'post_excerpt' => $args['menu-item-attr-title'],
448 'post_parent' => $original_parent,
449 'post_title' => $args['menu-item-title'],
450 'post_type' => 'nav_menu_item',
453 $update = 0 != $menu_item_db_id;
455 // New menu item. Default is draft status
458 $post['post_status'] = 'publish' == $args['menu-item-status'] ? 'publish' : 'draft';
459 $menu_item_db_id = wp_insert_post( $post );
460 if ( ! $menu_item_db_id || is_wp_error( $menu_item_db_id ) )
461 return $menu_item_db_id;
464 * Fires immediately after a new navigation menu item has been added.
468 * @see wp_update_nav_menu_item()
470 * @param int $menu_id ID of the updated menu.
471 * @param int $menu_item_db_id ID of the new menu item.
472 * @param array $args An array of arguments used to update/add the menu item.
474 do_action( 'wp_add_nav_menu_item', $menu_id, $menu_item_db_id, $args );
477 // Associate the menu item with the menu term
478 // Only set the menu term if it isn't set to avoid unnecessary wp_get_object_terms()
479 if ( $menu_id && ( ! $update || ! is_object_in_term( $menu_item_db_id, 'nav_menu', (int) $menu->term_id ) ) ) {
480 wp_set_object_terms( $menu_item_db_id, array( $menu->term_id ), 'nav_menu' );
483 if ( 'custom' == $args['menu-item-type'] ) {
484 $args['menu-item-object-id'] = $menu_item_db_id;
485 $args['menu-item-object'] = 'custom';
488 $menu_item_db_id = (int) $menu_item_db_id;
490 update_post_meta( $menu_item_db_id, '_menu_item_type', sanitize_key($args['menu-item-type']) );
491 update_post_meta( $menu_item_db_id, '_menu_item_menu_item_parent', strval( (int) $args['menu-item-parent-id'] ) );
492 update_post_meta( $menu_item_db_id, '_menu_item_object_id', strval( (int) $args['menu-item-object-id'] ) );
493 update_post_meta( $menu_item_db_id, '_menu_item_object', sanitize_key($args['menu-item-object']) );
494 update_post_meta( $menu_item_db_id, '_menu_item_target', sanitize_key($args['menu-item-target']) );
496 $args['menu-item-classes'] = array_map( 'sanitize_html_class', explode( ' ', $args['menu-item-classes'] ) );
497 $args['menu-item-xfn'] = implode( ' ', array_map( 'sanitize_html_class', explode( ' ', $args['menu-item-xfn'] ) ) );
498 update_post_meta( $menu_item_db_id, '_menu_item_classes', $args['menu-item-classes'] );
499 update_post_meta( $menu_item_db_id, '_menu_item_xfn', $args['menu-item-xfn'] );
500 update_post_meta( $menu_item_db_id, '_menu_item_url', esc_url_raw($args['menu-item-url']) );
503 update_post_meta( $menu_item_db_id, '_menu_item_orphaned', (string) time() );
504 elseif ( get_post_meta( $menu_item_db_id, '_menu_item_orphaned' ) )
505 delete_post_meta( $menu_item_db_id, '_menu_item_orphaned' );
507 // Update existing menu item. Default is publish status
509 $post['ID'] = $menu_item_db_id;
510 $post['post_status'] = 'draft' == $args['menu-item-status'] ? 'draft' : 'publish';
511 wp_update_post( $post );
515 * Fires after a navigation menu item has been updated.
519 * @see wp_update_nav_menu_item()
521 * @param int $menu_id ID of the updated menu.
522 * @param int $menu_item_db_id ID of the updated menu item.
523 * @param array $args An array of arguments used to update a menu item.
525 do_action( 'wp_update_nav_menu_item', $menu_id, $menu_item_db_id, $args );
527 return $menu_item_db_id;
531 * Returns all navigation menu objects.
534 * @since 4.1.0 Default value of the 'orderby' argument was changed from 'none'
537 * @param array $args Optional. Array of arguments passed on to {@see get_terms()}.
538 * Default empty array.
539 * @return array Menu objects.
541 function wp_get_nav_menus( $args = array() ) {
542 $defaults = array( 'hide_empty' => false, 'orderby' => 'name' );
543 $args = wp_parse_args( $args, $defaults );
546 * Filter the navigation menu objects being returned.
552 * @param array $menus An array of menu objects.
553 * @param array $args An array of arguments used to retrieve menu objects.
555 return apply_filters( 'wp_get_nav_menus', get_terms( 'nav_menu', $args), $args );
559 * Sort menu items by the desired key.
564 * @global string $_menu_item_sort_prop
566 * @param object $a The first object to compare
567 * @param object $b The second object to compare
568 * @return int -1, 0, or 1 if $a is considered to be respectively less than, equal to, or greater than $b.
570 function _sort_nav_menu_items( $a, $b ) {
571 global $_menu_item_sort_prop;
573 if ( empty( $_menu_item_sort_prop ) )
576 if ( ! isset( $a->$_menu_item_sort_prop ) || ! isset( $b->$_menu_item_sort_prop ) )
579 $_a = (int) $a->$_menu_item_sort_prop;
580 $_b = (int) $b->$_menu_item_sort_prop;
582 if ( $a->$_menu_item_sort_prop == $b->$_menu_item_sort_prop )
584 elseif ( $_a == $a->$_menu_item_sort_prop && $_b == $b->$_menu_item_sort_prop )
585 return $_a < $_b ? -1 : 1;
587 return strcmp( $a->$_menu_item_sort_prop, $b->$_menu_item_sort_prop );
591 * Return if a menu item is valid.
593 * @link https://core.trac.wordpress.org/ticket/13958
598 * @param object $item The menu item to check.
599 * @return bool False if invalid, otherwise true.
601 function _is_valid_nav_menu_item( $item ) {
602 return empty( $item->_invalid );
606 * Return all menu items of a navigation menu.
610 * @global string $_menu_item_sort_prop
611 * @staticvar array $fetched
613 * @param string $menu Menu name, ID, or slug.
614 * @param array $args Optional. Arguments to pass to {@see get_posts()}.
615 * @return false|array $items Array of menu items, otherwise false.
617 function wp_get_nav_menu_items( $menu, $args = array() ) {
618 $menu = wp_get_nav_menu_object( $menu );
624 static $fetched = array();
626 $items = get_objects_in_term( $menu->term_id, 'nav_menu' );
627 if ( is_wp_error( $items ) ) {
631 $defaults = array( 'order' => 'ASC', 'orderby' => 'menu_order', 'post_type' => 'nav_menu_item',
632 'post_status' => 'publish', 'output' => ARRAY_A, 'output_key' => 'menu_order', 'nopaging' => true );
633 $args = wp_parse_args( $args, $defaults );
634 $args['include'] = $items;
636 if ( ! empty( $items ) ) {
637 $items = get_posts( $args );
642 // Get all posts and terms at once to prime the caches
643 if ( empty( $fetched[$menu->term_id] ) || wp_using_ext_object_cache() ) {
644 $fetched[$menu->term_id] = true;
647 foreach ( $items as $item ) {
648 $object_id = get_post_meta( $item->ID, '_menu_item_object_id', true );
649 $object = get_post_meta( $item->ID, '_menu_item_object', true );
650 $type = get_post_meta( $item->ID, '_menu_item_type', true );
652 if ( 'post_type' == $type )
653 $posts[$object][] = $object_id;
654 elseif ( 'taxonomy' == $type)
655 $terms[$object][] = $object_id;
658 if ( ! empty( $posts ) ) {
659 foreach ( array_keys($posts) as $post_type ) {
660 get_posts( array('post__in' => $posts[$post_type], 'post_type' => $post_type, 'nopaging' => true, 'update_post_term_cache' => false) );
665 if ( ! empty( $terms ) ) {
666 foreach ( array_keys($terms) as $taxonomy ) {
667 get_terms( $taxonomy, array(
668 'include' => $terms[ $taxonomy ],
669 'hierarchical' => false,
676 $items = array_map( 'wp_setup_nav_menu_item', $items );
678 if ( ! is_admin() ) { // Remove invalid items only in front end
679 $items = array_filter( $items, '_is_valid_nav_menu_item' );
682 if ( ARRAY_A == $args['output'] ) {
683 $GLOBALS['_menu_item_sort_prop'] = $args['output_key'];
684 usort($items, '_sort_nav_menu_items');
686 foreach ( $items as $k => $item ) {
687 $items[$k]->{$args['output_key']} = $i++;
692 * Filter the navigation menu items being returned.
696 * @param array $items An array of menu item post objects.
697 * @param object $menu The menu object.
698 * @param array $args An array of arguments used to retrieve menu item objects.
700 return apply_filters( 'wp_get_nav_menu_items', $items, $menu, $args );
704 * Decorates a menu item object with the shared navigation menu item properties.
707 * - ID: The term_id if the menu item represents a taxonomy term.
708 * - attr_title: The title attribute of the link element for this menu item.
709 * - classes: The array of class attribute values for the link element of this menu item.
710 * - db_id: The DB ID of this item as a nav_menu_item object, if it exists (0 if it doesn't exist).
711 * - description: The description of this menu item.
712 * - menu_item_parent: The DB ID of the nav_menu_item that is this item's menu parent, if any. 0 otherwise.
713 * - object: The type of object originally represented, such as "category," "post", or "attachment."
714 * - object_id: The DB ID of the original object this menu item represents, e.g. ID for posts and term_id for categories.
715 * - post_parent: The DB ID of the original object's parent object, if any (0 otherwise).
716 * - post_title: A "no title" label if menu item represents a post that lacks a title.
717 * - target: The target attribute of the link element for this menu item.
718 * - title: The title of this menu item.
719 * - type: The family of objects originally represented, such as "post_type" or "taxonomy."
720 * - type_label: The singular label used to describe this type of menu item.
721 * - url: The URL to which this menu item points.
722 * - xfn: The XFN relationship expressed in the link of this menu item.
723 * - _invalid: Whether the menu item represents an object that no longer exists.
727 * @param object $menu_item The menu item to modify.
728 * @return object $menu_item The menu item with standard menu item properties.
730 function wp_setup_nav_menu_item( $menu_item ) {
731 if ( isset( $menu_item->post_type ) ) {
732 if ( 'nav_menu_item' == $menu_item->post_type ) {
733 $menu_item->db_id = (int) $menu_item->ID;
734 $menu_item->menu_item_parent = ! isset( $menu_item->menu_item_parent ) ? get_post_meta( $menu_item->ID, '_menu_item_menu_item_parent', true ) : $menu_item->menu_item_parent;
735 $menu_item->object_id = ! isset( $menu_item->object_id ) ? get_post_meta( $menu_item->ID, '_menu_item_object_id', true ) : $menu_item->object_id;
736 $menu_item->object = ! isset( $menu_item->object ) ? get_post_meta( $menu_item->ID, '_menu_item_object', true ) : $menu_item->object;
737 $menu_item->type = ! isset( $menu_item->type ) ? get_post_meta( $menu_item->ID, '_menu_item_type', true ) : $menu_item->type;
739 if ( 'post_type' == $menu_item->type ) {
740 $object = get_post_type_object( $menu_item->object );
742 $menu_item->type_label = $object->labels->singular_name;
744 $menu_item->type_label = $menu_item->object;
745 $menu_item->_invalid = true;
748 $menu_item->url = get_permalink( $menu_item->object_id );
750 $original_object = get_post( $menu_item->object_id );
751 /** This filter is documented in wp-includes/post-template.php */
752 $original_title = apply_filters( 'the_title', $original_object->post_title, $original_object->ID );
754 if ( '' === $original_title ) {
755 /* translators: %d: ID of a post */
756 $original_title = sprintf( __( '#%d (no title)' ), $original_object->ID );
759 $menu_item->title = '' == $menu_item->post_title ? $original_title : $menu_item->post_title;
761 } elseif ( 'post_type_archive' == $menu_item->type ) {
762 $object = get_post_type_object( $menu_item->object );
764 $menu_item->title = '' == $menu_item->post_title ? $object->labels->archives : $menu_item->post_title;
765 $post_type_description = $object->description;
767 $menu_item->_invalid = true;
768 $post_type_description = '';
771 $menu_item->type_label = __( 'Post Type Archive' );
772 $post_content = wp_trim_words( $menu_item->post_content, 200 );
773 $post_type_description = '' == $post_content ? $post_type_description : $post_content;
774 $menu_item->url = get_post_type_archive_link( $menu_item->object );
775 } elseif ( 'taxonomy' == $menu_item->type ) {
776 $object = get_taxonomy( $menu_item->object );
778 $menu_item->type_label = $object->labels->singular_name;
780 $menu_item->type_label = $menu_item->object;
781 $menu_item->_invalid = true;
784 $term_url = get_term_link( (int) $menu_item->object_id, $menu_item->object );
785 $menu_item->url = !is_wp_error( $term_url ) ? $term_url : '';
787 $original_title = get_term_field( 'name', $menu_item->object_id, $menu_item->object, 'raw' );
788 if ( is_wp_error( $original_title ) )
789 $original_title = false;
790 $menu_item->title = '' == $menu_item->post_title ? $original_title : $menu_item->post_title;
793 $menu_item->type_label = __('Custom Link');
794 $menu_item->title = $menu_item->post_title;
795 $menu_item->url = ! isset( $menu_item->url ) ? get_post_meta( $menu_item->ID, '_menu_item_url', true ) : $menu_item->url;
798 $menu_item->target = ! isset( $menu_item->target ) ? get_post_meta( $menu_item->ID, '_menu_item_target', true ) : $menu_item->target;
801 * Filter a navigation menu item's title attribute.
805 * @param string $item_title The menu item title attribute.
807 $menu_item->attr_title = ! isset( $menu_item->attr_title ) ? apply_filters( 'nav_menu_attr_title', $menu_item->post_excerpt ) : $menu_item->attr_title;
809 if ( ! isset( $menu_item->description ) ) {
811 * Filter a navigation menu item's description.
815 * @param string $description The menu item description.
817 $menu_item->description = apply_filters( 'nav_menu_description', wp_trim_words( $menu_item->post_content, 200 ) );
820 $menu_item->classes = ! isset( $menu_item->classes ) ? (array) get_post_meta( $menu_item->ID, '_menu_item_classes', true ) : $menu_item->classes;
821 $menu_item->xfn = ! isset( $menu_item->xfn ) ? get_post_meta( $menu_item->ID, '_menu_item_xfn', true ) : $menu_item->xfn;
823 $menu_item->db_id = 0;
824 $menu_item->menu_item_parent = 0;
825 $menu_item->object_id = (int) $menu_item->ID;
826 $menu_item->type = 'post_type';
828 $object = get_post_type_object( $menu_item->post_type );
829 $menu_item->object = $object->name;
830 $menu_item->type_label = $object->labels->singular_name;
832 if ( '' === $menu_item->post_title ) {
833 /* translators: %d: ID of a post */
834 $menu_item->post_title = sprintf( __( '#%d (no title)' ), $menu_item->ID );
837 $menu_item->title = $menu_item->post_title;
838 $menu_item->url = get_permalink( $menu_item->ID );
839 $menu_item->target = '';
841 /** This filter is documented in wp-includes/nav-menu.php */
842 $menu_item->attr_title = apply_filters( 'nav_menu_attr_title', '' );
844 /** This filter is documented in wp-includes/nav-menu.php */
845 $menu_item->description = apply_filters( 'nav_menu_description', '' );
846 $menu_item->classes = array();
847 $menu_item->xfn = '';
849 } elseif ( isset( $menu_item->taxonomy ) ) {
850 $menu_item->ID = $menu_item->term_id;
851 $menu_item->db_id = 0;
852 $menu_item->menu_item_parent = 0;
853 $menu_item->object_id = (int) $menu_item->term_id;
854 $menu_item->post_parent = (int) $menu_item->parent;
855 $menu_item->type = 'taxonomy';
857 $object = get_taxonomy( $menu_item->taxonomy );
858 $menu_item->object = $object->name;
859 $menu_item->type_label = $object->labels->singular_name;
861 $menu_item->title = $menu_item->name;
862 $menu_item->url = get_term_link( $menu_item, $menu_item->taxonomy );
863 $menu_item->target = '';
864 $menu_item->attr_title = '';
865 $menu_item->description = get_term_field( 'description', $menu_item->term_id, $menu_item->taxonomy );
866 $menu_item->classes = array();
867 $menu_item->xfn = '';
872 * Filter a navigation menu item object.
876 * @param object $menu_item The menu item object.
878 return apply_filters( 'wp_setup_nav_menu_item', $menu_item );
882 * Get the menu items associated with a particular object.
886 * @param int $object_id The ID of the original object.
887 * @param string $object_type The type of object, such as "taxonomy" or "post_type."
888 * @param string $taxonomy If $object_type is "taxonomy", $taxonomy is the name of the tax that $object_id belongs to
889 * @return array The array of menu item IDs; empty array if none;
891 function wp_get_associated_nav_menu_items( $object_id = 0, $object_type = 'post_type', $taxonomy = '' ) {
892 $object_id = (int) $object_id;
893 $menu_item_ids = array();
895 $query = new WP_Query;
896 $menu_items = $query->query(
898 'meta_key' => '_menu_item_object_id',
899 'meta_value' => $object_id,
900 'post_status' => 'any',
901 'post_type' => 'nav_menu_item',
902 'posts_per_page' => -1,
905 foreach ( (array) $menu_items as $menu_item ) {
906 if ( isset( $menu_item->ID ) && is_nav_menu_item( $menu_item->ID ) ) {
907 $menu_item_type = get_post_meta( $menu_item->ID, '_menu_item_type', true );
909 'post_type' == $object_type &&
910 'post_type' == $menu_item_type
912 $menu_item_ids[] = (int) $menu_item->ID;
914 'taxonomy' == $object_type &&
915 'taxonomy' == $menu_item_type &&
916 get_post_meta( $menu_item->ID, '_menu_item_object', true ) == $taxonomy
918 $menu_item_ids[] = (int) $menu_item->ID;
923 return array_unique( $menu_item_ids );
927 * Callback for handling a menu item when its original object is deleted.
932 * @param int $object_id The ID of the original object being trashed.
935 function _wp_delete_post_menu_item( $object_id = 0 ) {
936 $object_id = (int) $object_id;
938 $menu_item_ids = wp_get_associated_nav_menu_items( $object_id, 'post_type' );
940 foreach ( (array) $menu_item_ids as $menu_item_id ) {
941 wp_delete_post( $menu_item_id, true );
946 * Serves as a callback for handling a menu item when its original object is deleted.
951 * @param int $object_id Optional. The ID of the original object being trashed. Default 0.
952 * @param int $tt_id Term taxonomy ID. Unused.
953 * @param string $taxonomy Taxonomy slug.
955 function _wp_delete_tax_menu_item( $object_id = 0, $tt_id, $taxonomy ) {
956 $object_id = (int) $object_id;
958 $menu_item_ids = wp_get_associated_nav_menu_items( $object_id, 'taxonomy', $taxonomy );
960 foreach ( (array) $menu_item_ids as $menu_item_id ) {
961 wp_delete_post( $menu_item_id, true );
966 * Automatically add newly published page objects to menus with that as an option.
971 * @param string $new_status The new status of the post object.
972 * @param string $old_status The old status of the post object.
973 * @param object $post The post object being transitioned from one status to another.
975 function _wp_auto_add_pages_to_menu( $new_status, $old_status, $post ) {
976 if ( 'publish' != $new_status || 'publish' == $old_status || 'page' != $post->post_type )
978 if ( ! empty( $post->post_parent ) )
980 $auto_add = get_option( 'nav_menu_options' );
981 if ( empty( $auto_add ) || ! is_array( $auto_add ) || ! isset( $auto_add['auto_add'] ) )
983 $auto_add = $auto_add['auto_add'];
984 if ( empty( $auto_add ) || ! is_array( $auto_add ) )
988 'menu-item-object-id' => $post->ID,
989 'menu-item-object' => $post->post_type,
990 'menu-item-type' => 'post_type',
991 'menu-item-status' => 'publish',
994 foreach ( $auto_add as $menu_id ) {
995 $items = wp_get_nav_menu_items( $menu_id, array( 'post_status' => 'publish,draft' ) );
996 if ( ! is_array( $items ) )
998 foreach ( $items as $item ) {
999 if ( $post->ID == $item->object_id )
1002 wp_update_nav_menu_item( $menu_id, 0, $args );