云策 WordPress 开发者社区

类文档

Walker_Nav_Menu_Edit

查看官方原文 ↗
💡 云策文档标注

概述

Walker_Nav_Menu_Edit 是 WordPress 中用于生成导航菜单编辑界面 HTML 列表的类，继承自 Walker_Nav_Menu。它定义了 start_lvl、end_lvl 和 start_el 方法，以构建菜单项的表单输入元素。

关键要点

  • Walker_Nav_Menu_Edit 继承自 Walker_Nav_Menu，专门用于后台菜单编辑界面。
  • 核心方法包括 start_lvl（开始列表）、end_lvl（结束列表）和 start_el（输出菜单项元素）。
  • start_el 方法生成包含标题、URL、目标、CSS 类等表单字段的 HTML，支持菜单项类型（如分类、文章类型）处理。
  • 该类自 WordPress 3.0.0 引入，用于实现导航菜单输入项的 HTML 列表。

代码示例

public function start_el( &$output, $data_object, $depth = 0, $args = null, $current_object_id = 0 ) {
    global $_wp_nav_menu_max_depth;
    $menu_item = $data_object;
    $_wp_nav_menu_max_depth = $depth > $_wp_nav_menu_max_depth ? $depth : $_wp_nav_menu_max_depth;
    ob_start();
    $item_id = esc_attr( $menu_item->ID );
    // 生成菜单项编辑表单的 HTML 代码
    // 包括标题、URL、目标、类等字段
}

注意事项

  • start_el 方法在 WordPress 5.9.0 中重命名了参数以支持 PHP 8 命名参数，例如 $item 改为 $data_object。
  • 该类主要用于后台管理界面，开发者通常无需直接调用，但可扩展以自定义菜单编辑行为。
  • 相关类 Walker_Nav_Menu 用于前端菜单输出，而 Walker_Nav_Menu_Edit 专注于编辑功能。
📄 原文内容

Create HTML list of nav menu input items.

Description

See also

Methods

Name Description
Walker_Nav_Menu_Edit::end_lvl Ends the list of after the elements are added.
Walker_Nav_Menu_Edit::start_el Start the element output.
Walker_Nav_Menu_Edit::start_lvl Starts the list before the elements are added.

Source

class Walker_Nav_Menu_Edit extends Walker_Nav_Menu {

	/**

	 * Starts the list before the elements are added.

	 *

	 * @see Walker_Nav_Menu::start_lvl()

	 *

	 * @since 3.0.0

	 *

	 * @param string   $output Passed by reference.

	 * @param int      $depth  Depth of menu item. Used for padding.

	 * @param stdClass $args   Not used.

	 */

	public function start_lvl( &$output, $depth = 0, $args = null ) {}


	/**

	 * Ends the list of after the elements are added.

	 *

	 * @see Walker_Nav_Menu::end_lvl()

	 *

	 * @since 3.0.0

	 *

	 * @param string   $output Passed by reference.

	 * @param int      $depth  Depth of menu item. Used for padding.

	 * @param stdClass $args   Not used.

	 */

	public function end_lvl( &$output, $depth = 0, $args = null ) {}


	/**

	 * Start the element output.

	 *

	 * @see Walker_Nav_Menu::start_el()

	 * @since 3.0.0

	 * @since 5.9.0 Renamed `$item` to `$data_object` and `$id` to `$current_object_id`

	 *              to match parent class for PHP 8 named parameter support.

	 *

	 * @global int $_wp_nav_menu_max_depth

	 *

	 * @param string   $output            Used to append additional content (passed by reference).

	 * @param WP_Post  $data_object       Menu item data object.

	 * @param int      $depth             Depth of menu item. Used for padding.

	 * @param stdClass $args              Not used.

	 * @param int      $current_object_id Optional. ID of the current menu item. Default 0.

	 */

