3 * Widget API: WP_Nav_Menu_Widget class
11 * Core class used to implement the Custom Menu widget.
17 class WP_Nav_Menu_Widget extends WP_Widget {
20 * Sets up a new Custom Menu widget instance.
25 public function __construct() {
27 'description' => __( 'Add a custom menu to your sidebar.' ),
28 'customize_selective_refresh' => true,
30 parent::__construct( 'nav_menu', __('Custom Menu'), $widget_ops );
34 * Outputs the content for the current Custom Menu widget instance.
39 * @param array $args Display arguments including 'before_title', 'after_title',
40 * 'before_widget', and 'after_widget'.
41 * @param array $instance Settings for the current Custom Menu widget instance.
43 public function widget( $args, $instance ) {
45 $nav_menu = ! empty( $instance['nav_menu'] ) ? wp_get_nav_menu_object( $instance['nav_menu'] ) : false;
50 /** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */
51 $instance['title'] = apply_filters( 'widget_title', empty( $instance['title'] ) ? '' : $instance['title'], $instance, $this->id_base );
53 echo $args['before_widget'];
55 if ( !empty($instance['title']) )
56 echo $args['before_title'] . $instance['title'] . $args['after_title'];
58 $nav_menu_args = array(
64 * Filters the arguments for the Custom Menu widget.
67 * @since 4.4.0 Added the `$instance` parameter.
69 * @param array $nav_menu_args {
70 * An array of arguments passed to wp_nav_menu() to retrieve a custom menu.
72 * @type callable|bool $fallback_cb Callback to fire if the menu doesn't exist. Default empty.
73 * @type mixed $menu Menu ID, slug, or name.
75 * @param WP_Term $nav_menu Nav menu object for the current menu.
76 * @param array $args Display arguments for the current widget.
77 * @param array $instance Array of settings for the current widget.
79 wp_nav_menu( apply_filters( 'widget_nav_menu_args', $nav_menu_args, $nav_menu, $args, $instance ) );
81 echo $args['after_widget'];
85 * Handles updating settings for the current Custom Menu widget instance.
90 * @param array $new_instance New settings for this instance as input by the user via
92 * @param array $old_instance Old settings for this instance.
93 * @return array Updated settings to save.
95 public function update( $new_instance, $old_instance ) {
97 if ( ! empty( $new_instance['title'] ) ) {
98 $instance['title'] = sanitize_text_field( $new_instance['title'] );
100 if ( ! empty( $new_instance['nav_menu'] ) ) {
101 $instance['nav_menu'] = (int) $new_instance['nav_menu'];
107 * Outputs the settings form for the Custom Menu widget.
112 * @param array $instance Current settings.
113 * @global WP_Customize_Manager $wp_customize
115 public function form( $instance ) {
116 global $wp_customize;
117 $title = isset( $instance['title'] ) ? $instance['title'] : '';
118 $nav_menu = isset( $instance['nav_menu'] ) ? $instance['nav_menu'] : '';
121 $menus = wp_get_nav_menus();
123 // If no menus exists, direct the user to go and create some.
125 <p class="nav-menu-widget-no-menus-message" <?php if ( ! empty( $menus ) ) { echo ' style="display:none" '; } ?>>
127 if ( $wp_customize instanceof WP_Customize_Manager ) {
128 $url = 'javascript: wp.customize.panel( "nav_menus" ).focus();';
130 $url = admin_url( 'nav-menus.php' );
133 <?php echo sprintf( __( 'No menus have been created yet. <a href="%s">Create some</a>.' ), esc_attr( $url ) ); ?>
135 <div class="nav-menu-widget-form-controls" <?php if ( empty( $menus ) ) { echo ' style="display:none" '; } ?>>
137 <label for="<?php echo $this->get_field_id( 'title' ); ?>"><?php _e( 'Title:' ) ?></label>
138 <input type="text" class="widefat" id="<?php echo $this->get_field_id( 'title' ); ?>" name="<?php echo $this->get_field_name( 'title' ); ?>" value="<?php echo esc_attr( $title ); ?>"/>
141 <label for="<?php echo $this->get_field_id( 'nav_menu' ); ?>"><?php _e( 'Select Menu:' ); ?></label>
142 <select id="<?php echo $this->get_field_id( 'nav_menu' ); ?>" name="<?php echo $this->get_field_name( 'nav_menu' ); ?>">
143 <option value="0"><?php _e( '— Select —' ); ?></option>
144 <?php foreach ( $menus as $menu ) : ?>
145 <option value="<?php echo esc_attr( $menu->term_id ); ?>" <?php selected( $nav_menu, $menu->term_id ); ?>>
146 <?php echo esc_html( $menu->name ); ?>
151 <?php if ( $wp_customize instanceof WP_Customize_Manager ) : ?>
152 <p class="edit-selected-nav-menu" style="<?php if ( ! $nav_menu ) { echo 'display: none;'; } ?>">
153 <button type="button" class="button"><?php _e( 'Edit Menu' ) ?></button>