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

In this article

Outputs the content for the current Navigation Menu widget instance.

Parameters

$argsarrayrequired
Display arguments including 'before_title', 'after_title', 'before_widget', and 'after_widget'.
$instancearrayrequired
Settings for the current Navigation Menu widget instance.

Source

public function widget( $args, $instance ) {
	// Get menu.
	$nav_menu = ! empty( $instance['nav_menu'] ) ? wp_get_nav_menu_object( $instance['nav_menu'] ) : false;

	if ( ! $nav_menu ) {
		return;
	}

	$default_title = __( 'Menu' );
	$title         = ! empty( $instance['title'] ) ? $instance['title'] : '';

	/** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */
	$title = apply_filters( 'widget_title', $title, $instance, $this->id_base );

	echo $args['before_widget'];

	if ( $title ) {
		echo $args['before_title'] . $title . $args['after_title'];
	}

	$format = current_theme_supports( 'html5', 'navigation-widgets' ) ? 'html5' : 'xhtml';

	/**
	 * Filters the HTML format of widgets with navigation links.
	 *
	 * @since 5.5.0
	 *
	 * @param string $format The type of markup to use in widgets with navigation links.
	 *                       Accepts 'html5', 'xhtml'.
	 */
	$format = apply_filters( 'navigation_widgets_format', $format );

	if ( 'html5' === $format ) {
		// The title may be filtered: Strip out HTML and make sure the aria-label is never empty.
		$title      = trim( strip_tags( $title ) );
		$aria_label = $title ? $title : $default_title;

		$nav_menu_args = array(
			'fallback_cb'          => '',
			'menu'                 => $nav_menu,
			'container'            => 'nav',
			'container_aria_label' => $aria_label,
			'items_wrap'           => '<ul id="%1$s" class="%2$s">%3$s</ul>',
		);
	} else {
		$nav_menu_args = array(
			'fallback_cb' => '',
			'menu'        => $nav_menu,
		);
	}

	/**
	 * Filters the arguments for the Navigation Menu widget.
	 *
	 * @since 4.2.0
	 * @since 4.4.0 Added the `$instance` parameter.
	 *
	 * @param array   $nav_menu_args {
	 *     An array of arguments passed to wp_nav_menu() to retrieve a navigation menu.
	 *
	 *     @type callable|bool $fallback_cb Callback to fire if the menu doesn't exist. Default empty.
	 *     @type mixed         $menu        Menu ID, slug, or name.
	 * }
	 * @param WP_Term $nav_menu      Nav menu object for the current menu.
	 * @param array   $args          Display arguments for the current widget.
	 * @param array   $instance      Array of settings for the current widget.
	 */
	wp_nav_menu( apply_filters( 'widget_nav_menu_args', $nav_menu_args, $nav_menu, $args, $instance ) );

	echo $args['after_widget'];
}

Hooks

apply_filters( ‘navigation_widgets_format’, string $format )

Filters the HTML format of widgets with navigation links.

apply_filters( ‘widget_nav_menu_args’, array $nav_menu_args, WP_Term $nav_menu, array $args, array $instance )

Filters the arguments for the Navigation Menu widget.

apply_filters( ‘widget_title’, string $title, array $instance, mixed $id_base )

Filters the widget title.

Changelog

VersionDescription
3.0.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.