	public function start_el( &$output, $data_object, $depth = 0, $args = null, $current_object_id = 0 ) {

		global $_wp_nav_menu_max_depth;


		// Restores the more descriptive, specific name for use within this method.

		$menu_item = $data_object;


		$_wp_nav_menu_max_depth = $depth > $_wp_nav_menu_max_depth ? $depth : $_wp_nav_menu_max_depth;


		ob_start();

		$item_id      = esc_attr( $menu_item->ID );

		$removed_args = array(

			'action',

			'customlink-tab',

			'edit-menu-item',

			'menu-item',

			'page-tab',

			'_wpnonce',

		);


		$original_title = false;


		if ( 'taxonomy' === $menu_item->type ) {

			$original_object = get_term( (int) $menu_item->object_id, $menu_item->object );

			if ( $original_object && ! is_wp_error( $original_object ) ) {

				$original_title = $original_object->name;

			}

		} elseif ( 'post_type' === $menu_item->type ) {

			$original_object = get_post( $menu_item->object_id );

			if ( $original_object ) {

				$original_title = get_the_title( $original_object->ID );

			}

		} elseif ( 'post_type_archive' === $menu_item->type ) {

			$original_object = get_post_type_object( $menu_item->object );

			if ( $original_object ) {

				$original_title = $original_object->labels->archives;

			}

		}


		$classes = array(

			'menu-item menu-item-depth-' . $depth,

			'menu-item-' . esc_attr( $menu_item->object ),

			'menu-item-edit-' . ( ( isset( $_GET['edit-menu-item'] ) && $item_id === $_GET['edit-menu-item'] ) ? 'active' : 'inactive' ),

		);


		$title = $menu_item->title;


		if ( ! empty( $menu_item->_invalid ) ) {

			$classes[] = 'menu-item-invalid';

			/* translators: %s: Title of an invalid menu item. */

			$title = sprintf( __( '%s (Invalid)' ), $menu_item->title );

		} elseif ( isset( $menu_item->post_status ) && 'draft' === $menu_item->post_status ) {

			$classes[] = 'pending';

			/* translators: %s: Title of a menu item in draft status. */

			$title = sprintf( __( '%s (Pending)' ), $menu_item->title );

		}


		$title = ( ! isset( $menu_item->label ) || '' === $menu_item->label ) ? $title : $menu_item->label;


		$submenu_text = '';

		if ( 0 === $depth ) {

			$submenu_text = 'style="display: none;"';

		}


		?>

		<li id="menu-item-<?php echo $item_id; ?>" class="<?php echo implode( ' ', $classes ); ?>">

			<div class="menu-item-bar">

				<div class="menu-item-handle">

					<label class="item-title" for="menu-item-checkbox-<?php echo $item_id; ?>">

						<input id="menu-item-checkbox-<?php echo $item_id; ?>" type="checkbox" class="menu-item-checkbox" data-menu-item-id="<?php echo $item_id; ?>" disabled="disabled" />

						<span class="menu-item-title"></span>

						<span class="is-submenu" <?php echo $submenu_text; ?>></span>

					</label>

					<span class="item-controls">

						<span class="item-type">type_label ); ?></span>

						<span class="item-order hide-if-js">

							↑</a>',

								wp_nonce_url(

									add_query_arg(

										array(

											'action'    => 'move-up-menu-item',

											'menu-item' => $item_id,

										),

										remove_query_arg( $removed_args, admin_url( 'nav-menus.php' ) )

									),

									'move-menu_item'

								),

