Changeset 47414

Timestamp:

03/03/2020 11:38:00 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Correct formatting of some DocBlocks in Plugin_Upgrader and Theme_Upgrader per the documentation standards.

See #49400.

Location:

trunk/src/wp-admin/includes

Files:

• class-plugin-upgrader.php (modified) (4 diffs)
• class-theme-upgrader.php (modified) (3 diffs)

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

@@ -416 +416 @@
      * @since 4.1.0 Added a return value.
      *
-     * @param bool|WP_Error  $return Upgrade offer return.
-     * @param array          $plugin Plugin package arguments.
+     * @param bool|WP_Error $return Upgrade offer return.
+     * @param array         $plugin Plugin package arguments.
      * @return bool|WP_Error The passed in $return param or WP_Error.
      */
@@ -467 +467 @@
         $plugin = isset( $plugin['plugin'] ) ? $plugin['plugin'] : '';
 
-        // Only run if plugin is active
+        // Only run if plugin is active.
         if ( ! is_plugin_active( $plugin ) ) {
             return $return;
@@ -487 +487 @@
      * @since 5.4.0
      *
-     * @param bool|WP_Error  $return Upgrade offer return.
-     * @param array          $plugin Plugin package arguments.
+     * @param bool|WP_Error $return Upgrade offer return.
+     * @param array         $plugin Plugin package arguments.
      * @return bool|WP_Error The passed in $return param or WP_Error.
      */
@@ -526 +526 @@
      * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
      *
-     * @param bool|WP_Error $removed            Whether the destination was cleared. true on success, WP_Error on failure.
+     * @param bool|WP_Error $removed            Whether the destination was cleared.
+     *                                          True on success, WP_Error on failure.
      * @param string        $local_destination  The local package destination.
      * @param string        $remote_destination The remote package destination.

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

@@ -530 +530 @@
      *
      * @param bool|WP_Error $return Upgrade offer return.
-     * @param array         $theme Theme arguments.
+     * @param array         $theme  Theme arguments.
      * @return bool|WP_Error The passed in $return param or WP_Error.
      */
@@ -562 +562 @@
      *
      * @param bool|WP_Error $return Upgrade offer return.
-     * @param array         $theme Theme arguments.
+     * @param array         $theme  Theme arguments.
      * @return bool|WP_Error The passed in $return param or WP_Error.
      */
@@ -572 +572 @@
         $theme = isset( $theme['theme'] ) ? $theme['theme'] : '';
 
-        // Only run if current theme
+        // Only run if current theme.
         if ( get_stylesheet() !== $theme ) {
             return $return;