Changeset 54178

Timestamp:

09/15/2022 12:30:54 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Docs: Clarify documentation for the nav_menu_item_id filter.

This aims to make it clear that the filter is applied to an HTML ID attribute for the menu item's <li> element, and not a numeric ID.

Follow-up to [15407], [25410], [27201], [38559], [51739].

Props dilipbheda, robinwpdeveloper, mukesh27, audrasjb, SergeyBiryukov.
See #56574, #55646.

File:

• trunk/src/wp-includes/class-walker-nav-menu.php (modified) (1 diff)

trunk/src/wp-includes/class-walker-nav-menu.php

@@ -160 +160 @@
 
         /**
-         * Filters the ID applied to a menu item's list item element.
+         * Filters the ID attribute applied to a menu item's list item element.
          *
          * @since 3.0.1
          * @since 4.1.0 The `$depth` parameter was added.
          *
-         * @param string   $menu_id   The ID that is applied to the menu item's `<li>` element.
-         * @param WP_Post  $menu_item The current menu item.
-         * @param stdClass $args      An object of wp_nav_menu() arguments.
-         * @param int      $depth     Depth of menu item. Used for padding.
+         * @param string   $menu_item_id The ID attribute applied to the menu item's `<li>` element.
+         * @param WP_Post  $menu_item    The current menu item.
+         * @param stdClass $args         An object of wp_nav_menu() arguments.
+         * @param int      $depth        Depth of menu item. Used for padding.
          */
         $id = apply_filters( 'nav_menu_item_id', 'menu-item-' . $menu_item->ID, $menu_item, $args, $depth );