Changeset 33685 for trunk/src/wp-admin/includes/class-wp-upgrader.php

Timestamp:

08/21/2015 04:12:45 AM (11 years ago)

Author:

DrewAPicture

Message:

Docs: Fix a variety of inline documentation syntax issues and add some strategic spacing.

Fixes #29086.

File:

• trunk/src/wp-admin/includes/class-wp-upgrader.php (modified) (17 diffs)

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

@@ -437 +437 @@
                  */
                 $res = apply_filters( 'upgrader_pre_install', true, $args['hook_extra'] );
+
                 if ( is_wp_error( $res ) ) {
                         return $res;
@@ -467 +468 @@
                  */
                 $source = apply_filters( 'upgrader_source_selection', $source, $remote_source, $this );
+
                 if ( is_wp_error( $source ) ) {
                         return $source;
@@ -475 +477 @@
                         $source_files = array_keys( $wp_filesystem->dirlist( $source ) );
                 }
+
                 /*
                  * Protection against deleting files in any important base directories.
@@ -487 +490 @@
                         $protected_directories = array_merge( $protected_directories, $wp_theme_directories );
                 }
+
                 if ( in_array( $destination, $protected_directories ) ) {
                         $remote_destination = trailingslashit( $remote_destination ) . trailingslashit( basename( $source ) );
@@ -493 +497 @@
 
                 if ( $clear_destination ) {
-                        // We're going to clear the destination if there's something there
+                        // We're going to clear the destination if there's something there.
                         $this->skin->feedback('remove_old');
 
@@ -601 +605 @@
          *                                               {@see WP_Upgrader::run()}.
          * }
-         *
          * @return array|false|WP_error The result from self::install_package() on success, otherwise a WP_Error,
          *                              or false if unable to connect to the filesystem.
@@ -663 +666 @@
                 }
 
-                //Download the package (Note, This just returns the filename of the file if the package is a local file)
+                /*
+                 * Download the package (Note, This just returns the filename
+                 * of the file if the package is a local file)
+                 */
                 $download = $this->download_package( $options['package'] );
                 if ( is_wp_error($download) ) {
@@ -676 +682 @@
                 $delete_package = ( $download != $options['package'] ); // Do not delete a "local" file
 
-                //Unzips the file into a temporary directory
+                // Unzips the file into a temporary directory.
                 $working_dir = $this->unpack_package( $download, $delete_package );
                 if ( is_wp_error($working_dir) ) {
@@ -687 +693 @@
                 }
 
-                //With the given options, this installs it to the destination directory.
+                // With the given options, this installs it to the destination directory.
                 $result = $this->install_package( array(
                         'source' => $working_dir,
@@ -702 +708 @@
                         $this->skin->feedback('process_failed');
                 } else {
-                        //Install Succeeded
+                        // Install succeeded.
                         $this->skin->feedback('process_success');
                 }
@@ -762 +768 @@
          * @access public
          * @var array|WP_Error $result
+         *
          * @see WP_Upgrader::$result
          */
@@ -823 +830 @@
          *                                    Default true.
          * }
-         *
          * @return bool|WP_Error True if the install was successful, false or a WP_Error otherwise.
          */
@@ -941 +947 @@
          *                                    Default true.
          * }
-         *
          * @return array|false An array of results indexed by plugin file, or false if unable to connect to the filesystem.
          */
@@ -970 +975 @@
                 $this->skin->bulk_header();
 
-                // Only start maintenance mode if:
-                // - running Multisite and there are one or more plugins specified, OR
-                // - a plugin with an update available is currently active.
-                // @TODO: For multisite, maintenance mode should only kick in for individual sites if at all possible.
+                /*
+                 * Only start maintenance mode if:
+                 * - running Multisite and there are one or more plugins specified, OR
+                 * - a plugin with an update available is currently active.
+                 * @TODO: For multisite, maintenance mode should only kick in for individual sites if at all possible.
+                 */
                 $maintenance = ( is_multisite() && ! empty( $plugins ) );
                 foreach ( $plugins as $plugin )
@@ -997 +1004 @@
                         }
 
-                        // Get the URL to the zip file
+                        // Get the URL to the zip file.
                         $r = $current->response[ $plugin ];
 
@@ -1052 +1059 @@
                 remove_filter('upgrader_clear_destination', array($this, 'delete_old_plugin'));
 
-                // Force refresh of plugin update information
+                // Force refresh of plugin update information.
                 wp_clean_plugins_cache( $parsed_args['clear_update_cache'] );
 
@@ -1070 +1077 @@
          *
          * @param string $source The path to the downloaded package source.
-         * @return string|WP_Error The source as passed, or a {@see WP_Error} object if no plugins were found.
+         * @return string|WP_Error The source as passed, or a {@see WP_Error} object
+         *                         if no plugins were found.
          */
         public function check_package($source) {