From cd84eaac269937cbf77c1b923c7373f372b103be Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Tue, 3 Mar 2020 11:38:00 +0000 Subject: [PATCH] Docs: Correct formatting of some DocBlocks in `Plugin_Upgrader` and `Theme_Upgrader` per the documentation standards. See #49400. git-svn-id: https://develop.svn.wordpress.org/trunk@47414 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-admin/includes/class-plugin-upgrader.php | 13 +++++++------ src/wp-admin/includes/class-theme-upgrader.php | 6 +++--- 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/src/wp-admin/includes/class-plugin-upgrader.php b/src/wp-admin/includes/class-plugin-upgrader.php index b99547c60b..214f371866 100644 --- a/src/wp-admin/includes/class-plugin-upgrader.php +++ b/src/wp-admin/includes/class-plugin-upgrader.php @@ -415,8 +415,8 @@ class Plugin_Upgrader extends WP_Upgrader { * @since 2.8.0 * @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. */ public function deactivate_plugin_before_upgrade( $return, $plugin ) { @@ -466,7 +466,7 @@ class Plugin_Upgrader extends WP_Upgrader { $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; } @@ -486,8 +486,8 @@ class Plugin_Upgrader extends WP_Upgrader { * * @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. */ public function active_after( $return, $plugin ) { @@ -525,7 +525,8 @@ class Plugin_Upgrader extends WP_Upgrader { * * @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. * @param array $plugin Extra arguments passed to hooked filters. diff --git a/src/wp-admin/includes/class-theme-upgrader.php b/src/wp-admin/includes/class-theme-upgrader.php index aae2a8a2a1..9d561c0893 100644 --- a/src/wp-admin/includes/class-theme-upgrader.php +++ b/src/wp-admin/includes/class-theme-upgrader.php @@ -529,7 +529,7 @@ class Theme_Upgrader extends WP_Upgrader { * @since 2.8.0 * * @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. */ public function current_before( $return, $theme ) { @@ -561,7 +561,7 @@ class Theme_Upgrader extends WP_Upgrader { * @since 2.8.0 * * @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. */ public function current_after( $return, $theme ) { @@ -571,7 +571,7 @@ class Theme_Upgrader extends WP_Upgrader { $theme = isset( $theme['theme'] ) ? $theme['theme'] : ''; - // Only run if current theme + // Only run if current theme. if ( get_stylesheet() !== $theme ) { return $return; }