WP_Nav_Menu_Widget::widget( array $args, array $instance )

Compatibility

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

Parameters

$argsarray

Display arguments including 'before_title', 'after_title', 'before_widget', and 'after_widget'.

$instancearray

Settings for the current Navigation Menu widget instance.

Performance profile

How much work a call to WP_Nav_Menu_Widget::widget() 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

Constant

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

Instructions

8–83

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

Plugin surface

3 hooks

Third-party callbacks on 'widget_title', 'navigation_widgets_format', 'widget_nav_menu_args' 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_Nav_Menu_Widget::widget()

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_Nav_Menu_Widget::widget() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 3

3 hooks fire while WP_Nav_Menu_Widget::widget() runs, in this order:

1. 1
   apply_filters( widget_title )filterline 54 (+12 into the body)

   Filters the widget title.

2. 2
   apply_filters( navigation_widgets_format )filterline 72 (+30 into the body)

   Filters the HTML format of widgets with navigation links.

3. 3
   apply_filters( widget_nav_menu_args )filterline 109 (+67 into the body)

   Filters the arguments for the Navigation Menu widget.

Uses · 5

• wp_get_nav_menu_object()Returns a navigation menu object.
• __()Retrieves the translation of $text.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• current_theme_supports()Checks a theme's support for a given feature.
• wp_nav_menu()Displays a navigation menu.

Source code

View on Trac ↗View on GitHub ↗

42	public function widget( $args, $instance ) {43		// Get menu.44		$nav_menu = ! empty( $instance['nav_menu'] ) ? wp_get_nav_menu_object( $instance['nav_menu'] ) : false;45 46		if ( ! $nav_menu ) {47			return;48		}49 50		$default_title = __( 'Menu' );51		$title         = ! empty( $instance['title'] ) ? $instance['title'] : '';52 53		/** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */54		$title = apply_filters( 'widget_title', $title, $instance, $this->id_base );55 56		echo $args['before_widget'];57 58		if ( $title ) {59			echo $args['before_title'] . $title . $args['after_title'];60		}61 62		$format = current_theme_supports( 'html5', 'navigation-widgets' ) ? 'html5' : 'xhtml';63 64		/**65		 * Filters the HTML format of widgets with navigation links.66		 *67		 * @since 5.5.068		 *69		 * @param string $format The type of markup to use in widgets with navigation links.70		 *                       Accepts 'html5', 'xhtml'.71		 */72		$format = apply_filters( 'navigation_widgets_format', $format );73 74		if ( 'html5' === $format ) {75			// The title may be filtered: Strip out HTML and make sure the aria-label is never empty.76			$title      = trim( strip_tags( $title ) );77			$aria_label = $title ? $title : $default_title;78 79			$nav_menu_args = array(80				'fallback_cb'          => '',81				'menu'                 => $nav_menu,82				'container'            => 'nav',83				'container_aria_label' => $aria_label,84				'items_wrap'           => '<ul id="%1$s" class="%2$s">%3$s</ul>',85			);86		} else {87			$nav_menu_args = array(88				'fallback_cb' => '',89				'menu'        => $nav_menu,90			);91		}92 93		/**94		 * Filters the arguments for the Navigation Menu widget.95		 *96		 * @since 4.2.097		 * @since 4.4.0 Added the `$instance` parameter.98		 *99		 * @param array   $nav_menu_args {100		 *     An array of arguments passed to wp_nav_menu() to retrieve a navigation menu.101		 *102		 *     @type callable|bool $fallback_cb Callback to fire if the menu doesn't exist. Default empty.103		 *     @type mixed         $menu        Menu ID, slug, or name.104		 * }105		 * @param WP_Term $nav_menu      Nav menu object for the current menu.106		 * @param array   $args          Display arguments for the current widget.107		 * @param array   $instance      Array of settings for the current widget.108		 */109		wp_nav_menu( apply_filters( 'widget_nav_menu_args', $nav_menu_args, $nav_menu, $args, $instance ) );110 111		echo $args['after_widget'];112	}

Changelog

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 6.7.7 tag, from src/wp-includes/widgets/class-wp-nav-menu-widget.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.