wp_setup_nav_menu_item( object $menu_item ): object

Description

Parameters

$menu_itemobject

The menu item to modify.

Return

object

The menu item with standard menu item properties.

Hooks fired · 7

7 hooks fire while wp_setup_nav_menu_item() runs, in this order:

1. 1
   apply_filters( pre_wp_setup_nav_menu_item )filterline 855 (+13 into the body)

   Filters whether to short-circuit the wp_setup_nav_menu_item() output.

2. 2
   apply_filters( the_title )filterline 897 (+55 into the body)

   Filters the post title.

3. 3
   apply_filters( nav_menu_attr_title )filterline 968 (+126 into the body)

   Filters a navigation menu item's title attribute.

4. 4
   apply_filters( nav_menu_description )filterline 978 (+136 into the body)

   Filters a navigation menu item's description.

5. 5
   apply_filters( nav_menu_attr_title )filterline 1003 (+161 into the body)

   Filters a navigation menu item's title attribute.

6. 6
   apply_filters( nav_menu_description )filterline 1006 (+164 into the body)

   Filters a navigation menu item's description.

7. 7
   apply_filters( wp_setup_nav_menu_item )filterline 1039 (+197 into the body)

   Filters a navigation menu item object.

Uses · 16

• apply_filters()Calls the callback functions that have been added to a filter hook.
• get_post_meta()Retrieves a post meta field for the given post ID.
• get_post_type_object()Retrieves a post type object by name.
• get_post()Retrieves post data given a post ID or post object.
• get_post_states()Retrieves an array of post states from a post.
• wp_strip_all_tags()Properly strips all HTML tags including 'script' and 'style'.
• get_post_status()Retrieves the post status based on the post ID.
• get_permalink()Retrieves the full permalink for the current post or post ID.
• __()Retrieves the translation of $text.
• wp_trim_words()Trims text to a certain number of words.
• get_post_type_archive_link()Retrieves the permalink for a post type archive.
• get_taxonomy()Retrieves the taxonomy object of $taxonomy.

Used by · 3

• WP_Customize_Nav_Menu_Item_Setting::value()Get the instance data for a given nav_menu_item setting.
• WP_REST_Menu_Items_Controller::get_nav_menu_item()Gets the nav menu item, if the ID is valid.
• wp_ajax_add_menu_item()Handles adding a menu item via AJAX.

Source

View on Trac ↗View on GitHub ↗

842function wp_setup_nav_menu_item( $menu_item ) {843 844	/**845	 * Filters whether to short-circuit the wp_setup_nav_menu_item() output.846	 *847	 * Returning a non-null value from the filter will short-circuit wp_setup_nav_menu_item(),848	 * returning that value instead.849	 *850	 * @since 6.3.0851	 *852	 * @param object|null $modified_menu_item Modified menu item. Default null.853	 * @param object      $menu_item          The menu item to modify.854	 */855	$pre_menu_item = apply_filters( 'pre_wp_setup_nav_menu_item', null, $menu_item );856 857	if ( null !== $pre_menu_item ) {858		return $pre_menu_item;859	}860 861	if ( isset( $menu_item->post_type ) ) {862		if ( 'nav_menu_item' === $menu_item->post_type ) {863			$menu_item->db_id            = (int) $menu_item->ID;864			$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;865			$menu_item->object_id        = ! isset( $menu_item->object_id ) ? get_post_meta( $menu_item->ID, '_menu_item_object_id', true ) : $menu_item->object_id;866			$menu_item->object           = ! isset( $menu_item->object ) ? get_post_meta( $menu_item->ID, '_menu_item_object', true ) : $menu_item->object;867			$menu_item->type             = ! isset( $menu_item->type ) ? get_post_meta( $menu_item->ID, '_menu_item_type', true ) : $menu_item->type;868 869			if ( 'post_type' === $menu_item->type ) {870				$object = get_post_type_object( $menu_item->object );871				if ( $object ) {872					$menu_item->type_label = $object->labels->singular_name;873					// Denote post states for special pages (only in the admin).874					if ( function_exists( 'get_post_states' ) ) {875						$menu_post = get_post( $menu_item->object_id );876						if ( $menu_post instanceof WP_Post ) {877							$post_states = get_post_states( $menu_post );878							if ( $post_states ) {879								$menu_item->type_label = wp_strip_all_tags( implode( ', ', $post_states ) );880							}881						}882					}883				} else {884					$menu_item->type_label = $menu_item->object;885					$menu_item->_invalid   = true;886				}887 888				if ( 'trash' === get_post_status( $menu_item->object_id ) ) {889					$menu_item->_invalid = true;890				}891 892				$original_object = get_post( $menu_item->object_id );893 894				if ( $original_object ) {895					$menu_item->url = get_permalink( $original_object->ID );896					/** This filter is documented in wp-includes/post-template.php */897					$original_title = apply_filters( 'the_title', $original_object->post_title, $original_object->ID );898				} else {899					$menu_item->url      = '';900					$original_title      = '';901					$menu_item->_invalid = true;902				}903 904				if ( '' === $original_title ) {905					/* translators: %d: ID of a post. */906					$original_title = sprintf( __( '#%d (no title)' ), $menu_item->object_id );907				}908 909				$menu_item->title = ( '' === $menu_item->post_title ) ? $original_title : $menu_item->post_title;910 911			} elseif ( 'post_type_archive' === $menu_item->type ) {912				$object = get_post_type_object( $menu_item->object );913				if ( $object ) {914					$menu_item->title      = ( '' === $menu_item->post_title ) ? $object->labels->archives : $menu_item->post_title;915					$post_type_description = $object->description;916				} else {917					$post_type_description = '';918					$menu_item->_invalid   = true;919				}920 921				$menu_item->type_label = __( 'Post Type Archive' );

History

Introduced in 3.0.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/nav-menu.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.