Changeset 48103 for trunk/src/wp-content/themes/twentytwenty/inc/template-tags.php

Timestamp:

06/20/2020 11:20:25 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Synchronize and correct the documentation for wp_nav_menu() arguments in bundled themes.

See #49572.

File:

• trunk/src/wp-content/themes/twentytwenty/inc/template-tags.php (modified) (3 diffs)

trunk/src/wp-content/themes/twentytwenty/inc/template-tags.php

@@ -500 +500 @@
  * styling of sub levels in the fallback. Only applied if the match_menu_classes argument is set.
  *
- * @param array  $css_class CSS Class names.
- * @param string $item Comment.
- * @param int    $depth Depth of the current comment.
- * @param array  $args An array of arguments.
- * @param string $current_page Whether or not the item is the current item.
- * @return array $css_class CSS Class names.
- */
-function twentytwenty_filter_wp_list_pages_item_classes( $css_class, $item, $depth, $args, $current_page ) {
+ * @param string[] $css_class    An array of CSS classes to be applied to each list item.
+ * @param WP_Post  $page         Page data object.
+ * @param int      $depth        Depth of page, used for padding.
+ * @param array    $args         An array of arguments.
+ * @param int      $current_page ID of the current page.
+ * @return array CSS class names.
+ */
+function twentytwenty_filter_wp_list_pages_item_classes( $css_class, $page, $depth, $args, $current_page ) {
 
     // Only apply to wp_list_pages() calls with match_menu_classes set to true.
@@ -535 +535 @@
  * Adds a Sub Nav Toggle to the Expanded Menu and Mobile Menu.
  *
- * @param stdClass $args An array of arguments.
- * @param string   $item Menu item.
- * @param int      $depth Depth of the current menu item.
- * @return stdClass $args An object of wp_nav_menu() arguments.
+ * @param stdClass $args  An object of wp_nav_menu() arguments.
+ * @param WP_Post  $item  Menu item data object.
+ * @param int      $depth Depth of menu item. Used for padding.
+ * @return stdClass An object of wp_nav_menu() arguments.
  */
 function twentytwenty_add_sub_toggles_to_main_menu( $args, $item, $depth ) {
@@ -581 +581 @@
  * Displays SVG icons in social links menu.
  *
- * @param  string  $item_output The menu item output.
- * @param  WP_Post $item        Menu item object.
- * @param  int     $depth       Depth of the menu.
- * @param  array   $args        wp_nav_menu() arguments.
- * @return string  $item_output The menu item output with social icon.
+ * @param string   $item_output The menu item's starting HTML output.
+ * @param WP_Post  $item        Menu item data object.
+ * @param int      $depth       Depth of the menu. Used for padding.
+ * @param stdClass $args        An object of wp_nav_menu() arguments.
+ * @return string The menu item output with social icon.
  */
 function twentytwenty_nav_menu_social_icons( $item_output, $item, $depth, $args ) {