Changeset 30122

Timestamp:

10/31/2014 05:55:39 PM (10 years ago)

Author:

DrewAPicture

Message:

Correct references of @uses $wpdb in core documentation to use @global.

See #30191, [30105].
Fixes #30217.

Location:

trunk/src

Files:

• wp-admin/export.php (modified) (1 diff)
• wp-admin/includes/comment.php (modified) (2 diffs)
• wp-admin/includes/schema.php (modified) (1 diff)
• wp-admin/install-helper.php (modified) (3 diffs)
• wp-includes/bookmark.php (modified) (2 diffs)
• wp-includes/canonical.php (modified) (1 diff)
• wp-includes/capabilities.php (modified) (1 diff)
• wp-includes/comment.php (modified) (14 diffs)
• wp-includes/deprecated.php (modified) (1 diff)
• wp-includes/functions.php (modified) (3 diffs)
• wp-includes/media.php (modified) (1 diff)
• wp-includes/meta.php (modified) (5 diffs)
• wp-includes/pluggable.php (modified) (2 diffs)
• wp-includes/post.php (modified) (7 diffs)
• wp-includes/query.php (modified) (2 diffs)
• wp-includes/taxonomy.php (modified) (18 diffs)
• wp-includes/user.php (modified) (1 diff)
• wp-login.php (modified) (1 diff)

trunk/src/wp-admin/export.php

@@ -113 +113 @@
  * Create the date options fields for exporting a given post type.
  *
- * @global wpdb      $wpdb      WordPress database object.
+ * @global wpdb      $wpdb      WordPress database abstraction object.
  * @global WP_Locale $wp_locale Date and Time Locale object.
  *

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

@@ -11 +11 @@
  *
  * @since 2.0.0
- * @uses $wpdb
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param string $comment_author Author of the comment
@@ -111 +112 @@
  *
  * @since 2.3.0
- * @uses $wpdb
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param int|array $post_id Either a single Post ID or an array of Post IDs

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

@@ -325 +325 @@
  *
  * @since 1.5.0
- * @uses $wpdb
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
  * @uses $wp_db_version
  */

trunk/src/wp-admin/install-helper.php

@@ -45 +45 @@
  * @since 1.0.0
  *
- * @uses $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param string $table_name Database table name.
@@ -77 +77 @@
  * @since 1.0.0
  *
- * @uses $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param string $table_name Database table name
@@ -111 +111 @@
  * @since 1.0.0
  *
- * @uses $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param string $table_name Table name

trunk/src/wp-includes/bookmark.php

@@ -11 +11 @@
  *
  * @since 2.1.0
- * @uses $wpdb Database Object
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param mixed $bookmark
@@ -92 +93 @@
  * @since 2.1.0
  *
