Changeset 55963

Timestamp:

06/21/2023 11:49:14 AM (15 months ago)

Author:

audrasjb

Message:

Twenty Nineteen: Remove unused function parameters and variables.

This changeset removes unused parameters and variables, fixes a typo, and improves some docblocks as per documentation standards.

Props upadalavipul, mukesh27, costdev, sabernhardt, hellofromtonya, audrasjb.
Fixes #57397.

File:

• trunk/src/wp-content/themes/twentynineteen/inc/template-functions.php (modified) (6 diffs)

trunk/src/wp-content/themes/twentynineteen/inc/template-functions.php

@@ -1 +1 @@
 <?php
 /**
- * Functions which enhance the theme by hooking into WordPress
+ * Functions which enhance the theme by hooking into WordPress.
  *
  * @package WordPress
@@ -35 +35 @@
 /**
  * Adds custom class to the array of posts classes.
- */
-function twentynineteen_post_classes( $classes, $css_class, $post_id ) {
+ *
+ * @param array $classes A list of existing post class values.
+ * @return array The filtered post class list.
+ */
+function twentynineteen_post_classes( $classes ) {
     $classes[] = 'entry';
 
     return $classes;
 }
-add_filter( 'post_class', 'twentynineteen_post_classes', 10, 3 );
-
-
-/**
- * Add a pingback url auto-discovery header for single posts, pages, or attachments.
+add_filter( 'post_class', 'twentynineteen_post_classes' );
+
+/**
+ * Adds a pingback url auto-discovery header for single posts, pages, or attachments.
  */
 function twentynineteen_pingback_header() {
@@ -97 +99 @@
 
 /**
- * Add custom 'sizes' attribute to responsive image functionality for post thumbnails.
+ * Adds custom 'sizes' attribute to responsive image functionality for post thumbnails.
  *
  * @origin Twenty Nineteen 1.0
@@ -117 +119 @@
     return $attr;
 }
-add_filter( 'wp_get_attachment_image_attributes', 'twentynineteen_post_thumbnail_sizes_attr', 10, 1 );
-
-/**
- * Add an extra menu to our nav for our priority+ navigation to use
- *
- * @param string $nav_menu  Nav menu.
- * @param object $args      Nav menu args.
+add_filter( 'wp_get_attachment_image_attributes', 'twentynineteen_post_thumbnail_sizes_attr' );
+
+/**
+ * Adds an extra menu to our nav for our priority+ navigation to use.
+ *
+ * @param string $nav_menu Nav menu.
+ * @param object $args     Nav menu args.
  * @return string More link for hidden menu items.
  */
@@ -157 +159 @@
 
 /**
- * WCAG 2.0 Attributes for Dropdown Menus
- *
- * Adjustments to menu attributes tot support WCAG 2.0 recommendations
+ * Handles WCAG 2.0 attributes for dropdown menus.
+ *
+ * Adjustments to menu attributes to support WCAG 2.0 recommendations
  * for flyout and dropdown menus.
  *
  * @ref https://www.w3.org/WAI/tutorials/menus/flyout/
- */
-function twentynineteen_nav_menu_link_attributes( $atts, $item, $args, $depth ) {
+ * @param array   $atts {
+ *     The HTML attributes applied to the menu item's `<a>` element, empty strings are ignored.
+ *
+ *     @type string $title        Title attribute.
+ *     @type string $target       Target attribute.
+ *     @type string $rel          The rel attribute.
+ *     @type string $href         The href attribute.
+ *     @type string $aria-current The aria-current attribute.
+ * }
+ * @param WP_Post $item The current menu item object.
+ * @return string[] Modified attributes.
+ */
+function twentynineteen_nav_menu_link_attributes( $atts, $item ) {
 
     // Add [aria-haspopup] and [aria-expanded] to menu items that have children.
@@ -175 +188 @@
     return $atts;
 }
-add_filter( 'nav_menu_link_attributes', 'twentynineteen_nav_menu_link_attributes', 10, 4 );
-
-/**
- * Create a nav menu item to be displayed on mobile to navigate from submenu back to the parent.
+add_filter( 'nav_menu_link_attributes', 'twentynineteen_nav_menu_link_attributes', 10, 2 );
+
+/**
+ * Creates a nav menu item to be displayed on mobile to navigate from submenu back to the parent.
  *
  * This duplicates each parent nav menu item and makes it the first child of itself.