Changeset 55472

Timestamp:

03/07/2023 08:28:40 AM (19 months ago)

Author:

audrasjb

Message:

Bundled Themes: Improve various globals documentation, as per docblock standards.

Props viralsampat, audrasjb, costdev.
See #56792, #57069.

Location:

trunk/src/wp-content/themes

Files:

• twentyfourteen/functions.php (modified) (1 diff)
• twentyseventeen/front-page.php (modified) (1 diff)
• twentythirteen/functions.php (modified) (2 diffs)
• twentytwenty/index.php (modified) (1 diff)

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

@@ -722 +722 @@
  * Enables installing Twenty Fourteen in WordPress versions before 4.0.0 when the
  * `is_customize_preview` function was introduced.
+ *
+ * @global WP_Customize_Manager $wp_customize Customizer object.
  */
 if ( ! function_exists( 'is_customize_preview' ) ) :

trunk/src/wp-content/themes/twentyseventeen/front-page.php

@@ -39 +39 @@
              * @since Twenty Seventeen 1.0
              *
+             * @global int|string $twentyseventeencounter Front page section counter.
+             *
              * @param int $num_sections Number of front page sections.
              */

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

@@ -384 +384 @@
  * @since Twenty Thirteen 1.0
  *
+ * @global int $paged WordPress archive pagination page count.
+ * @global int $page  WordPress paginated post page count.
+ *
  * @param string $title Default title text for current view.
  * @param string $sep   Optional separator.
@@ -752 +755 @@
  *
  * @since Twenty Thirteen 1.0
+ *
+ * @global int $content_width Content width.
  */
 function twentythirteen_content_width() {

trunk/src/wp-content/themes/twentytwenty/index.php

@@ -26 +26 @@
 
     if ( is_search() ) {
+        /**
+         * @global WP_Query $wp_query WordPress Query object.
+         */
         global $wp_query;