Changeset 30762

Timestamp:

12/07/2014 01:18:21 AM (10 years ago)

Author:

azaozz

Message:

Better docs for Plugin_Upgrader::deactivate_plugin_before_upgrade(). Props DrewAPicture. Fixes #29088.

File:

• trunk/src/wp-admin/includes/class-wp-upgrader.php (modified) (1 diff)

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

@@ -1016 +1016 @@
      *
      * @since 2.8.0
-     *
-     * @param bool|WP_Error $return Upgrade offer return.
-     * @param array         $plugin Plugin package arguments.
+     * @since 4.1.0 Added a return value.
+     *
+     * @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) {