Changeset 55003

Timestamp:

12/18/2022 08:45:36 AM (22 months ago)

Author:

audrasjb

Message:

Docs: Improve various globals documentation, as per docblock standards.

Props upadalavipul, audrasjb.

See #57069, #56792.

Location:

trunk/src/wp-content/themes

Files:

• twentyseventeen/inc/template-tags.php (modified) (1 diff)
• twentythirteen/functions.php (modified) (1 diff)
• twentytwelve/functions.php (modified) (1 diff)
• twentytwenty/inc/template-tags.php (modified) (2 diffs)

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

@@ -126 +126 @@
  * Display a front page section.
  *
+ * @global WP_Post $post Global post object.
+ *
  * @param WP_Customize_Partial $partial Partial associated with a selective refresh request.
  * @param int                  $id Front page section to display.

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

@@ -489 +489 @@
      * Display navigation to next/previous post when applicable.
      *
+     * @global WP_Post $post Global post object.
+     *
      * @since Twenty Thirteen 1.0
      */

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

@@ -427 +427 @@
      *
      * Used as a callback by wp_list_comments() for displaying the comments.
+     *
+     * @global WP_Post $post Global post object.
      *
      * @since Twenty Twelve 1.0

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

@@ -241 +241 @@
  *
  * @since Twenty Twenty 1.0
+ *
+ * @global WP_Post $post Global post object.
  *
  * @param int    $post_id  The ID of the post.
@@ -652 +654 @@
  * @since Twenty Twenty 1.0
  *
+ * @global WP_Post $post Global post object.
+ *
  * @param array $classes Classes added to the body tag.
  * @return array Classes added to the body tag.