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

Timestamp:

05/29/2015 08:16:22 PM (9 years ago)

Author:

wonderboymusic

Message:

Add missing doc blocks to wp-admin/includes/*.
Fix some egregious uses of tabbing.
Some functions can simply return apply_filters(...) instead of setting a variable that is immediately returned.

See #32444.

File:

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

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

@@ -166 +166 @@
 
     $wpdb->insert( $wpdb->posts, array(
-                                'post_author' => $user_id,
-                                'post_date' => $now,
-                                'post_date_gmt' => $now_gmt,
-                                'post_content' => $first_post,
-                                'post_excerpt' => '',
-                                'post_title' => __('Hello world!'),
-                                /* translators: Default post slug */
-                                'post_name' => sanitize_title( _x('hello-world', 'Default post slug') ),
-                                'post_modified' => $now,
-                                'post_modified_gmt' => $now_gmt,
-                                'guid' => $first_post_guid,
-                                'comment_count' => 1,
-                                'to_ping' => '',
-                                'pinged' => '',
-                                'post_content_filtered' => ''
-                                ));
+        'post_author' => $user_id,
+        'post_date' => $now,
+        'post_date_gmt' => $now_gmt,
+        'post_content' => $first_post,
+        'post_excerpt' => '',
+        'post_title' => __('Hello world!'),
+        /* translators: Default post slug */
+        'post_name' => sanitize_title( _x('hello-world', 'Default post slug') ),
+        'post_modified' => $now,
+        'post_modified_gmt' => $now_gmt,
+        'guid' => $first_post_guid,
+        'comment_count' => 1,
+        'to_ping' => '',
+        'pinged' => '',
+        'post_content_filtered' => ''
+    ));
     $wpdb->insert( $wpdb->term_relationships, array('term_taxonomy_id' => $cat_tt_id, 'object_id' => 1) );
 
@@ -195 +195 @@
     }
     $wpdb->insert( $wpdb->comments, array(
-                                'comment_post_ID' => 1,
-                                'comment_author' => $first_comment_author,
-                                'comment_author_email' => '',
-                                'comment_author_url' => $first_comment_url,
-                                'comment_date' => $now,
-                                'comment_date_gmt' => $now_gmt,
-                                'comment_content' => $first_comment
-                                ));
+        'comment_post_ID' => 1,
+        'comment_author' => $first_comment_author,
+        'comment_author_email' => '',
+        'comment_author_url' => $first_comment_url,
+        'comment_date' => $now,
+        'comment_date_gmt' => $now_gmt,
+        'comment_content' => $first_comment
+    ));
 
     // First Page
@@ -218 +218 @@
     $first_post_guid = get_option('home') . '/?page_id=2';
     $wpdb->insert( $wpdb->posts, array(
-                                'post_author' => $user_id,
-                                'post_date' => $now,
-                                'post_date_gmt' => $now_gmt,
-                                'post_content' => $first_page,
-                                'post_excerpt' => '',
-                                'post_title' => __( 'Sample Page' ),
-                                /* translators: Default page slug */
-                                'post_name' => __( 'sample-page' ),
-                                'post_modified' => $now,
-                                'post_modified_gmt' => $now_gmt,
-                                'guid' => $first_post_guid,
-                                'post_type' => 'page',
-                                'to_ping' => '',
-                                'pinged' => '',
-                                'post_content_filtered' => ''
-                                ));
+        'post_author' => $user_id,
+        'post_date' => $now,
+        'post_date_gmt' => $now_gmt,
+        'post_content' => $first_page,
+        'post_excerpt' => '',
+        'post_title' => __( 'Sample Page' ),
+        /* translators: Default page slug */
+        'post_name' => __( 'sample-page' ),
+        'post_modified' => $now,
+        'post_modified_gmt' => $now_gmt,
+        'guid' => $first_post_guid,
+        'post_type' => 'page',
+        'to_ping' => '',
+        'pinged' => '',
+        'post_content_filtered' => ''
+    ));
     $wpdb->insert( $wpdb->postmeta, array( 'post_id' => 2, 'meta_key' => '_wp_page_template', 'meta_value' => 'default' ) );
 
@@ -393 +393 @@
  * @global int  $wp_db_version
  * @global wpdb $wpdb
- *
- * @return null If no update is necessary or site isn't completely installed, null.
  */
 function wp_upgrade() {
@@ -446 +444 @@
  * @global int $wp_current_db_version
  * @global int $wp_db_version
- *
- * @return null If no update is necessary, null.
  */
 function upgrade_all() {
@@ -1748 +1744 @@
  * @param string $table Database table name.
  * @param string $index Index name to drop.
- * @return bool True, when finished.
+ * @return true True, when finished.
  */
 function drop_index($table, $index) {
@@ -1771 +1767 @@
  * @param string $table Database table name.
  * @param string $index Database table index column.
- * @return bool True, when done with execution.
+ * @return true True, when done with execution.
  */
 function add_clean_index($table, $index) {
@@ -1790 +1786 @@
  * @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 True if already exists or on successful completion, false on error.
+ * @return bool True if already exists or on successful completion, false on error.
  */
 function maybe_add_column($table_name, $column_name, $create_ddl) {
@@ -2279 +2275 @@
                 // Don't copy anything.
                 continue;
-                }
+            }
         }
 
@@ -2332 +2328 @@
  * @param string $theme_name The name of the theme.
  * @param string $template   The directory name of the theme.
- * @return null|false
+ * @return false|void
  */
 function make_site_theme_from_default($theme_name, $template) {