Changeset 63498

Timestamp:

09/05/2026 10:22:30 AM (4 days ago)

Author:

wildworks

Message:

Bundled Themes: Document the parameters of five template functions.

Adds missing @param/@return tags to five Twenty Nineteen and Twenty Twelve functions.

Developed in: ​https://github.com/WordPress/wordpress-develop/pull/12792

Props bejignesh, mukesh27, wildworks.
See #65860.

Location:

trunk/src/wp-content/themes

Files:

• twentynineteen/inc/template-tags.php (modified) (3 diffs)
• twentytwelve/functions.php (modified) (2 diffs)

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

@@ -171 +171 @@
         /**
          * Returns the HTML markup to generate a user avatar.
+         *
+         * @param mixed $id_or_email Optional. The avatar to retrieve. Accepts a user ID, Gravatar MD5 hash,
+         *                           user email, WP_User object, WP_Post object, or WP_Comment object.
+         *                           Default null, which uses the current user ID.
+         * @return string HTML markup for the user avatar.
          */
         function twentynineteen_get_user_avatar_markup( $id_or_email = null ) {
@@ -185 +190 @@
         /**
          * Displays a list of avatars involved in a discussion for a given post.
+         *
+         * @param array $comment_authors Comment authors to display avatars for. Each entry is a user ID,
+         *                               or an email address for authors without an account.
          */
         function twentynineteen_discussion_avatars_list( $comment_authors ) {
@@ -204 +212 @@
         /**
          * Displays the comment form.
+         *
+         * @param bool|string $order Whether to display the form. Accepts 'asc' or 'desc' to display it only
+         *                           when the value matches the 'comment_order' option, or true to always
+         *                           display it.
          */
         function twentynineteen_comment_form( $order ) {

trunk/src/wp-content/themes/twentytwelve/functions.php

@@ -345 +345 @@
  *
  * @since Twenty Twelve 1.0
+ *
+ * @param array $args An array of page menu arguments. See wp_page_menu() for information
+ *                    on accepted arguments.
+ * @return array Filtered page menu arguments.
  */
 function twentytwelve_page_menu_args( $args ) {
@@ -423 +427 @@
          *
          * @global WP_Query $wp_query WordPress Query object.
+         *
+         * @param string $html_id The HTML id attribute for the navigation element.
          */
         function twentytwelve_content_nav( $html_id ) {