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

Timestamp:

05/12/2020 06:38:02 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve documentation for functions in wp-admin/install-helper.php per the documentation standards.

Synchronize descriptions with the functions' counterparts from wp-admin/includes/upgrade.php.

See #49572.

File:

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

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

@@ -2185 +2185 @@
     delete_expired_transients( true );
 
-    // 2.8
+    // 2.8.0
     if ( $wp_current_db_version < 11549 ) {
         $wpmu_sitewide_plugins   = get_site_option( 'wpmu_sitewide_plugins' );
@@ -2216 +2216 @@
     }
 
-    // 3.0
+    // 3.0.0
     if ( $wp_current_db_version < 13576 ) {
         update_site_option( 'global_terms_enabled', '1' );
     }
 
-    // 3.3
+    // 3.3.0
     if ( $wp_current_db_version < 19390 ) {
         update_site_option( 'initial_db_version', $wp_current_db_version );
@@ -2232 +2232 @@
     }
 
-    // 3.4
+    // 3.4.0
     if ( $wp_current_db_version < 20148 ) {
         // 'allowedthemes' keys things by stylesheet. 'allowed_themes' keyed things by name.
@@ -2250 +2250 @@
     }
 
-    // 3.5
+    // 3.5.0
     if ( $wp_current_db_version < 21823 ) {
         update_site_option( 'ms_files_rewriting', '1' );
@@ -2265 +2265 @@
     }
 
-    // 4.2
+    // 4.2.0
     if ( $wp_current_db_version < 31351 && 'utf8mb4' === $wpdb->charset ) {
         if ( wp_should_upgrade_global_tables() ) {
@@ -2286 +2286 @@
     }
 
-    // 4.3
+    // 4.3.0
     if ( $wp_current_db_version < 33055 && 'utf8mb4' === $wpdb->charset ) {
         if ( wp_should_upgrade_global_tables() ) {
@@ -2315 +2315 @@
     }
 
-    // 5.1
+    // 5.1.0
     if ( $wp_current_db_version < 44467 ) {
         $network_id = get_main_network_id();
@@ -2328 +2328 @@
 
 /**
- * Creates a table in the database if it doesn't already exist.
+ * Creates a table in the database, if it doesn't already exist.
  *
  * This method checks for an existing database and creates a new one if it's not
@@ -2338 +2338 @@
  * @global wpdb $wpdb WordPress database abstraction object.
  *
- * @param string $table_name Database table name to create.
+ * @param string $table_name Database table name.
  * @param string $create_ddl SQL statement to create table.
- * @return bool If table already exists or was created by function.
+ * @return bool True on success or if the table already exists. False on failure.
  */
 function maybe_create_table( $table_name, $create_ddl ) {
@@ -2411 +2411 @@
 
 /**
- * Adds column to a database table if it doesn't already exist.
+ * Adds column to a database table, if it doesn't already exist.
  *
  * @since 1.3.0
@@ -2417 +2417 @@
  * @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.
- * @param string $create_ddl  The SQL statement used to add the column.
- * @return bool True if already exists or on successful completion, false on error.
+ * @param string $table_name  Database table name.
+ * @param string $column_name Table column name.
+ * @param string $create_ddl  SQL statement to add column.
+ * @return bool True on success or if the column already exists. False on failure.
  */
 function maybe_add_column( $table_name, $column_name, $create_ddl ) {
@@ -2452 +2452 @@
  *
  * @param string $table The table to convert.
- * @return bool true if the table was converted, false if it wasn't.
+ * @return bool True if the table was converted, false if it wasn't.
  */
 function maybe_convert_table_to_utf8mb4( $table ) {