WP_Classic_To_Block_Menu_Converter::convert( WP_Term $menu ): 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

$menuWP_Term

The Menu term object of the menu to convert.

Return value

string|WP_Error

The serialized and normalized parsed blocks on success, an empty string when there are no menus to convert, or WP_Error on invalid menu.

Performance profile

How much work a call to WP_Classic_To_Block_Menu_Converter::convert() 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_posts().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

13–34

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• querycontent queryget_posts()one call below WP_Classic_To_Block_Menu_Converter::convert()
• hookthird-party callbacksapply_filters()one call below WP_Classic_To_Block_Menu_Converter::convert()
• optionoption read or writeget_option()one call below WP_Classic_To_Block_Menu_Converter::convert()

Further down the call graph this can also reach 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 · 3 distinct outcomes

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

Uses · 8

• is_nav_menu()Determines whether the given ID is a navigation menu.
• __()Retrieves the translation of $text.
• wp_get_nav_menu_items()Retrieves all menu items of a navigation menu.
• _wp_menu_item_classes_by_context()Adds the class property classes for the current context, if applicable.
• serialize_blocks()Returns a joined string of the aggregate serialization of the given parsed blocks.
• WP_Error::__construct()Initializes the error.
• static::group_by_parent_id()
• static::to_blocks()

Used by · 1

• WP_Navigation_Fallback::create_classic_menu_fallback()Creates a Navigation Menu post from a Classic Menu.

Source code

View on Trac ↗View on GitHub ↗

26	public static function convert( $menu ) {27 28		if ( ! is_nav_menu( $menu ) ) {29			return new WP_Error(30				'invalid_menu',31				__( 'The menu provided is not a valid menu.' )32			);33		}34 35		$menu_items = wp_get_nav_menu_items( $menu->term_id, array( 'update_post_term_cache' => false ) );36 37		if ( empty( $menu_items ) ) {38			return '';39		}40 41		// Set up the $menu_item variables.42		// Adds the class property classes for the current context, if applicable.43		_wp_menu_item_classes_by_context( $menu_items );44 45		$menu_items_by_parent_id = static::group_by_parent_id( $menu_items );46 47		$first_menu_item = $menu_items_by_parent_id[0] ?? array();48 49		$inner_blocks = static::to_blocks(50			$first_menu_item,51			$menu_items_by_parent_id52		);53 54		return serialize_blocks( $inner_blocks );55	}

Changelog

Introduced in 6.3.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/class-wp-classic-to-block-menu-converter.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.