Changeset 54953

Timestamp:

12/09/2022 11:52:58 AM (22 months ago)

Author:

audrasjb

Message:

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

Props upadalavipul.
See #57069, #56792.

Location:

trunk/src

Files:

• wp-admin/includes/class-wp-debug-data.php (modified) (2 diffs)
• wp-admin/includes/class-wp-site-health.php (modified) (1 diff)
• wp-admin/includes/deprecated.php (modified) (2 diffs)
• wp-admin/includes/export.php (modified) (1 diff)
• wp-includes/ms-deprecated.php (modified) (1 diff)
• wp-includes/ms-functions.php (modified) (1 diff)
• wp-includes/option.php (modified) (1 diff)
• wp-includes/post.php (modified) (1 diff)
• wp-includes/user.php (modified) (1 diff)

trunk/src/wp-admin/includes/class-wp-debug-data.php

@@ -31 +31 @@
      * @throws ImagickException
      * @global wpdb $wpdb WordPress database abstraction object.
+     * @global $_wp_theme_features
      *
      * @return array The debug data for the site.
@@ -1559 +1560 @@
      * @since 5.2.0
      *
+     * @global wpdb $wpdb WordPress database abstraction object.
+     *
      * @return int The size of the database, in bytes.
      */

trunk/src/wp-admin/includes/class-wp-site-health.php

@@ -1284 +1284 @@
      *
      * @since 5.2.0
+     *
+     * @global wpdb $wpdb WordPress database abstraction object.
      *
      * @return array The test results.

trunk/src/wp-admin/includes/deprecated.php

@@ -525 +525 @@
      * @since 2.1.0
      * @access public
+     *
+     * @global wpdb $wpdb WordPress database abstraction object.
      */
     public function prepare_query() {
@@ -563 +565 @@
      * @since 2.1.0
      * @access public
+     *
+     * @global wpdb $wpdb WordPress database abstraction object.
      */
     public function query() {

trunk/src/wp-admin/includes/export.php

@@ -318 +318 @@
      *
      * @since 4.6.0
+     *
+     * @global wpdb $wpdb WordPress database abstraction object.
      *
      * @param WP_Term $term Term object.

trunk/src/wp-includes/ms-deprecated.php

@@ -179 +179 @@
  * @deprecated 3.0.0 Use wp_get_sites()
  * @see wp_get_sites()
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param int    $start      Optional. Offset for retrieving the blog list. Default 0.

trunk/src/wp-includes/ms-functions.php

@@ -1280 +1280 @@
  * @since 5.5.0
  *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
  * @param int      $id       ID of the user to delete.
  * @param int|null $reassign ID of the user to reassign posts and links to.

trunk/src/wp-includes/option.php

@@ -1033 +1033 @@
  * The multi-table delete syntax is used to delete the transient record
  * from table a, and the corresponding transient_timeout record from table b.
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @since 4.9.0

trunk/src/wp-includes/post.php

@@ -7954 +7954 @@
  * @access private
  *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
  * @param WP_Post $post The post.
  * @return string New slug for the post.

trunk/src/wp-includes/user.php

@@ -3509 +3509 @@
  * @since 4.9.0 The `$site_id` parameter was added to support multisite.
  *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
  * @param int|null $site_id Optional. The site ID to get users with no role for. Defaults to the current site.
  * @return string[] Array of user IDs as strings.