From 54d392e8d7739e5946b51d79cd3868315e282eed Mon Sep 17 00:00:00 2001 From: Jb Audras Date: Wed, 23 Nov 2022 21:28:15 +0000 Subject: [PATCH] Docs: Improve various globals documentation, as per documentation standards. Props upadalavipul, mukesh27, krupalpanchal, jigar-bhanushali. See #57069, #56792. git-svn-id: https://develop.svn.wordpress.org/trunk@54867 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-admin/includes/class-wp-upgrader.php | 2 ++ src/wp-includes/class-wp-block.php | 2 ++ src/wp-includes/class-wp-locale.php | 1 - src/wp-includes/class-wp-tax-query.php | 2 -- src/wp-includes/class-wp-term-query.php | 2 -- 5 files changed, 4 insertions(+), 5 deletions(-) diff --git a/src/wp-admin/includes/class-wp-upgrader.php b/src/wp-admin/includes/class-wp-upgrader.php index a2b2c9ed06..88c6d5d604 100644 --- a/src/wp-admin/includes/class-wp-upgrader.php +++ b/src/wp-admin/includes/class-wp-upgrader.php @@ -911,6 +911,8 @@ class WP_Upgrader { * * @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. * Default: 1 hour. diff --git a/src/wp-includes/class-wp-block.php b/src/wp-includes/class-wp-block.php index 8a51e66085..890ae5e559 100644 --- a/src/wp-includes/class-wp-block.php +++ b/src/wp-includes/class-wp-block.php @@ -196,6 +196,8 @@ class WP_Block { * * @since 5.5.0 * + * @global WP_Post $post Global post object. + * * @param array $options { * Optional options object. * diff --git a/src/wp-includes/class-wp-locale.php b/src/wp-includes/class-wp-locale.php index ca98f9d301..b001a09964 100644 --- a/src/wp-includes/class-wp-locale.php +++ b/src/wp-includes/class-wp-locale.php @@ -124,7 +124,6 @@ class WP_Locale { * @since 2.1.0 * * @global string $text_direction - * @global string $wp_version The WordPress version string. */ public function init() { // The weekdays. diff --git a/src/wp-includes/class-wp-tax-query.php b/src/wp-includes/class-wp-tax-query.php index e7b1e2a95a..881e0ce2dc 100644 --- a/src/wp-includes/class-wp-tax-query.php +++ b/src/wp-includes/class-wp-tax-query.php @@ -589,8 +589,6 @@ class WP_Tax_Query { * * @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', * or 'term_id'. Default 'term_id'. diff --git a/src/wp-includes/class-wp-term-query.php b/src/wp-includes/class-wp-term-query.php index 18c85e89b2..ae391bfcf5 100644 --- a/src/wp-includes/class-wp-term-query.php +++ b/src/wp-includes/class-wp-term-query.php @@ -910,8 +910,6 @@ class WP_Term_Query { * * @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. */