Changeset 46694

Timestamp:

11/10/2019 11:03:34 PM (6 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve documentation for deactivate_plugins() and activate_plugins().

Props marekdedic, spenserhale, SergeyBiryukov.
Fixes #48352.

File:

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

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

@@ -727 +727 @@
  * @since 2.5.0
  *
- * @param string|array $plugins Single plugin or list of plugins to deactivate.
- * @param bool $silent Prevent calling deactivation hooks. Default is false.
- * @param mixed $network_wide Whether to deactivate the plugin for all sites in the network.
- *  A value of null (the default) will deactivate plugins for both the site and the network.
+ * @param string|string[] $plugins      Single plugin or list of plugins to deactivate.
+ * @param bool            $silent       Prevent calling deactivation hooks. Default false.
+ * @param bool|null       $network_wide Whether to deactivate the plugin for all sites in the network.
+ *                                      A value of null will deactivate plugins for both the network
+ *                                      and the current site. Multisite only. Default null.
  */
 function deactivate_plugins( $plugins, $silent = false, $network_wide = null ) {
@@ -759 +760 @@
              * @param string $plugin               Path to the plugin file relative to the plugins directory.
              * @param bool   $network_deactivating Whether the plugin is deactivated for all sites in the network
-             *                                     or just the current site. Multisite only. Default is false.
+             *                                     or just the current site. Multisite only. Default false.
              */
             do_action( 'deactivate_plugin', $plugin, $network_deactivating );
@@ -798 +799 @@
              *
              * @param bool $network_deactivating Whether the plugin is deactivated for all sites in the network
-             *                                   or just the current site. Multisite only. Default is false.
+             *                                   or just the current site. Multisite only. Default false.
              */
             do_action( "deactivate_{$plugin}", $network_deactivating );
@@ -811 +812 @@
              *
              * @param string $plugin               Path to the plugin file relative to the plugins directory.
-             * @param bool   $network_deactivating Whether the plugin is deactivated for all sites in the network.
+             * @param bool   $network_deactivating Whether the plugin is deactivated for all sites in the network
              *                                     or just the current site. Multisite only. Default false.
              */
@@ -830 +831 @@
  *
  * When WP_Error is returned, it does not mean that one of the plugins had
- * errors. It means that one or more of the plugins file path was invalid.
+ * errors. It means that one or more of the plugin file paths were invalid.
  *
  * The execution will be halted as soon as one of the plugins has an error.
@@ -836 +837 @@
  * @since 2.6.0
  *
- * @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.
- * @param bool $silent Prevent calling activation hooks. Default is false.
+ * @param string|string[] $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.
+ *                                      Default false.
+ * @param bool $silent                  Prevent calling activation hooks. Default false.
  * @return bool|WP_Error True when finished or WP_Error if there were errors during a plugin activation.
  */