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

audrasjb · audrasjb · commit ee09cadd94d5 · 2022-12-09T11:52:58.000Z
Props upadalavipul. See #57069, #56792. git-svn-id: https://develop.svn.wordpress.org/trunk@54953 602fd350-edb4-49c9-b593-d223f7449a82
diff --git a/src/wp-admin/includes/class-wp-debug-data.php b/src/wp-admin/includes/class-wp-debug-data.php
@@ -30,6 +30,7 @@ public static function check_for_updates() {
 	 *
 	 * @throws ImagickException
 	 * @global wpdb $wpdb WordPress database abstraction object.
+	 * @global $_wp_theme_features
 	 *
 	 * @return array The debug data for the site.
 	 */
@@ -1558,6 +1559,8 @@ public static function format( $info_array, $data_type ) {
 	 *
 	 * @since 5.2.0
 	 *
+	 * @global wpdb $wpdb WordPress database abstraction object.
+	 *
 	 * @return int The size of the database, in bytes.
 	 */
 	public static function get_database_size() {
diff --git a/src/wp-admin/includes/class-wp-site-health.php b/src/wp-admin/includes/class-wp-site-health.php
@@ -1284,6 +1284,8 @@ public function get_test_sql_server() {
 	 *
 	 * @since 5.2.0
 	 *
+	 * @global wpdb $wpdb WordPress database abstraction object.
+	 *
 	 * @return array The test results.
 	 */
 	public function get_test_utf8mb4_support() {
diff --git a/src/wp-admin/includes/deprecated.php b/src/wp-admin/includes/deprecated.php
@@ -524,6 +524,8 @@ public function WP_User_Search( $search_term = '', $page = '', $role = '' ) {
 	 *
 	 * @since 2.1.0
 	 * @access public
+	 *
+	 * @global wpdb $wpdb WordPress database abstraction object.
 	 */
 	public function prepare_query() {
 		global $wpdb;
@@ -562,6 +564,8 @@ public function prepare_query() {
 	 *
 	 * @since 2.1.0
 	 * @access public
+	 *
+	 * @global wpdb $wpdb WordPress database abstraction object.
 	 */
 	public function query() {
 		global $wpdb;
diff --git a/src/wp-admin/includes/export.php b/src/wp-admin/includes/export.php
@@ -318,6 +318,8 @@ function wxr_term_description( $term ) {
 	 *
 	 * @since 4.6.0
 	 *
+	 * @global wpdb $wpdb WordPress database abstraction object.
+	 *
 	 * @param WP_Term $term Term object.
 	 */
 	function wxr_term_meta( $term ) {
diff --git a/src/wp-includes/ms-deprecated.php b/src/wp-includes/ms-deprecated.php
@@ -179,6 +179,8 @@ function validate_email( $email, $check_domain = true) {
  * @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.
  * @param int    $num        Optional. Number of blogs to list. Default 10.
  * @param string $deprecated Unused.
diff --git a/src/wp-includes/ms-functions.php b/src/wp-includes/ms-functions.php
@@ -1279,6 +1279,8 @@ function wpmu_activate_signup( $key ) {
  *
  * @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.
  * @param WP_User  $user     User object.
diff --git a/src/wp-includes/option.php b/src/wp-includes/option.php
@@ -1033,6 +1033,8 @@ function set_transient( $transient, $value, $expiration = 0 ) {
  * 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
  *
  * @param bool $force_db Optional. Force cleanup to run against the database even when an external object cache is used.
diff --git a/src/wp-includes/post.php b/src/wp-includes/post.php
@@ -7953,6 +7953,8 @@ function wp_add_trashed_suffix_to_post_name_for_trashed_posts( $post_name, $post
  * @since 4.5.0
  * @access private
  *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
  * @param WP_Post $post The post.
  * @return string New slug for the post.
  */
diff --git a/src/wp-includes/user.php b/src/wp-includes/user.php
@@ -3508,6 +3508,8 @@ function wp_destroy_all_sessions() {
  * @since 4.4.0
  * @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.
  */

Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,7 @@ public static function check_for_updates() {`
`30`	`30`	`*`
`31`	`31`	`* @throws ImagickException`
`32`	`32`	`* @global wpdb $wpdb WordPress database abstraction object.`
	`33`	`+ * @global $_wp_theme_features`
`33`	`34`	`*`
`34`	`35`	`* @return array The debug data for the site.`
`35`	`36`	`*/`
`@@ -1558,6 +1559,8 @@ public static function format( $info_array, $data_type ) {`
`1558`	`1559`	`*`
`1559`	`1560`	`* @since 5.2.0`
`1560`	`1561`	`*`
	`1562`	`+ * @global wpdb $wpdb WordPress database abstraction object.`
	`1563`	`+ *`
`1561`	`1564`	`* @return int The size of the database, in bytes.`
`1562`	`1565`	`*/`
`1563`	`1566`	`public static function get_database_size() {`
Original file line number	Diff line number	Diff line change
`@@ -1284,6 +1284,8 @@ public function get_test_sql_server() {`
`1284`	`1284`	`*`
`1285`	`1285`	`* @since 5.2.0`
`1286`	`1286`	`*`
	`1287`	`+ * @global wpdb $wpdb WordPress database abstraction object.`
	`1288`	`+ *`
`1287`	`1289`	`* @return array The test results.`
`1288`	`1290`	`*/`
`1289`	`1291`	`public function get_test_utf8mb4_support() {`
Original file line number	Diff line number	Diff line change
`@@ -318,6 +318,8 @@ function wxr_term_description( $term ) {`
`318`	`318`	`*`
`319`	`319`	`* @since 4.6.0`
`320`	`320`	`*`
	`321`	`+ * @global wpdb $wpdb WordPress database abstraction object.`
	`322`	`+ *`
`321`	`323`	`* @param WP_Term $term Term object.`
`322`	`324`	`*/`
`323`	`325`	`function wxr_term_meta( $term ) {`
Original file line number	Diff line number	Diff line change
`@@ -179,6 +179,8 @@ function validate_email( $email, $check_domain = true) {`
`179`	`179`	`* @deprecated 3.0.0 Use wp_get_sites()`
`180`	`180`	`* @see wp_get_sites()`
`181`	`181`	`*`
	`182`	`+ * @global wpdb $wpdb WordPress database abstraction object.`
	`183`	`+ *`
`182`	`184`	`* @param int $start Optional. Offset for retrieving the blog list. Default 0.`
`183`	`185`	`* @param int $num Optional. Number of blogs to list. Default 10.`
`184`	`186`	`* @param string $deprecated Unused.`
Original file line number	Diff line number	Diff line change
`@@ -1279,6 +1279,8 @@ function wpmu_activate_signup( $key ) {`
`1279`	`1279`	`*`
`1280`	`1280`	`* @since 5.5.0`
`1281`	`1281`	`*`
	`1282`	`+ * @global wpdb $wpdb WordPress database abstraction object.`
	`1283`	`+ *`
`1282`	`1284`	`* @param int $id ID of the user to delete.`
`1283`	`1285`	`* @param int\|null $reassign ID of the user to reassign posts and links to.`
`1284`	`1286`	`* @param WP_User $user User object.`
Original file line number	Diff line number	Diff line change
`@@ -1033,6 +1033,8 @@ function set_transient( $transient, $value, $expiration = 0 ) {`
`1033`	`1033`	`* The multi-table delete syntax is used to delete the transient record`
`1034`	`1034`	`* from table a, and the corresponding transient_timeout record from table b.`
`1035`	`1035`	`*`
	`1036`	`+ * @global wpdb $wpdb WordPress database abstraction object.`
	`1037`	`+ *`
`1036`	`1038`	`* @since 4.9.0`
`1037`	`1039`	`*`
`1038`	`1040`	`* @param bool $force_db Optional. Force cleanup to run against the database even when an external object cache is used.`
Original file line number	Diff line number	Diff line change
`@@ -7953,6 +7953,8 @@ function wp_add_trashed_suffix_to_post_name_for_trashed_posts( $post_name, $post`
`7953`	`7953`	`* @since 4.5.0`
`7954`	`7954`	`* @access private`
`7955`	`7955`	`*`
	`7956`	`+ * @global wpdb $wpdb WordPress database abstraction object.`
	`7957`	`+ *`
`7956`	`7958`	`* @param WP_Post $post The post.`
`7957`	`7959`	`* @return string New slug for the post.`
`7958`	`7960`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -3508,6 +3508,8 @@ function wp_destroy_all_sessions() {`
`3508`	`3508`	`* @since 4.4.0`
`3509`	`3509`	* @since 4.9.0 The `$site_id` parameter was added to support multisite.
`3510`	`3510`	`*`
	`3511`	`+ * @global wpdb $wpdb WordPress database abstraction object.`
	`3512`	`+ *`
`3511`	`3513`	`* @param int\|null $site_id Optional. The site ID to get users with no role for. Defaults to the current site.`
`3512`	`3514`	`* @return string[] Array of user IDs as strings.`
`3513`	`3515`	`*/`