Changeset 28256

Timestamp:

05/05/2014 10:23:16 AM (11 years ago)

Author:

SergeyBiryukov

Message:

Deprecate unused argument of delete_plugins(). Clarify @return value.

props jdgrimes for initial patch.
fixes #28111.

File:

• trunk/src/wp-admin/includes/plugin.php (modified) (2 diffs)

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

@@ -718 +718 @@
  * @since 2.6.0
  *
- * @param string|array $plugins
+ * @param string|array $plugins Single plugin or list of plugins to activate.
  * @param string $redirect Redirect to page after successful activation.
  * @param bool $network_wide Whether to enable the plugin for all sites in the network.
@@ -744 +744 @@
 
 /**
- * Remove directory and files of a plugin for a single or list of plugin(s).
- *
- * If the plugins parameter list is empty, false will be returned. True when
- * completed.
+ * Remove directory and files of a plugin for a list of plugins.
  *
  * @since 2.6.0
  *
- * @param array $plugins List of plugin
- * @param string $redirect Redirect to page when complete.
- * @return mixed
- */
-function delete_plugins($plugins, $redirect = '' ) {
+ * @param array  $plugins    List of plugins to delete.
+ * @param string $deprecated Deprecated.
+ * @return bool|null|WP_Error True on success, false is $plugins is empty, WP_Error on failure.
+ *                            Null if filesystem credentials are required to proceed.
+ */
+function delete_plugins( $plugins, $deprecated = '' ) {
     global $wp_filesystem;