Changeset 45734 for trunk/src/wp-admin/includes/upgrade.php

Timestamp:

08/04/2019 01:11:01 AM (5 years ago)

Author:

SergeyBiryukov

Message:

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

Props mukesh27, utsav72640, immeet94, SergeyBiryukov.
See #45604.

File:

• trunk/src/wp-admin/includes/upgrade.php (modified) (38 diffs)

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

@@ -130 +130 @@
      * @since 2.1.0
      *
-     * @global wpdb       $wpdb
+     * @global wpdb       $wpdb         WordPress database abstraction object.
      * @global WP_Rewrite $wp_rewrite
      * @global string     $table_prefix
@@ -621 +621 @@
      * @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() {
@@ -680 +680 @@
  * @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() {
@@ -1067 +1067 @@
  * @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() {
@@ -1186 +1186 @@
  * @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 ) {
@@ -1238 +1238 @@
  * @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() {
@@ -1512 +1512 @@
  * @since 2.5.0
  *
- * @global int $wp_current_db_version
+ * @global int $wp_current_db_version The old (current) database version.
  */
 function upgrade_250() {
@@ -1543 +1543 @@
  * @since 2.6.0
  *
- * @global int $wp_current_db_version
+ * @global int $wp_current_db_version The old (current) database version.
  */
 function upgrade_260() {
@@ -1559 +1559 @@
  * @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 ) {
@@ -1581 +1581 @@
  * @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() {
@@ -1614 +1614 @@
  * @since 2.9.0
  *
- * @global int $wp_current_db_version
+ * @global int $wp_current_db_version The old (current) database version.
  */
 function upgrade_290() {
@@ -1634 +1634 @@
  * @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() {
@@ -1685 +1685 @@
  * @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
@@ -1766 +1766 @@
  * @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() {
@@ -1803 +1803 @@
  * @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() {
@@ -1840 +1840 @@
  * @since 3.7.0
  *
- * @global int $wp_current_db_version
+ * @global int $wp_current_db_version The old (current) database version.
  */
 function upgrade_370() {
@@ -1856 +1856 @@
  * @since 3.8.0
  *
- * @global int $wp_current_db_version
+ * @global int $wp_current_db_version The old (current) database version.
  */
 function upgrade_372() {
@@ -1871 +1871 @@
  * @since 3.8.0
  *
- * @global int $wp_current_db_version
+ * @global int $wp_current_db_version The old (current) database version.
  */
 function upgrade_380() {
@@ -1886 +1886 @@
  * @since 4.0.0
  *
- * @global int $wp_current_db_version
+ * @global int $wp_current_db_version The old (current) database version.
  */
 function upgrade_400() {
@@ -1906 +1906 @@
  * @ignore
  * @since 4.2.0
- *
- * @global int   $wp_current_db_version
- * @global wpdb  $wpdb
  */
 function upgrade_420() {}
@@ -1918 +1915 @@
  * @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.
  */
@@ -1957 +1954 @@
  * @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.
  */
@@ -2022 +2019 @@
  * @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.
  */
@@ -2047 +2044 @@
  * @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.
  */
@@ -2072 +2069 @@
  * @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() {
@@ -2123 +2120 @@
  * @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() {
@@ -2283 +2280 @@
  * @since 1.0.0
  *
- * @global wpdb  $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param string $table_name Database table name to create.
@@ -2313 +2310 @@
  * @since 1.0.1
  *
- * @global wpdb  $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param string $table Database table name.
@@ -2336 +2333 @@
  * @since 1.0.1
  *
- * @global wpdb  $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param string $table Database table name.
@@ -2354 +2351 @@
  * @since 1.3.0
  *
- * @global wpdb  $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param string $table_name  The table name to modify.
@@ -2386 +2383 @@
  * @since 4.2.0
  *
- * @global wpdb  $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param string $table The table to convert.
@@ -2429 +2426 @@
  * @since 1.2.0
  *
- * @global wpdb  $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @return stdClass List of options.
@@ -2455 +2452 @@
  * @access private
  *
- * @global wpdb  $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param string $setting Option name.
@@ -2520 +2517 @@
  * @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
@@ -3184 +3181 @@
  * @since 2.1.0
  *
- * @global wpdb  $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
  */
 function wp_check_mysql_version() {
@@ -3216 +3213 @@
  * @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() {
@@ -3232 +3229 @@
  * @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() {
@@ -3295 +3292 @@
      * @since 3.0.0
      *
-     * @global wpdb   $wpdb
+     * @global wpdb   $wpdb            WordPress database abstraction object.
      * @global string $charset_collate
      */