								esc_attr__( 'Move up' )

							);

							?>

							|

							↓</a>',

								wp_nonce_url(

									add_query_arg(

										array(

											'action'    => 'move-down-menu-item',

											'menu-item' => $item_id,

										),

										remove_query_arg( $removed_args, admin_url( 'nav-menus.php' ) )

									),

									'move-menu_item'

								),

								esc_attr__( 'Move down' )

							);

							?>

						</span>

						 $item_id,

								),

								remove_query_arg( $removed_args, admin_url( 'nav-menus.php#menu-item-settings-' . $item_id ) )

							);

						}


						printf(

							'<a class="item-edit" id="edit-%s" href="%s" aria-label="%s"><span class="screen-reader-text">%s</span></a>',

							$item_id,

							esc_url( $edit_url ),

							esc_attr__( 'Edit menu item' ),

							/* translators: Hidden accessibility text. */

							__( 'Edit' )

						);

						?>

					</span>

				</div>

			</div>


			<div class="menu-item-settings wp-clearfix" id="menu-item-settings-<?php echo $item_id; ?>">

				type ) : ?>

					<p class="field-url description description-wide">

						<label for="edit-menu-item-url-<?php echo $item_id; ?>">

							<br />

							<input type="text" id="edit-menu-item-url-<?php echo $item_id; ?>" class="widefat code edit-menu-item-url" name="menu-item-url[<?php echo $item_id; ?>]" value="<?php echo esc_url( $menu_item->url ); ?>" />

						</label>

					</p>


				<p class="description description-wide">

					<label for="edit-menu-item-title-<?php echo $item_id; ?>">

						<br />

						<input type="text" id="edit-menu-item-title-<?php echo $item_id; ?>" class="widefat edit-menu-item-title" name="menu-item-title[<?php echo $item_id; ?>]" value="<?php echo esc_attr( $menu_item->title ); ?>" />

					</label>

				</p>

				<p class="field-title-attribute field-attr-title description description-wide">

					<label for="edit-menu-item-attr-title-<?php echo $item_id; ?>">

						<br />

						<input type="text" id="edit-menu-item-attr-title-<?php echo $item_id; ?>" class="widefat edit-menu-item-attr-title" name="menu-item-attr-title[<?php echo $item_id; ?>]" value="<?php echo esc_attr( $menu_item->post_excerpt ); ?>" />

					</label>

				</p>

				<p class="field-link-target description">

					<label for="edit-menu-item-target-<?php echo $item_id; ?>">

						<input type="checkbox" id="edit-menu-item-target-<?php echo $item_id; ?>" value="_blank" name="menu-item-target[<?php echo $item_id; ?>]"<?php checked( $menu_item->target, '_blank' ); ?> />


					</label>

				</p>

				<div class="description-group">

					<p class="field-css-classes description description-thin">

						<label for="edit-menu-item-classes-<?php echo $item_id; ?>">

							<br />

							<input type="text" id="edit-menu-item-classes-<?php echo $item_id; ?>" class="widefat code edit-menu-item-classes" name="menu-item-classes[<?php echo $item_id; ?>]" value="<?php echo esc_attr( implode( ' ', $menu_item->classes ) ); ?>" />

						</label>

					</p>

					<p class="field-xfn description description-thin">

						<label for="edit-menu-item-xfn-<?php echo $item_id; ?>">

							<br />

							<input type="text" id="edit-menu-item-xfn-<?php echo $item_id; ?>" class="widefat code edit-menu-item-xfn" name="menu-item-xfn[<?php echo $item_id; ?>]" value="<?php echo esc_attr( $menu_item->xfn ); ?>" />

						</label>

					</p>

				</div>

				<p class="field-description description description-wide">

					<label for="edit-menu-item-description-<?php echo $item_id; ?>">

						<br />

						<textarea id="edit-menu-item-description-<?php echo $item_id; ?>" class="widefat edit-menu-item-description" rows="3" cols="20" name="menu-item-description[<?php echo $item_id; ?>]">description ); // textarea_escaped ?></textarea>

						<span class="description"></span>

					</label>

				</p>


				<div class="field-move-combo description-group">

					<p class="description description-wide">

						<label for="edit-menu-item-parent-<?php echo $item_id; ?>">


						</label>

						<select class="edit-menu-item-parent widefat" id="edit-menu-item-parent-<?php echo $item_id; ?>" name="menu-item-parent[<?php echo $item_id; ?>]">

						</select>

					</p>

					<p class="description description-wide">

						<label for="edit-menu-item-order-<?php echo $item_id; ?>">


						</label>

						<select class="edit-menu-item-order widefat" id="edit-menu-item-order-<?php echo $item_id; ?>" name="menu-item-order[<?php echo $item_id; ?>]">

						</select>

					</p>

				</div>


				<fieldset class="field-move hide-if-no-js description description-wide">

					<span class="field-move-visual-label" aria-hidden="true"></span>

					<button type="button" class="button-link menus-move menus-move-up" data-dir="up"></button>

					<button type="button" class="button-link menus-move menus-move-down" data-dir="down"></button>

					<button type="button" class="button-link menus-move menus-move-left" data-dir="left"></button>

					<button type="button" class="button-link menus-move menus-move-right" data-dir="right"></button>

					<button type="button" class="button-link menus-move menus-move-top" data-dir="top"></button>

				</fieldset>


				<div class="menu-item-actions description-wide submitbox">

					type && false !== $original_title ) : ?>

						<p class="link-to-original">

							url ) . '">' . esc_html( $original_title ) . '</a>' );

							?>

						</p>


					%s</a>',

						$item_id,

						wp_nonce_url(

							add_query_arg(

								array(

									'action'    => 'delete-menu-item',

									'menu-item' => $item_id,

								),

								admin_url( 'nav-menus.php' )

							),

							'delete-menu_item_' . $item_id

						),

						__( 'Remove' )

					);

					?>

					<span class="meta-sep hide-if-no-js"> | </span>

					%s</a>',

						$item_id,

						esc_url(

							add_query_arg(

								array(

									'edit-menu-item' => $item_id,

									'cancel'         => time(),

								),

								admin_url( 'nav-menus.php' )

							)

						),

						$item_id,

						__( 'Cancel' )

					);

					?>

				</div>


				<input class="menu-item-data-db-id" type="hidden" name="menu-item-db-id[<?php echo $item_id; ?>]" value="<?php echo $item_id; ?>" />

				<input class="menu-item-data-object-id" type="hidden" name="menu-item-object-id[<?php echo $item_id; ?>]" value="<?php echo esc_attr( $menu_item->object_id ); ?>" />

				<input class="menu-item-data-object" type="hidden" name="menu-item-object[<?php echo $item_id; ?>]" value="<?php echo esc_attr( $menu_item->object ); ?>" />

				<input class="menu-item-data-parent-id" type="hidden" name="menu-item-parent-id[<?php echo $item_id; ?>]" value="<?php echo esc_attr( $menu_item->menu_item_parent ); ?>" />

				<input class="menu-item-data-position" type="hidden" name="menu-item-position[<?php echo $item_id; ?>]" value="<?php echo esc_attr( $menu_item->menu_order ); ?>" />

				<input class="menu-item-data-type" type="hidden" name="menu-item-type[<?php echo $item_id; ?>]" value="<?php echo esc_attr( $menu_item->type ); ?>" />

			</div><!-- .menu-item-settings-->

			<ul class="menu-item-transport"></ul>

		</pre><p class="wporg-dot-link-list"><a href="https://developer.wordpress.org/reference/files/wp-admin/includes/class-walker-nav-menu-edit.php/">View all references</a> <a href="https://core.trac.wordpress.org/browser/tags/6.9.4/src/wp-admin/includes/class-walker-nav-menu-edit.php#L17">View on Trac</a> <a href="https://github.com/WordPress/wordpress-develop/blob/6.9.4/src/wp-admin/includes/class-walker-nav-menu-edit.php#L17-L350">View on GitHub</a></p></section>


		<section class="wp-block-wporg-code-reference-related" data-nosnippet="true"><h2 id="related" class="is-toc-heading wp-block-heading has-heading-5-font-size" tabindex="-1" ><a href="#related">Related</a></h2> <section style="margin-top:var(--wp--preset--spacing--20)" class="wp-block-wporg-code-table" id="uses"><figure class="wp-block-table "><table><thead><tr><th scope="col">Uses</th><th scope="col">Description</th></tr></thead><tbody><tr class=""><td><a href="https://developer.wordpress.org/reference/classes/walker_nav_menu/">Walker_Nav_Menu</a><code>wp-includes/class-walker-nav-menu.php


Core class used to implement an HTML list of nav menu items.

Changelog

Version Description
3.0.0 Introduced.