Docs: Add missing description for `$wpdb`, `$wp_db_version`, and `$wp_current_db_version` globals.

Props mukesh27, utsav72640, immeet94, SergeyBiryukov.
See #45604.
Built from https://develop.svn.wordpress.org/trunk@45734


git-svn-id: http://core.svn.wordpress.org/trunk@45545 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov 2019-08-04 01:12:56 +00:00
parent 702ee129ad
commit 29b072e706
29 changed files with 94 additions and 96 deletions

View File

@ -535,7 +535,7 @@ class WP_List_Table {
*
* @since 3.1.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
* @global WP_Locale $wp_locale
*
* @param string $post_type

View File

@ -64,7 +64,7 @@ class WP_MS_Sites_List_Table extends WP_List_Table {
*
* @global string $s
* @global string $mode
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*/
public function prepare_items() {
global $s, $mode, $wpdb;

View File

@ -67,7 +67,7 @@ class WP_Posts_List_Table extends WP_List_Table {
* @see WP_List_Table::__construct() for more information on default arguments.
*
* @global WP_Post_Type $post_type_object
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param array $args An associative array of arguments.
*/
@ -740,7 +740,7 @@ class WP_Posts_List_Table extends WP_List_Table {
}
/**
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
* @global WP_Post $post
* @param array $pages
* @param int $pagenum

View File

@ -2526,7 +2526,7 @@ jQuery(function($){
*
* @since 2.5.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
* @global WP_Query $wp_query
* @global WP_Locale $wp_locale
* @global string $type

View File

@ -673,7 +673,7 @@ function mu_dropdown_languages( $lang_files = array(), $current = '' ) {
*
* @since 3.0.0
*
* @global int $wp_db_version The version number of the database.
* @global int $wp_db_version WordPress database version.
* @global string $pagenow
*
* @return false False if the current user is not a super admin.

View File

@ -11,7 +11,7 @@
/**
* Declare these as global in case schema.php is included from a function.
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
* @global array $wp_queries
* @global string $charset_collate
*/
@ -358,9 +358,9 @@ $wp_queries = wp_get_db_schema( 'all' );
* @since 1.5.0
* @since 5.1.0 The $options parameter has been added.
*
* @global wpdb $wpdb WordPress database abstraction object.
* @global int $wp_db_version
* @global int $wp_current_db_version
* @global wpdb $wpdb WordPress database abstraction object.
* @global int $wp_db_version WordPress database version.
* @global int $wp_current_db_version The old (current) database version.
*
* @param array $options Optional. Custom option $key => $value pairs to use. Default empty array.
*/

View File

@ -869,7 +869,7 @@ $_new_bundled_files = array(
* @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
* @global array $_old_files
* @global array $_new_bundled_files
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
* @global string $wp_version
* @global string $required_php_version
* @global string $required_mysql_version

View File

@ -129,7 +129,7 @@ if ( ! function_exists( 'wp_install_defaults' ) ) :
*
* @since 2.1.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
* @global WP_Rewrite $wp_rewrite
* @global string $table_prefix
*
@ -620,9 +620,9 @@ if ( ! function_exists( 'wp_upgrade' ) ) :
*
* @since 2.1.0
*
* @global int $wp_current_db_version
* @global int $wp_db_version
* @global wpdb $wpdb WordPress database abstraction object.
* @global int $wp_current_db_version The old (current) database version.
* @global int $wp_db_version The new database version.
* @global wpdb $wpdb WordPress database abstraction object.
*/
function wp_upgrade() {
global $wp_current_db_version, $wp_db_version, $wpdb;
@ -679,8 +679,8 @@ endif;
* @ignore
* @since 1.0.1
*
* @global int $wp_current_db_version
* @global int $wp_db_version
* @global int $wp_current_db_version The old (current) database version.
* @global int $wp_db_version The new database version.
*/
function upgrade_all() {
global $wp_current_db_version, $wp_db_version;
@ -1066,8 +1066,8 @@ function upgrade_130() {
* @ignore
* @since 2.0.0
*
* @global wpdb $wpdb WordPress database abstraction object.
* @global int $wp_current_db_version
* @global wpdb $wpdb WordPress database abstraction object.
* @global int $wp_current_db_version The old (current) database version.
*/
function upgrade_160() {
global $wpdb, $wp_current_db_version;
@ -1185,11 +1185,11 @@ function upgrade_160() {
* @ignore
* @since 2.1.0
*
* @global wpdb $wpdb WordPress database abstraction object.
* @global int $wp_current_db_version
* @global int $wp_current_db_version The old (current) database version.
* @global wpdb $wpdb WordPress database abstraction object.
*/
function upgrade_210() {
global $wpdb, $wp_current_db_version;
global $wp_current_db_version, $wpdb;
if ( $wp_current_db_version < 3506 ) {
// Update status and type.
@ -1237,8 +1237,8 @@ function upgrade_210() {
* @ignore
* @since 2.3.0
*
* @global wpdb $wpdb WordPress database abstraction object.
* @global int $wp_current_db_version
* @global int $wp_current_db_version The old (current) database version.
* @global wpdb $wpdb WordPress database abstraction object.
*/
function upgrade_230() {
global $wp_current_db_version, $wpdb;
@ -1511,7 +1511,7 @@ function upgrade_old_slugs() {
* @ignore
* @since 2.5.0
*
* @global int $wp_current_db_version
* @global int $wp_current_db_version The old (current) database version.
*/
function upgrade_250() {
global $wp_current_db_version;
@ -1542,7 +1542,7 @@ function upgrade_252() {
* @ignore
* @since 2.6.0
*
* @global int $wp_current_db_version
* @global int $wp_current_db_version The old (current) database version.
*/
function upgrade_260() {
global $wp_current_db_version;
@ -1558,11 +1558,11 @@ function upgrade_260() {
* @ignore
* @since 2.7.0
*
* @global wpdb $wpdb WordPress database abstraction object.
* @global int $wp_current_db_version
* @global int $wp_current_db_version The old (current) database version.
* @global wpdb $wpdb WordPress database abstraction object.
*/
function upgrade_270() {
global $wpdb, $wp_current_db_version;
global $wp_current_db_version, $wpdb;
if ( $wp_current_db_version < 8980 ) {
populate_roles_270();
@ -1580,8 +1580,8 @@ function upgrade_270() {
* @ignore
* @since 2.8.0
*
* @global int $wp_current_db_version
* @global wpdb $wpdb WordPress database abstraction object.
* @global int $wp_current_db_version The old (current) database version.
* @global wpdb $wpdb WordPress database abstraction object.
*/
function upgrade_280() {
global $wp_current_db_version, $wpdb;
@ -1613,7 +1613,7 @@ function upgrade_280() {
* @ignore
* @since 2.9.0
*
* @global int $wp_current_db_version
* @global int $wp_current_db_version The old (current) database version.
*/
function upgrade_290() {
global $wp_current_db_version;
@ -1633,8 +1633,8 @@ function upgrade_290() {
* @ignore
* @since 3.0.0
*
* @global int $wp_current_db_version
* @global wpdb $wpdb WordPress database abstraction object.
* @global int $wp_current_db_version The old (current) database version.
* @global wpdb $wpdb WordPress database abstraction object.
*/
function upgrade_300() {
global $wp_current_db_version, $wpdb;
@ -1684,8 +1684,8 @@ function upgrade_300() {
* @ignore
* @since 3.3.0
*
* @global int $wp_current_db_version
* @global wpdb $wpdb
* @global int $wp_current_db_version The old (current) database version.
* @global wpdb $wpdb WordPress database abstraction object.
* @global array $wp_registered_widgets
* @global array $sidebars_widgets
*/
@ -1765,8 +1765,8 @@ function upgrade_330() {
* @ignore
* @since 3.4.0
*
* @global int $wp_current_db_version
* @global wpdb $wpdb
* @global int $wp_current_db_version The old (current) database version.
* @global wpdb $wpdb WordPress database abstraction object.
*/
function upgrade_340() {
global $wp_current_db_version, $wpdb;
@ -1802,8 +1802,8 @@ function upgrade_340() {
* @ignore
* @since 3.5.0
*
* @global int $wp_current_db_version
* @global wpdb $wpdb
* @global int $wp_current_db_version The old (current) database version.
* @global wpdb $wpdb WordPress database abstraction object.
*/
function upgrade_350() {
global $wp_current_db_version, $wpdb;
@ -1839,7 +1839,7 @@ function upgrade_350() {
* @ignore
* @since 3.7.0
*
* @global int $wp_current_db_version
* @global int $wp_current_db_version The old (current) database version.
*/
function upgrade_370() {
global $wp_current_db_version;
@ -1855,7 +1855,7 @@ function upgrade_370() {
* @since 3.7.2
* @since 3.8.0
*
* @global int $wp_current_db_version
* @global int $wp_current_db_version The old (current) database version.
*/
function upgrade_372() {
global $wp_current_db_version;
@ -1870,7 +1870,7 @@ function upgrade_372() {
* @ignore
* @since 3.8.0
*
* @global int $wp_current_db_version
* @global int $wp_current_db_version The old (current) database version.
*/
function upgrade_380() {
global $wp_current_db_version;
@ -1885,7 +1885,7 @@ function upgrade_380() {
* @ignore
* @since 4.0.0
*
* @global int $wp_current_db_version
* @global int $wp_current_db_version The old (current) database version.
*/
function upgrade_400() {
global $wp_current_db_version;
@ -1905,9 +1905,6 @@ function upgrade_400() {
*
* @ignore
* @since 4.2.0
*
* @global int $wp_current_db_version
* @global wpdb $wpdb
*/
function upgrade_420() {}
@ -1917,7 +1914,7 @@ function upgrade_420() {}
* @ignore
* @since 4.3.0
*
* @global int $wp_current_db_version Current version.
* @global int $wp_current_db_version The old (current) database version.
* @global wpdb $wpdb WordPress database abstraction object.
*/
function upgrade_430() {
@ -1956,7 +1953,7 @@ function upgrade_430() {
* @ignore
* @since 4.3.0
*
* @global int $wp_current_db_version Current version.
* @global int $wp_current_db_version The old (current) database version.
* @global wpdb $wpdb WordPress database abstraction object.
*/
function upgrade_430_fix_comments() {
@ -2021,7 +2018,7 @@ function upgrade_431() {
* @ignore
* @since 4.4.0
*
* @global int $wp_current_db_version Current version.
* @global int $wp_current_db_version The old (current) database version.
* @global wpdb $wpdb WordPress database abstraction object.
*/
function upgrade_440() {
@ -2046,7 +2043,7 @@ function upgrade_440() {
* @ignore
* @since 4.5.0
*
* @global int $wp_current_db_version Current database version.
* @global int $wp_current_db_version The old (current) database version.
* @global wpdb $wpdb WordPress database abstraction object.
*/
function upgrade_450() {
@ -2071,7 +2068,7 @@ function upgrade_450() {
* @ignore
* @since 4.6.0
*
* @global int $wp_current_db_version Current database version.
* @global int $wp_current_db_version The old (current) database version.
*/
function upgrade_460() {
global $wp_current_db_version;
@ -2122,8 +2119,8 @@ function upgrade_510() {
*
* @since 3.0.0
*
* @global int $wp_current_db_version
* @global wpdb $wpdb
* @global int $wp_current_db_version The old (current) database version.
* @global wpdb $wpdb WordPress database abstraction object.
*/
function upgrade_network() {
global $wp_current_db_version, $wpdb;
@ -2282,7 +2279,7 @@ function upgrade_network() {
*
* @since 1.0.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param string $table_name Database table name to create.
* @param string $create_ddl SQL statement to create table.
@ -2312,7 +2309,7 @@ function maybe_create_table( $table_name, $create_ddl ) {
*
* @since 1.0.1
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param string $table Database table name.
* @param string $index Index name to drop.
@ -2335,7 +2332,7 @@ function drop_index( $table, $index ) {
*
* @since 1.0.1
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param string $table Database table name.
* @param string $index Database table index column.
@ -2353,7 +2350,7 @@ function add_clean_index( $table, $index ) {
*
* @since 1.3.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param string $table_name The table name to modify.
* @param string $column_name The column name to add to the table.
@ -2385,7 +2382,7 @@ function maybe_add_column( $table_name, $column_name, $create_ddl ) {
*
* @since 4.2.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param string $table The table to convert.
* @return bool true if the table was converted, false if it wasn't.
@ -2428,7 +2425,7 @@ function maybe_convert_table_to_utf8mb4( $table ) {
*
* @since 1.2.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*
* @return stdClass List of options.
*/
@ -2454,7 +2451,7 @@ function get_alloptions_110() {
* @since 1.5.1
* @access private
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param string $setting Option name.
* @return mixed
@ -2519,7 +2516,7 @@ function deslash( $content ) {
*
* @since 1.5.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param string[]|string $queries Optional. The query to run. Can be multiple queries
* in an array, or a string of queries separated by
@ -3183,7 +3180,7 @@ function translate_level_to_role( $level ) {
*
* @since 2.1.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*/
function wp_check_mysql_version() {
global $wpdb;
@ -3215,8 +3212,8 @@ function maybe_disable_automattic_widgets() {
*
* @since 3.5.0
*
* @global int $wp_current_db_version
* @global wpdb $wpdb WordPress database abstraction object.
* @global int $wp_current_db_version The old (current) database version.
* @global wpdb $wpdb WordPress database abstraction object.
*/
function maybe_disable_link_manager() {
global $wp_current_db_version, $wpdb;
@ -3231,8 +3228,8 @@ function maybe_disable_link_manager() {
*
* @since 2.9.0
*
* @global int $wp_current_db_version
* @global wpdb $wpdb WordPress database abstraction object.
* @global int $wp_current_db_version The old (current) database version.
* @global wpdb $wpdb WordPress database abstraction object.
*/
function pre_schema_upgrade() {
global $wp_current_db_version, $wpdb;
@ -3294,7 +3291,7 @@ if ( ! function_exists( 'install_global_terms' ) ) :
*
* @since 3.0.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
* @global string $charset_collate
*/
function install_global_terms() {

View File

@ -49,7 +49,7 @@ switch ( $action ) {
if ( $n < 5 ) {
/**
* @global string $wp_db_version
* @global int $wp_db_version WordPress database version.
*/
global $wp_db_version;
update_site_option( 'wpmu_upgrade_site', $wp_db_version );

View File

@ -25,7 +25,7 @@ if ( ! current_user_can( 'update_core' ) && ! current_user_can( 'update_themes'
/**
* @global string $wp_local_package
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*
* @staticvar bool $first_pass
*

View File

@ -31,8 +31,8 @@
* @global WP_Rewrite $wp_rewrite
* @global bool $is_IIS
* @global WP_Query $wp_query
* @global wpdb $wpdb WordPress database abstraction object.
* @global WP $wp Current WordPress environment instance.
* @global wpdb $wpdb WordPress database abstraction object.
* @global WP $wp Current WordPress environment instance.
*
* @param string $requested_url Optional. The URL that was requested, used to
* figure if redirect is needed.

View File

@ -771,7 +771,7 @@ function user_can( $user, $capability, ...$args ) {
*
* @since 4.3.0
*
* @global WP_Roles $wp_roles WP_Roles global instance.
* @global WP_Roles $wp_roles WordPress role management object.
*
* @return WP_Roles WP_Roles global instance if not already instantiated.
*/

View File

@ -3341,7 +3341,7 @@ final class WP_Customize_Manager {
*
* @since 4.7.0
* @see _wp_customize_publish_changeset()
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param int $changeset_post_id ID for customize_changeset post. Defaults to the changeset for the current manager instance.
* @return true|WP_Error True or error info.

View File

@ -499,7 +499,7 @@ class WP_Network_Query {
*
* @since 4.6.0
*
* @global wpdb $wpdb WordPress database abstraction object.
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param string $string Search string.
* @param string[] $columns Array of columns to search.

View File

@ -690,7 +690,7 @@ class WP_Site_Query {
*
* @since 4.6.0
*
* @global wpdb $wpdb WordPress database abstraction object.
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param string $string Search string.
* @param string[] $columns Array of columns to search.

View File

@ -1304,7 +1304,7 @@ function wp_comment_form_unfiltered_html_nonce() {
*
* @global WP_Query $wp_query
* @global WP_Post $post
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
* @global int $id
* @global WP_Comment $comment
* @global string $user_login

View File

@ -2370,7 +2370,7 @@ function update_usermeta( $user_id, $meta_key, $meta_value ) {
* @deprecated 3.1.0 Use get_users()
* @see get_users()
*
* @global wpdb $wpdb WordPress database abstraction object.
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param int $id Site ID.
* @return array List of users that are part of that site ID

View File

@ -1771,7 +1771,7 @@ function get_archives_link( $url, $text, $format = 'html', $before = '', $after
*
* @see get_archives_link()
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
* @global WP_Locale $wp_locale
*
* @param string|array $args {
@ -2041,7 +2041,7 @@ function calendar_week_mod( $num ) {
*
* @since 1.0.0
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
* @global int $m
* @global int $monthnum
* @global int $year

View File

@ -406,7 +406,7 @@ function wp_set_lang_dir() {
*
* @since 2.5.0
*
* @global wpdb $wpdb The WordPress database class.
* @global wpdb $wpdb WordPress database abstraction object.
*/
function require_wp_db() {
global $wpdb;
@ -437,7 +437,7 @@ function require_wp_db() {
* @since 3.0.0
* @access private
*
* @global wpdb $wpdb The WordPress database class.
* @global wpdb $wpdb WordPress database abstraction object.
* @global string $table_prefix The database table prefix.
*/
function wp_set_wpdb_vars() {

View File

@ -3560,7 +3560,7 @@ function wp_prepare_attachment_for_js( $attachment ) {
* @since 3.5.0
*
* @global int $content_width
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
* @global WP_Locale $wp_locale
*
* @param array $args {

View File

@ -477,7 +477,7 @@ function update_blog_option( $id, $option, $value, $deprecated = null ) {
* @see restore_current_blog()
* @since MU (3.0.0)
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
* @global int $blog_id
* @global array $_wp_switched_stack
* @global bool $switched
@ -557,7 +557,7 @@ function switch_to_blog( $new_blog, $deprecated = null ) {
* @see switch_to_blog()
* @since MU (3.0.0)
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
* @global array $_wp_switched_stack
* @global int $blog_id
* @global bool $switched

View File

@ -596,8 +596,8 @@ function insert_blog($domain, $path, $site_id) {
* @since MU (3.0.0)
* @deprecated 5.1.0
*
* @global wpdb $wpdb
* @global WP_Roles $wp_roles
* @global wpdb $wpdb WordPress database abstraction object.
* @global WP_Roles $wp_roles WordPress role management object.
*
* @param int $blog_id The value returned by wp_insert_site().
* @param string $blog_title The title of the new site.

View File

@ -586,7 +586,7 @@ function wpmu_validate_user_signup( $user_name, $user_email ) {
*
* @since MU (3.0.0)
*
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
* @global string $domain
*
* @param string $blogname The blog name provided by the user. Must be unique.

View File

@ -2413,7 +2413,7 @@ function wp_insert_term( $term, $taxonomy, $args = array() ) {
*
* @since 2.3.0
*
* @global wpdb $wpdb The WordPress database abstraction object.
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param int $object_id The object to relate to.
* @param string|int|array $terms A single term slug, single term id, or array of either term slugs or ids.
@ -3214,7 +3214,7 @@ function clean_object_term_cache( $object_ids, $object_type ) {
*
* @since 2.3.0
*
* @global wpdb $wpdb WordPress database abstraction object.
* @global wpdb $wpdb WordPress database abstraction object.
* @global bool $_wp_suspend_cache_invalidation
*
* @param int|array $ids Single or list of Term IDs.

View File

@ -688,7 +688,7 @@ function locate_template( $template_names, $load = false, $require_once = true )
* @global bool $wp_did_header
* @global WP_Query $wp_query
* @global WP_Rewrite $wp_rewrite
* @global wpdb $wpdb
* @global wpdb $wpdb WordPress database abstraction object.
* @global string $wp_version
* @global WP $wp
* @global int $id

View File

@ -3260,10 +3260,11 @@ function is_customize_preview() {
* @access private
* @see wp_delete_auto_drafts()
*
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param string $new_status Transition to this post status.
* @param string $old_status Previous post status.
* @param \WP_Post $post Post data.
* @global wpdb $wpdb
*/
function _wp_keep_alive_customize_changeset_dependent_auto_drafts( $new_status, $old_status, $post ) {
global $wpdb;

View File

@ -14,8 +14,8 @@
* isn't installing.
*
* @since 2.3.0
* @global string $wp_version Used to check against the newest WordPress version.
* @global wpdb $wpdb
* @global string $wp_version Used to check against the newest WordPress version.
* @global wpdb $wpdb WordPress database abstraction object.
* @global string $wp_local_package
*
* @param array $extra_stats Extra statistics to report to the WordPress.org API.

View File

@ -13,7 +13,7 @@
*
* @global string $wp_version
*/
$wp_version = '5.3-alpha-45733';
$wp_version = '5.3-alpha-45734';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.

View File

@ -447,7 +447,7 @@ $GLOBALS['wp_widget_factory'] = new WP_Widget_Factory();
/**
* WordPress User Roles
*
* @global WP_Roles $wp_roles
* @global WP_Roles $wp_roles WordPress role management object.
* @since 2.0.0
*/
$GLOBALS['wp_roles'] = new WP_Roles();