WP_Customize_Nav_Menus::customize_register()

Compatibility

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

Performance profile

How much work a call to WP_Customize_Nav_Menus::customize_register() 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_terms().

Scaling

Scales with input

The body loops, so the work grows with how much data it finds.

Instructions

164–213

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

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

What it touches

• optionoption read or writeget_option()called directly
• hookthird-party callbacksapply_filters()one call below WP_Customize_Nav_Menus::customize_register()
• querycontent queryget_terms()one call below WP_Customize_Nav_Menus::customize_register()
• cacheobject cachewp_cache_get()one call below WP_Customize_Nav_Menus::customize_register()
• serializeserialisationmaybe_unserialize()one call below WP_Customize_Nav_Menus::customize_register()

Further down the call graph this can also reach transient. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 12 distinct outcomes

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Uses · 21

• __()Retrieves the translation of $text.
• current_theme_supports()Checks a theme's support for a given feature.
• wp_get_nav_menus()Returns all navigation menu objects.
• get_registered_nav_menus()Retrieves all registered navigation menu locations in a theme.
• _n()Translates and retrieves the singular or plural form based on the supplied number.
• number_format_i18n()Converts float number to format based on the locale.
• _x()Retrieves translated string with gettext context.
• wp_html_excerpt()Safely extracts not more than the first $count characters from HTML string.
• get_option()Retrieves an option value based on an option name.
• wp_map_nav_menu_locations()Maps nav menu locations according to assignments in previously active theme.
• remove_filter()Removes a callback function from a filter hook.
• add_filter()Adds a callback function to a filter hook.

Source code

View on Trac ↗View on GitHub ↗

639	public function customize_register() {640		$changeset = $this->manager->unsanitized_post_values();641 642		// Preview settings for nav menus early so that the sections and controls will be added properly.643		$nav_menus_setting_ids = array();644		foreach ( array_keys( $changeset ) as $setting_id ) {645			if ( preg_match( '/^(nav_menu_locations|nav_menu|nav_menu_item)\[/', $setting_id ) ) {646				$nav_menus_setting_ids[] = $setting_id;647			}648		}649		$settings = $this->manager->add_dynamic_settings( $nav_menus_setting_ids );650		if ( $this->manager->settings_previewed() ) {651			foreach ( $settings as $setting ) {652				$setting->preview();653			}654		}655 656		// Require JS-rendered control types.657		$this->manager->register_panel_type( 'WP_Customize_Nav_Menus_Panel' );658		$this->manager->register_control_type( 'WP_Customize_Nav_Menu_Control' );659		$this->manager->register_control_type( 'WP_Customize_Nav_Menu_Name_Control' );660		$this->manager->register_control_type( 'WP_Customize_Nav_Menu_Locations_Control' );661		$this->manager->register_control_type( 'WP_Customize_Nav_Menu_Auto_Add_Control' );662		$this->manager->register_control_type( 'WP_Customize_Nav_Menu_Item_Control' );663 664		// Create a panel for Menus.665		$description = '<p>' . __( 'This panel is used for managing navigation menus for content you have already published on your site. You can create menus and add items for existing content such as pages, posts, categories, tags, formats, or custom links.' ) . '</p>';666		if ( current_theme_supports( 'widgets' ) ) {667			$description .= '<p>' . sprintf(668				/* translators: %s: URL to the Widgets panel of the Customizer. */669				__( 'Menus can be displayed in locations defined by your theme or in <a href="%s">widget areas</a> by adding a &#8220;Navigation Menu&#8221; widget.' ),670				"javascript:wp.customize.panel( 'widgets' ).focus();"671			) . '</p>';672		} else {673			$description .= '<p>' . __( 'Menus can be displayed in locations defined by your theme.' ) . '</p>';674		}675 676		/*677		 * Once multiple theme supports are allowed in WP_Customize_Panel,678		 * this panel can be restricted to themes that support menus or widgets.679		 */680		$this->manager->add_panel(681			new WP_Customize_Nav_Menus_Panel(682				$this->manager,683				'nav_menus',684				array(685					'title'       => __( 'Menus' ),686					'description' => $description,687					'priority'    => 100,688				)689			)690		);691		$menus = wp_get_nav_menus();692 693		// Menu locations.694		$locations     = get_registered_nav_menus();695		$num_locations = count( $locations );696 697		if ( 1 === $num_locations ) {698			$description = '<p>' . __( 'Your theme can display menus in one location. Select which menu you would like to use.' ) . '</p>';699		} else {700			/* translators: %s: Number of menu locations. */701			$description = '<p>' . sprintf( _n( 'Your theme can display menus in %s location. Select which menu you would like to use.', 'Your theme can display menus in %s locations. Select which menu appears in each location.', $num_locations ), number_format_i18n( $num_locations ) ) . '</p>';702		}703 704		if ( current_theme_supports( 'widgets' ) ) {705			/* translators: URL to the Widgets panel of the Customizer. */706			$description .= '<p>' . sprintf( __( 'If your theme has widget areas, you can also add menus there. Visit the <a href="%s">Widgets panel</a> and add a &#8220;Navigation Menu widget&#8221; to display a menu in a sidebar or footer.' ), "javascript:wp.customize.panel( 'widgets' ).focus();" ) . '</p>';707		}708 709		$this->manager->add_section(710			'menu_locations',711			array(712				'title'       => 1 === $num_locations ? _x( 'View Location', 'menu locations' ) : _x( 'View All Locations', 'menu locations' ),713				'panel'       => 'nav_menus',714				'priority'    => 30,715				'description' => $description,716			)717		);718

Changelog

Introduced in 4.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-customize-nav-menus.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.