wp_get_nav_menu_to_edit( int $menu_id = 0 ): string|WP_Error

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$menu_idintoptional

The ID of the menu to format. Default 0.Default: 0

Return value

string|WP_Error

The menu formatted to edit or error object on failure.

Performance profile

How much work a call to wp_get_nav_menu_to_edit() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_term().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

14–87

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 120.

Plugin surface

1 hook

Third-party callbacks on 'wp_edit_nav_menu_walker' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()called directly
• querycontent queryget_term()one call below wp_get_nav_menu_to_edit()

Further down the call graph this can also reach option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 6 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_get_nav_menu_to_edit() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while wp_get_nav_menu_to_edit() runs, in this order:

1. 1
   apply_filters( wp_edit_nav_menu_walker )filterline 1267 (+23 into the body)

   Filters the Walker class used when adding nav menu items.

Uses · 9

• wp_get_nav_menu_object()Returns a navigation menu object.
• is_nav_menu()Determines whether the given ID is a navigation menu.
• wp_get_nav_menu_items()Retrieves all menu items of a navigation menu.
• __()Retrieves the translation of $text.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_get_admin_notice()Creates and returns the markup for an admin notice.
• walk_nav_menu_tree()Retrieves the HTML list content for nav menu items.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• WP_Error::__construct()Initializes the error.

Source code

View on Trac ↗View on GitHub ↗

1244function wp_get_nav_menu_to_edit( $menu_id = 0 ) {1245	$menu = wp_get_nav_menu_object( $menu_id );1246 1247	// If the menu exists, get its items.1248	if ( is_nav_menu( $menu ) ) {1249		$menu_items = wp_get_nav_menu_items( $menu->term_id, array( 'post_status' => 'any' ) );1250		$result     = '<div id="menu-instructions" class="post-body-plain';1251		$result    .= ( ! empty( $menu_items ) ) ? ' menu-instructions-inactive">' : '">';1252		$result    .= '<p>' . __( 'Add menu items from the column on the left.' ) . '</p>';1253		$result    .= '</div>';1254 1255		if ( empty( $menu_items ) ) {1256			return $result . ' <ul class="menu" id="menu-to-edit"> </ul>';1257		}1258 1259		/**1260		 * Filters the Walker class used when adding nav menu items.1261		 *1262		 * @since 3.0.01263		 *1264		 * @param string $class   The walker class to use. Default 'Walker_Nav_Menu_Edit'.1265		 * @param int    $menu_id ID of the menu being rendered.1266		 */1267		$walker_class_name = apply_filters( 'wp_edit_nav_menu_walker', 'Walker_Nav_Menu_Edit', $menu_id );1268 1269		if ( class_exists( $walker_class_name ) ) {1270			$walker = new $walker_class_name();1271		} else {1272			return new WP_Error(1273				'menu_walker_not_exist',1274				sprintf(1275					/* translators: %s: Walker class name. */1276					__( 'The Walker class named %s does not exist.' ),1277					'<strong>' . $walker_class_name . '</strong>'1278				)1279			);1280		}1281 1282		$some_pending_menu_items = false;1283		$some_invalid_menu_items = false;1284 1285		foreach ( (array) $menu_items as $menu_item ) {1286			if ( isset( $menu_item->post_status ) && 'draft' === $menu_item->post_status ) {1287				$some_pending_menu_items = true;1288			}1289			if ( ! empty( $menu_item->_invalid ) ) {1290				$some_invalid_menu_items = true;1291			}1292		}1293 1294		if ( $some_pending_menu_items ) {1295			$message     = __( 'Click Save Menu to make pending menu items public.' );1296			$notice_args = array(1297				'type'               => 'info',1298				'additional_classes' => array( 'notice-alt', 'inline' ),1299			);1300			$result     .= wp_get_admin_notice( $message, $notice_args );1301		}1302 1303		if ( $some_invalid_menu_items ) {1304			$message     = __( 'There are some invalid menu items. Please check or delete them.' );1305			$notice_args = array(1306				'type'               => 'error',1307				'additional_classes' => array( 'notice-alt', 'inline' ),1308			);1309			$result     .= wp_get_admin_notice( $message, $notice_args );1310		}1311 1312		$result .= '<ul class="menu" id="menu-to-edit"> ';1313		$result .= walk_nav_menu_tree(1314			array_map( 'wp_setup_nav_menu_item', $menu_items ),1315			0,1316			(object) array( 'walker' => $walker )1317		);1318		$result .= ' </ul> ';1319 1320		return $result;1321	} elseif ( is_wp_error( $menu ) ) {1322		return $menu;1323	}

Changelog

Introduced in 3.0.0. One change between 6.7.7 and 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 6.8.8 tag, from src/wp-admin/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.