From fce20e9784946af2e3ca9f580b05db6c12c0f5db Mon Sep 17 00:00:00 2001 From: Andrew Ozz Date: Sun, 7 Dec 2014 01:18:21 +0000 Subject: [PATCH] Better docs for `Plugin_Upgrader::deactivate_plugin_before_upgrade()`. Props DrewAPicture. Fixes #29088. git-svn-id: https://develop.svn.wordpress.org/trunk@30762 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-admin/includes/class-wp-upgrader.php | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/wp-admin/includes/class-wp-upgrader.php b/src/wp-admin/includes/class-wp-upgrader.php index 1eb420c4c7..ae86f60f45 100644 --- a/src/wp-admin/includes/class-wp-upgrader.php +++ b/src/wp-admin/includes/class-wp-upgrader.php @@ -1015,9 +1015,11 @@ class Plugin_Upgrader extends WP_Upgrader { * Hooked to the {@see 'upgrader_pre_install'} filter by {@see Plugin_Upgrader::upgrade()}. * * @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 {@see WP_Error}. */ public function deactivate_plugin_before_upgrade($return, $plugin) {