Changeset 54867

Timestamp:

11/23/2022 09:28:15 PM (23 months ago)

Author:

audrasjb

Message:

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

Props upadalavipul, mukesh27, krupalpanchal, jigar-bhanushali.
See #57069, #56792.

Location:

trunk/src

Files:

• wp-admin/includes/class-wp-upgrader.php (modified) (1 diff)
• wp-includes/class-wp-block.php (modified) (1 diff)
• wp-includes/class-wp-locale.php (modified) (1 diff)
• wp-includes/class-wp-tax-query.php (modified) (1 diff)
• wp-includes/class-wp-term-query.php (modified) (1 diff)

trunk/src/wp-admin/includes/class-wp-upgrader.php

@@ -912 +912 @@
      * @since 4.5.0
      *
+     * @global wpdb $wpdb The WordPress database abstraction object.
+     *
      * @param string $lock_name       The name of this unique lock.
      * @param int    $release_timeout Optional. The duration in seconds to respect an existing lock.

trunk/src/wp-includes/class-wp-block.php

@@ -197 +197 @@
      * @since 5.5.0
      *
+     * @global WP_Post $post Global post object.
+     *
      * @param array $options {
      *     Optional options object.

trunk/src/wp-includes/class-wp-locale.php

@@ -125 +125 @@
      *
      * @global string $text_direction
-     * @global string $wp_version     The WordPress version string.
      */
     public function init() {

trunk/src/wp-includes/class-wp-tax-query.php

@@ -590 +590 @@
      * @since 3.2.0
      *
-     * @global wpdb $wpdb The WordPress database abstraction object.
-     *
      * @param array  $query           The single query. Passed by reference.
      * @param string $resulting_field The resulting field. Accepts 'slug', 'name', 'term_taxonomy_id',

trunk/src/wp-includes/class-wp-term-query.php

@@ -911 +911 @@
      * @since 4.6.0
      *
-     * @global wpdb $wpdb WordPress database abstraction object.
-     *
      * @param string $orderby_raw Alias for the field to order by.
      * @return string|false Value to used in the ORDER clause. False otherwise.