Docs: Add missing descriptions for the $wpdb global in DocBlocks all the places.

See #32246.

Built from https://develop.svn.wordpress.org/trunk@35170


git-svn-id: http://core.svn.wordpress.org/trunk@35136 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes
2015-10-14 23:44:25 +00:00
parent 43c10f7d35
commit 217b661703
41 changed files with 141 additions and 141 deletions

View File

@@ -12,7 +12,7 @@ class WP_Importer {
/**
* Returns array with imported permalinks from WordPress database
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param string $importer_name
* @param string $bid
@@ -52,7 +52,7 @@ class WP_Importer {
/**
* Return count of imported permalinks from WordPress database
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param string $importer_name
* @param string $bid
@@ -81,7 +81,7 @@ class WP_Importer {
/**
* Set array with imported comments from WordPress database
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param string $bid
* @return array

View File

@@ -2693,7 +2693,7 @@ class WP_Automatic_Updater {
* @since 3.7.0
* @access public
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param string $type The type of update being checked: 'core', 'theme',
* 'plugin', 'translation'.

View File

@@ -260,7 +260,7 @@ function export_wp( $args = array() ) {
*
* @since 3.1.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param array $post_ids Array of post IDs to filter the query by. Optional.
*/

View File

@@ -36,7 +36,7 @@ function media_upload_tabs() {
*
* @since 2.5.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param array $tabs
* @return array $tabs with gallery if post has image attachment

View File

@@ -47,7 +47,7 @@ function check_upload_size( $file ) {
*
* @since 3.0.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param int $blog_id Blog ID.
* @param bool $drop True if blog's table should be dropped. Default is false.
@@ -177,7 +177,7 @@ function wpmu_delete_blog( $blog_id, $drop = false ) {
*
* @todo Merge with wp_delete_user() ?
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param int $id The user ID.
* @return bool True if the user was deleted, otherwise false.
@@ -505,7 +505,7 @@ function upload_space_setting( $id ) {
*
* @since 3.0.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param int $id The user ID.
* @param string $pref The column in the wp_users table to update the user's status
@@ -936,7 +936,7 @@ function revoke_super_admin( $user_id ) {
*
* @since 3.1.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param int $site_id The network/site ID to check.
* @return bool True if network can be edited, otherwise false.

View File

@@ -936,7 +936,7 @@ function wp_nav_menu_manage_columns() {
* @access private
* @since 3.0.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*/
function _wp_delete_orphaned_draft_menu_items() {
global $wpdb;

View File

@@ -12,7 +12,7 @@
*
* @since 3.0.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*
* @return Whether a network exists.
*/
@@ -45,7 +45,7 @@ function allow_subdomain_install() {
*
* @since 3.0.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*
* @return bool Whether subdirectory install is allowed
*/
@@ -293,7 +293,7 @@ function network_step1( $errors = false ) {
*
* @since 3.0.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param WP_Error $errors
*/

View File

@@ -173,7 +173,7 @@ function _wp_translate_postdata( $update = false, $post_data = null ) {
*
* @since 1.5.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param array $post_data Optional.
* @return int Post ID.
@@ -403,7 +403,7 @@ function edit_post( $post_data = null ) {
*
* @since 2.7.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param array $post_data Optional, the array of post data to process if not provided will use $_POST superglobal.
* @return array
@@ -659,7 +659,7 @@ function get_default_post_to_edit( $post_type = 'post', $create_in_db = false )
*
* @since 2.0.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param string $title Post title
* @param string $content Optional post content
@@ -843,7 +843,7 @@ function delete_meta( $mid ) {
*
* @since 1.2.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*
* @return mixed
*/
@@ -876,7 +876,7 @@ function get_post_meta_by_id( $mid ) {
*
* @since 1.2.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param int $postid
* @return mixed
@@ -1074,7 +1074,7 @@ function wp_edit_posts_query( $q = false ) {
*
* @since 2.5.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param string $type
* @return mixed

View File

@@ -27,7 +27,7 @@ $charset_collate = $wpdb->get_charset_collate();
*
* @since 3.3.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param string $scope Optional. The tables for which to retrieve SQL. Can be all, global, ms_global, or blog tables. Defaults to all.
* @param int $blog_id Optional. The blog ID for which to retrieve SQL. Default is the current blog ID.

View File

@@ -568,7 +568,7 @@ function _list_meta_row( $entry, &$count ) {
*
* @since 1.2.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param WP_Post $post Optional. The post being edited.
*/
@@ -758,7 +758,7 @@ function page_template_dropdown( $default = '' ) {
* @since 1.5.0
* @since 4.4.0 `$post` argument was added.
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param int $default Optional. The default page ID to be pre-selected. Default 0.
* @param int $parent Optional. The parent page ID. Default 0.

View File

@@ -392,7 +392,7 @@ if ( !function_exists('wp_upgrade') ) :
*
* @global int $wp_current_db_version
* @global int $wp_db_version
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*/
function wp_upgrade() {
global $wp_current_db_version, $wp_db_version, $wpdb;
@@ -554,7 +554,7 @@ function upgrade_all() {
*
* @since 1.0.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*/
function upgrade_100() {
global $wpdb;
@@ -612,7 +612,7 @@ function upgrade_100() {
*
* @since 1.0.1
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*/
function upgrade_101() {
global $wpdb;
@@ -632,7 +632,7 @@ function upgrade_101() {
*
* @since 1.2.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*/
function upgrade_110() {
global $wpdb;
@@ -694,7 +694,7 @@ function upgrade_110() {
*
* @since 1.5.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*/
function upgrade_130() {
global $wpdb;
@@ -780,7 +780,7 @@ function upgrade_130() {
*
* @since 2.0.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
* @global int $wp_current_db_version
*/
function upgrade_160() {
@@ -866,7 +866,7 @@ function upgrade_160() {
*
* @since 2.1.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
* @global int $wp_current_db_version
*/
function upgrade_210() {
@@ -913,7 +913,7 @@ function upgrade_210() {
*
* @since 2.3.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
* @global int $wp_current_db_version
*/
function upgrade_230() {
@@ -1092,7 +1092,7 @@ function upgrade_230() {
*
* @since 2.3.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*/
function upgrade_230_options_table() {
global $wpdb;
@@ -1108,7 +1108,7 @@ function upgrade_230_options_table() {
*
* @since 2.3.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*/
function upgrade_230_old_tables() {
global $wpdb;
@@ -1122,7 +1122,7 @@ function upgrade_230_old_tables() {
*
* @since 2.2.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*/
function upgrade_old_slugs() {
// Upgrade people who were using the Redirect Old Slugs plugin.
@@ -1151,7 +1151,7 @@ function upgrade_250() {
*
* @since 2.5.2
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*/
function upgrade_252() {
global $wpdb;
@@ -1178,7 +1178,7 @@ function upgrade_260() {
*
* @since 2.7.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
* @global int $wp_current_db_version
*/
function upgrade_270() {
@@ -1198,7 +1198,7 @@ function upgrade_270() {
* @since 2.8.0
*
* @global int $wp_current_db_version
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*/
function upgrade_280() {
global $wp_current_db_version, $wpdb;
@@ -1247,7 +1247,7 @@ function upgrade_290() {
* @since 3.0.0
*
* @global int $wp_current_db_version
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*/
function upgrade_300() {
global $wp_current_db_version, $wpdb;
@@ -2568,7 +2568,7 @@ function maybe_disable_automattic_widgets() {
* @since 3.5.0
*
* @global int $wp_current_db_version
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*/
function maybe_disable_link_manager() {
global $wp_current_db_version, $wpdb;
@@ -2583,7 +2583,7 @@ function maybe_disable_link_manager() {
* @since 2.9.0
*
* @global int $wp_current_db_version
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*/
function pre_schema_upgrade() {
global $wp_current_db_version, $wpdb;

View File

@@ -234,7 +234,7 @@ function get_user_to_edit( $user_id ) {
*
* @since 2.0.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param int $user_id User ID.
* @return array
@@ -264,7 +264,7 @@ function get_users_drafts( $user_id ) {
*
* @since 2.0.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param int $id User ID.
* @param int $reassign Optional. Reassign posts and links to new User ID.