Changeset 27047

Timestamp:

01/28/2014 08:01:36 AM (11 years ago)

Author:

DrewAPicture

Message:

Inline documentation for hooks in wp-admin/includes/update-core.php.

Props JoshuaAbenazer, kpdesign.
Fixes #25998.

Location:

trunk/src/wp-admin/includes

Files:

• class-wp-upgrader.php (modified) (1 diff)
• update-core.php (modified) (7 diffs)

trunk/src/wp-admin/includes/class-wp-upgrader.php

@@ -1402 +1402 @@
 
             if ( $try_rollback ) {
+                /** This filter is documented in wp-admin/includes/update-core.php */
                 apply_filters( 'update_feedback', $result );
+                /** This filter is documented in wp-admin/includes/update-core.php */
                 apply_filters( 'update_feedback', $this->strings['start_rollback'] );
 

trunk/src/wp-admin/includes/update-core.php

@@ -685 +685 @@
     @set_time_limit( 300 );
 
-    // Sanity check the unzipped distribution
-    apply_filters( 'update_feedback', __('Verifying the unpacked files…') );
+    /**
+     * Filter feedback messages displayed during the core update process.
+     *
+     * The filter is first evaluated after the zip file for the latest version
+     * has been downloaded and unzipped. It is evaluated five more times during
+     * the process:
+     *
+     * 1. Before WordPress begins the core upgrade process.
+     * 2. Before Maintenance Mode is enabled.
+     * 3. Before WordPress begins copying over the necessary files.
+     * 4. Before Maintenance Mode is disabled.
+     * 5. Before the database is upgraded.
+     *
+     * @since 2.5.0
+     *
+     * @param string $feedback The core update feedback messages.
+     */
+    apply_filters( 'update_feedback', __( 'Verifying the unpacked files…' ) );
+
+    // Sanity check the unzipped distribution.
     $distro = '';
     $roots = array( '/wordpress/', '/wordpress-mu/' );
@@ -732 +750 @@
         return new WP_Error( 'mysql_not_compatible', sprintf( __('The update cannot be installed because WordPress %1$s requires MySQL version %2$s or higher. You are running version %3$s.'), $wp_version, $required_mysql_version, $mysql_version ) );
 
+    /** This filter is documented in wp-admin/includes/update-core.php */
     apply_filters( 'update_feedback', __( 'Preparing to install the latest version…' ) );
 
@@ -782 +801 @@
     }
 
+    /** This filter is documented in wp-admin/includes/update-core.php */
     apply_filters( 'update_feedback', __( 'Enabling Maintenance mode…' ) );
     // Create maintenance file to signal that we are upgrading
@@ -789 +809 @@
     $wp_filesystem->put_contents($maintenance_file, $maintenance_string, FS_CHMOD_FILE);
 
+    /** This filter is documented in wp-admin/includes/update-core.php */
     apply_filters( 'update_feedback', __( 'Copying the required files…' ) );
     // Copy new versions of WP files into place.
@@ -854 +875 @@
     }
 
+    /** This filter is documented in wp-admin/includes/update-core.php */
     apply_filters( 'update_feedback', __( 'Disabling Maintenance mode…' ) );
     // Remove maintenance file, we're done with potential site-breaking changes
@@ -925 +947 @@
 
     // Upgrade DB with separate request
-    apply_filters('update_feedback', __('Upgrading database…'));
+    /** This filter is documented in wp-admin/includes/update-core.php */
+    apply_filters( 'update_feedback', __( 'Upgrading database…' ) );
     $db_upgrade_url = admin_url('upgrade.php?step=upgrade_db');
     wp_remote_post($db_upgrade_url, array('timeout' => 60));
@@ -943 +966 @@
         delete_option('update_core');
 
-    // If we made it this far:
+    /**
+     * Fires after WordPress core has been successfully updated.
+     *
+     * @since 3.3.0
+     *
+     * @param string $wp_version The current WordPress version.
+     */
     do_action( '_core_updated_successfully', $wp_version );