- * @global wpdb $wpdb WordPress database access abstraction object.
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param string|array $args {

trunk/src/wp-includes/canonical.php

@@ -513 +513 @@
  *
  * @since 2.3.0
- * @uses $wpdb
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @return bool|string The correct URL if one is found. False on failure.

trunk/src/wp-includes/capabilities.php

@@ -105 +105 @@
      * @since 2.1.0
      * @access protected
-     * @uses $wpdb Used to get the database prefix.
+     *
+     * @global wpdb  $wpdb          WordPress database abstraction object.
      * @global array $wp_user_roles Used to set the 'roles' property value.
      */

trunk/src/wp-includes/comment.php

@@ -25 +25 @@
  * @since 1.2.0
  *
- * @global wpdb $wpdb WordPress database access abstraction object.
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param string $author       Comment author name.
@@ -156 +156 @@
  *
  * @since 2.0.0
- * @uses $wpdb
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param object|string|int $comment Comment to retrieve.
@@ -215 +216 @@
  *
  * @since 2.7.0
- * @uses $wpdb
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param mixed $args Optional. Array or string of options to override defaults.
@@ -758 +760 @@
  *
  * @since 1.5.0
- * @uses $wpdb
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param string $timezone Which timezone to use in reference to 'gmt', 'blog',
@@ -798 +801 @@
  *
  * @since 2.0.0
- * @uses $wpdb
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param int $post_id Optional. Comment amount in post if > 0, else total comments blog wide.
@@ -1016 +1020 @@
  *
  * @since 2.0.0
- * @uses $wpdb
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param array $commentdata Contains information on the comment
@@ -1133 +1138 @@
  *
  * @since 2.3.0
- * @uses $wpdb
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param string $ip Comment IP.
@@ -1436 +1442 @@
  *
  * @since 2.0.0
- * @uses $wpdb
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param int $comment_id Comment ID
@@ -1811 +1818 @@
  *
  * @since 2.0.0
- * @uses $wpdb
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param array $commentdata Contains information on the comment.
@@ -2106 +2114 @@
  *
  * @since 2.0.0
- * @uses $wpdb
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param array $commentarr Contains information on the comment.
@@ -2244 +2253 @@
  *
  * @since 2.5.0
- * @uses $wpdb
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param int $post_id Post ID
@@ -2358 +2368 @@
  *
  * @since 2.1.0
- * @uses $wpdb
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
  */
 function do_all_pings() {
@@ -2389 +2400 @@
  *
  * @since 1.5.0
- * @uses $wpdb
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param int $post_id Post ID to do trackbacks on.
@@ -2563 +2575 @@
  *
  * @since 0.71
- * @uses $wpdb
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param string $trackback_url URL to send trackbacks.

trunk/src/wp-includes/deprecated.php

@@ -2425 +2425 @@
  * @since 2.2.0
  * @deprecated 3.1.0
- * @uses $wpdb WordPress database object for queries
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
  * @uses $blog_id The Blog id of the blog for those that use more than one blog
  *

trunk/src/wp-includes/functions.php

@@ -1088 +1088 @@
  * @since 2.0.0
  *
- * @global wpdb $wpdb WordPress database access abstraction object.
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @return int Number of database queries.
@@ -1254 +1254 @@
  * @since 2.1.0
  *
- * @global wpdb $wpdb WordPress database access abstraction object.
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @return bool Whether the blog is already installed.
@@ -3239 +3239 @@
  * @since 2.3.2
  *
- * @global wpdb $wpdb WordPress database access abstraction object.
+ * @global wpdb $wpdb WordPress database abstraction object.
  */
 function dead_db() {

trunk/src/wp-includes/media.php

@@ -3261 +3261 @@
  * @since 4.0.0
  *
- * @global wpdb $wpdb WordPress database access abstraction object.
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param string $url The URL to resolve.

trunk/src/wp-includes/meta.php

@@ -16 +16 @@
  *
  * @since 2.9.0
- * @uses $wpdb WordPress database object for queries.
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
@@ -129 +130 @@
  *
  * @since 2.9.0
- * @uses $wpdb WordPress database object for queries.
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
@@ -279 +281 @@
  *
  * @since 2.9.0
- * @uses $wpdb WordPress database object for queries.
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
@@ -757 +760 @@
  *
  * @since 2.9.0
- * @uses $wpdb WordPress database object for queries.
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
@@ -1501 +1505 @@
  *
  * @since 2.9.0
- * @uses $wpdb WordPress database object for queries.
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param string $type Type of object to get metadata table for (e.g., comment, post, or user)

trunk/src/wp-includes/pluggable.php

@@ -1485 +1485 @@
  * @since 1.0.0
  *
- * @uses $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param int $comment_id Comment ID
@@ -2065 +2065 @@
  * @since 2.5.0
  *
- * @uses $wpdb WordPress database object for queries
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param string $password The plaintext new user password

trunk/src/wp-includes/post.php

@@ -1790 +1790 @@
  * @since 2.5.0
  *
- * @global wpdb $wpdb WordPress database access abstraction object.
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param int    $post_id   Optional. Post ID to change post type. Default 0.
@@ -2555 +2555 @@
  * @since 1.0.0
  *
- * @global wpdb $wpdb WordPress database access abstraction object.
+ * @global wpdb $wpdb WordPress database abstraction object.
  * @see wp_delete_attachment()
  * @see wp_trash_post()
@@ -2800 +2800 @@
  * @since 2.9.0
  *
- * @global wpdb $wpdb WordPress database access abstraction object.
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param int|WP_Post $post Optional. Post ID or post object. Defaults to global $post.
@@ -4742 +4742 @@
  * @since 2.0.0
  *
- * @global wpdb $wpdb WordPress database access abstraction object.
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param int  $post_id      Attachment ID.
@@ -5431 +5431 @@
  * @since 2.0.0
  *
- * @global wpdb $wpdb WordPress database access abstraction object.
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param int|WP_Post $post Post ID or post object to remove from the cache.
@@ -5589 +5589 @@
  *
  * @see wp_clear_scheduled_hook()
- * @global wpdb $wpdb WordPress database access abstraction object.
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param string  $new_status New post status.
@@ -5781 +5781 @@
  * @since 3.4.0
  *
- * @global wpdb $wpdb WordPress database access abstraction object.
+ * @global wpdb $wpdb WordPress database abstraction object.
  */
 function wp_delete_auto_drafts() {

trunk/src/wp-includes/query.php

@@ -2212 +2212 @@
      * @access protected
      *
-     * @global wpdb $wpdb WordPress database access abstraction object.
+     * @global wpdb $wpdb WordPress database abstraction object.
      *
      * @param string $orderby Alias for the field to order by.
@@ -4620 +4620 @@
  *
  * @since 2.1.0
+ *
  * @uses $wp_query
- * @uses $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @return null If no link is found, null is returned.

trunk/src/wp-includes/taxonomy.php

@@ -563 +563 @@
  * @since 2.3.0
  *
- * @uses $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param int|array $term_ids Term id or array of term ids of terms that will be used
@@ -1262 +1262 @@
  * @since 2.3.0
  *
- * @uses $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
  * @see sanitize_term_field() The $context param lists the available values for get_term_by() $filter param.
  *
@@ -1357 +1357 @@
  * @since 2.3.0
  *
- * @uses $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
  * @see sanitize_term_field() The $context param lists the available values for get_term_by() $filter param.
  *
@@ -1447 +1447 @@
  * @since 2.3.0
  *
- * @uses $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param string $term_id ID of Term to get children
@@ -1554 +1554 @@
  * @since 2.3.0
  *
- * @global wpdb $wpdb WordPress database access abstraction object.
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param string|array $taxonomies Taxonomy name or list of Taxonomy names.
@@ -2004 +2004 @@
  * @since 3.0.0
  *
- * @uses $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param int|string $term The term to check
@@ -2144 +2144 @@
  * @since 2.3.0
  *
- * @uses $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param string $field Term field to sanitize
@@ -2364 +2364 @@
  * @since 2.3.0
  *
- * @uses $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param int $term Term ID
@@ -2563 +2563 @@
  *
  * @since 2.3.0
- * @uses $wpdb
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param int|array $object_ids The ID(s) of the object(s) to retrieve.
@@ -2734 +2735 @@
  * or the term slug and name are not unique, a WP_Error object will be returned.
  *
- * @global wpdb $wpdb The WordPress database object.
+ * @global wpdb $wpdb WordPress database abstraction object.
 
  * @since 2.3.0
@@ -3090 +3091 @@
  *
  * @since 3.6.0
- * @uses $wpdb
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param int $object_id The ID of the object from which the terms will be removed.
@@ -3178 +3180 @@
  *
  * @since 2.3.0
- * @uses $wpdb
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param string $slug The string that will be tried for a unique slug
@@ -3250 +3253 @@
  * @since 2.3.0
  *
- * @uses $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param int $term_id The ID of the term
@@ -3495 +3498 @@
  *
  * @since 2.3.0
- * @uses $wpdb
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param int|array $terms The term_taxonomy_id of the terms
@@ -3608 +3612 @@
  *
  * @since 2.3.0
- * @uses $wpdb
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param int|array $ids Single or list of Term IDs
@@ -3871 +3876 @@
  * @access private
  * @since 2.3.0
- * @uses $wpdb
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param array $terms List of Term IDs
@@ -3935 +3941 @@
  * @access private
  * @since 2.3.0
- * @uses $wpdb
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param array $terms List of Term taxonomy IDs
@@ -3983 +3990 @@
  *
  * @since 3.3.0
- * @uses $wpdb
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param array $terms List of Term taxonomy IDs

trunk/src/wp-includes/user.php

@@ -807 +807 @@
          * @since 3.2.0
          *
-         * @global wpdb $wpdb WordPress database object.
+         * @global wpdb $wpdb WordPress database abstraction object.
          *
          * @param string $sql The SELECT FOUND_ROWS() query for the current WP_User_Query.

trunk/src/wp-login.php

@@ -264 +264 @@
  * Handles sending password retrieval email to user.
  *
- * @uses $wpdb WordPress Database object
+ * @global wpdb         $wpdb      WordPress database abstraction object.
+ * @global PasswordHash $wp_hasher Portable PHP password hashing framework.
  *
  * @return bool|WP_Error True: when finish. WP_Error on error