Merge pull request #321 from wp-cli/add/plugin-exclude-argument

Add optional `--exclude=<name>` argument for multiple plugin commands

Author: danielbachhuber

README.md

@@ -57,7 +57,7 @@ See the WordPress [Plugin Handbook](https://developer.wordpress.org/plugins/) de
 Activates one or more plugins.
 
 ~~~
-wp plugin activate [<plugin>...] [--all] [--network]
+wp plugin activate [<plugin>...] [--all] [--exclude=<name>] [--network]
 ~~~
 
 **OPTIONS**
@@ -68,6 +68,9 @@ wp plugin activate [<plugin>...] [--all] [--network]
 	[--all]
 		If set, all plugins will be activated.
 
+	[--exclude=<name>]
+		Comma separated list of plugin slugs to be excluded from activation.
+
 	[--network]
 		If set, the plugin will be activated for the entire multisite network.
 
@@ -90,7 +93,7 @@ wp plugin activate [<plugin>...] [--all] [--network]
 Deactivates one or more plugins.
 
 ~~~
-wp plugin deactivate [<plugin>...] [--uninstall] [--all] [--network]
+wp plugin deactivate [<plugin>...] [--uninstall] [--all]  [--exclude=<name>] [--network]
 ~~~
 
 **OPTIONS**
@@ -104,6 +107,9 @@ wp plugin deactivate [<plugin>...] [--uninstall] [--all] [--network]
 	[--all]
 		If set, all plugins will be deactivated.
 
+	 [--exclude=<name>]
+		Comma separated list of plugin names that should be excluded from deactivation.
+
 	[--network]
 		If set, the plugin will be deactivated for the entire multisite network.
 
@@ -114,14 +120,20 @@ wp plugin deactivate [<plugin>...] [--uninstall] [--all] [--network]
     Plugin 'hello' deactivated.
     Success: Deactivated 1 of 1 plugins.
 
+    # Deactivate all plugins with exclusion
+    $ wp plugin deactivate --all --exclude=hello,wordpress-seo
+    Plugin 'contact-form-7' deactivated.
+    Plugin 'ninja-forms' deactivated.
+    Success: Deactivated 2 of 2 plugins.
+
 
 
 ### wp plugin delete
 
 Deletes plugin files without deactivating or uninstalling.
 
 ~~~
-wp plugin delete [<plugin>...] [--all]
+wp plugin delete [<plugin>...] [--all] [--exclude=<name>]
 ~~~
 
 **OPTIONS**
@@ -132,6 +144,9 @@ wp plugin delete [<plugin>...] [--all]
 	[--all]
 		If set, all plugins will be deleted.
 
+	[--exclude=<name>]
+		Comma separated list of plugin slugs to be excluded from deletion.
+
 **EXAMPLES**
 
     # Delete plugin
@@ -144,6 +159,12 @@ wp plugin delete [<plugin>...] [--all]
     Deleted 'tinymce-templates' plugin.
     Success: Deleted 1 of 1 plugins.
 
+    # Delete all plugins excluding specified ones
+    $ wp plugin delete --all --exclude=hello-dolly,jetpack
+    Deleted 'akismet' plugin.
+    Deleted 'tinymce-templates' plugin.
+    Success: Deleted 2 of 2 plugins.
+
 
 
 ### wp plugin get
@@ -578,7 +599,7 @@ inactive, then it will be activated.
 Uninstalls one or more plugins.
 
 ~~~
-wp plugin uninstall [<plugin>...] [--deactivate] [--skip-delete] [--all]
+wp plugin uninstall [<plugin>...] [--deactivate] [--skip-delete] [--all] [--exclude=<name>]
 ~~~
 
 **OPTIONS**
@@ -596,12 +617,21 @@ wp plugin uninstall [<plugin>...] [--deactivate] [--skip-delete] [--all]
 	[--all]
 		If set, all plugins will be uninstalled.
 
+	[--exclude=<name>]
+		Comma separated list of plugin slugs to be excluded from uninstall.
+
 **EXAMPLES**
 
     $ wp plugin uninstall hello
     Uninstalled and deleted 'hello' plugin.
     Success: Uninstalled 1 of 1 plugins.
 
+    # Uninstall all plugins excluding specified ones
+    $ wp plugin uninstall --all --exclude=hello-dolly,jetpack
+    Uninstalled and deleted 'akismet' plugin.
+    Uninstalled and deleted 'tinymce-templates' plugin.
+    Success: Uninstalled 2 of 2 plugins.
+
 
 
 ### wp plugin update

features/plugin-activate.feature

@@ -78,7 +78,7 @@ Feature: Activate WordPress plugins
     When I run `wp plugin activate --all`
     Then STDOUT should be:
       """
-      Success: No plugins installed.
+      Success: No plugins activated.
       """
 
   @require-wp-5.2
@@ -106,3 +106,12 @@ Feature: Activate WordPress plugins
       """
       1 out of 1
       """
+
+  Scenario: Adding --exclude with plugin activate --all should exclude the plugins specified via --exclude
+    When I try `wp plugin activate --all --exclude=hello`
+    Then STDOUT should be:
+      """
+      Plugin 'akismet' activated.
+      Success: Activated 1 of 1 plugins.
+      """
+    And the return code should be 0

features/plugin-deactivate.feature

@@ -74,5 +74,23 @@ Feature: Deactivate WordPress plugins
     When I run `wp plugin deactivate --all`
     Then STDOUT should be:
       """
-      Success: No plugins installed.
+      Success: No plugins deactivated.
       """
+
+  Scenario: Adding --exclude with plugin deactivate --all should exclude the plugins specified via --exclude
+    When I try `wp plugin deactivate --all --exclude=hello`
+    Then STDOUT should be:
+      """
+      Plugin 'akismet' deactivated.
+      Success: Deactivated 1 of 1 plugins.
+      """
+    And the return code should be 0
+
+  Scenario: Adding --exclude with plugin deactivate should throw an error unless --all given
+    When I try `wp plugin deactivate --exclude=hello`
+    Then the return code should be 1
+    And STDERR should be:
+      """
+      Error: Please specify one or more plugins, or use --all.
+      """
+    And STDOUT should be empty

features/plugin-delete.feature

@@ -39,3 +39,11 @@ Feature: Delete WordPress plugins
       Warning: The 'edit-flow' plugin could not be found.
       """
     And the return code should be 0
+
+  Scenario: Excluding a plugin from deletion when using --all switch
+    When I try `wp plugin delete --all --exclude=akismet,hello`
+    Then STDOUT should be:
+      """
+      Success: No plugins deleted.
+      """
+    And the return code should be 0

features/plugin-uninstall.feature

@@ -71,3 +71,11 @@ Feature: Uninstall a WordPress plugin
       """
       Success: Uninstalled 2 of 2 plugins.
       """
+
+  Scenario: Excluding a plugin from uninstallation when using --all switch
+    When I try `wp plugin uninstall --all --exclude=akismet,hello`
+    Then STDOUT should be:
+      """
+      Success: No plugins uninstalled.
+      """
+    And the return code should be 0

src/Plugin_Command.php

@@ -289,6 +289,9 @@ protected function get_all_items() {
 	 * [--all]
 	 * : If set, all plugins will be activated.
 	 *
+	 * [--exclude=<name>]
+	 * : Comma separated list of plugin slugs to be excluded from activation.
+	 *
 	 * [--network]
 	 * : If set, the plugin will be activated for the entire multisite network.
 	 *
@@ -307,8 +310,9 @@ protected function get_all_items() {
 	public function activate( $args, $assoc_args = array() ) {
 		$network_wide = Utils\get_flag_value( $assoc_args, 'network' );
 		$all          = Utils\get_flag_value( $assoc_args, 'all', false );
+		$all_exclude  = Utils\get_flag_value( $assoc_args, 'exclude' );
 
-		$args = $this->check_optional_args_and_all( $args, $all );
+		$args = $this->check_optional_args_and_all( $args, $all, 'activate', $all_exclude );
 		if ( ! $args ) {
 			return;
 		}
@@ -375,6 +379,9 @@ public function activate( $args, $assoc_args = array() ) {
 	 * [--all]
 	 * : If set, all plugins will be deactivated.
 	 *
+	 *  [--exclude=<name>]
+	 * : Comma separated list of plugin slugs that should be excluded from deactivation.
+	 *
 	 * [--network]
 	 * : If set, the plugin will be deactivated for the entire multisite network.
 	 *
@@ -384,12 +391,19 @@ public function activate( $args, $assoc_args = array() ) {
 	 *     $ wp plugin deactivate hello
 	 *     Plugin 'hello' deactivated.
 	 *     Success: Deactivated 1 of 1 plugins.
+	 *
+	 *     # Deactivate all plugins with exclusion
+	 *     $ wp plugin deactivate --all --exclude=hello,wordpress-seo
+	 *     Plugin 'contact-form-7' deactivated.
+	 *     Plugin 'ninja-forms' deactivated.
+	 *     Success: Deactivated 2 of 2 plugins.
 	 */
 	public function deactivate( $args, $assoc_args = array() ) {
-		$network_wide = Utils\get_flag_value( $assoc_args, 'network' );
-		$disable_all  = Utils\get_flag_value( $assoc_args, 'all' );
+		$network_wide        = Utils\get_flag_value( $assoc_args, 'network' );
+		$disable_all         = Utils\get_flag_value( $assoc_args, 'all' );
+		$disable_all_exclude = Utils\get_flag_value( $assoc_args, 'exclude' );
 
-		$args = $this->check_optional_args_and_all( $args, $disable_all );
+		$args = $this->check_optional_args_and_all( $args, $disable_all, 'deactivate', $disable_all_exclude );
 		if ( ! $args ) {
 			return;
 		}
@@ -891,18 +905,28 @@ public function get( $args, $assoc_args ) {
 	 * [--all]
 	 * : If set, all plugins will be uninstalled.
 	 *
+	 * [--exclude=<name>]
+	 * : Comma separated list of plugin slugs to be excluded from uninstall.
+	 *
 	 * ## EXAMPLES
 	 *
 	 *     $ wp plugin uninstall hello
 	 *     Uninstalled and deleted 'hello' plugin.
 	 *     Success: Uninstalled 1 of 1 plugins.
+	 *
+	 *     # Uninstall all plugins excluding specified ones
+	 *     $ wp plugin uninstall --all --exclude=hello-dolly,jetpack
+	 *     Uninstalled and deleted 'akismet' plugin.
+	 *     Uninstalled and deleted 'tinymce-templates' plugin.
+	 *     Success: Uninstalled 2 of 2 plugins.
 	 */
 	public function uninstall( $args, $assoc_args = array() ) {
 
-		$all = Utils\get_flag_value( $assoc_args, 'all', false );
+		$all         = Utils\get_flag_value( $assoc_args, 'all', false );
+		$all_exclude = Utils\get_flag_value( $assoc_args, 'exclude', false );
 
 		// Check if plugin names or --all is passed.
-		$args = $this->check_optional_args_and_all( $args, $all, 'uninstall' );
+		$args = $this->check_optional_args_and_all( $args, $all, 'uninstall', $all_exclude );
 		if ( ! $args ) {
 			return;
 		}
@@ -1014,6 +1038,9 @@ public function is_active( $args, $assoc_args = array() ) {
 	 * [--all]
 	 * : If set, all plugins will be deleted.
 	 *
+	 * [--exclude=<name>]
+	 * : Comma separated list of plugin slugs to be excluded from deletion.
+	 *
 	 * ## EXAMPLES
 	 *
 	 *     # Delete plugin
@@ -1025,12 +1052,19 @@ public function is_active( $args, $assoc_args = array() ) {
 	 *     $ wp plugin delete $(wp plugin list --status=inactive --field=name)
 	 *     Deleted 'tinymce-templates' plugin.
 	 *     Success: Deleted 1 of 1 plugins.
+	 *
+	 *     # Delete all plugins excluding specified ones
+	 *     $ wp plugin delete --all --exclude=hello-dolly,jetpack
+	 *     Deleted 'akismet' plugin.
+	 *     Deleted 'tinymce-templates' plugin.
+	 *     Success: Deleted 2 of 2 plugins.
 	 */
 	public function delete( $args, $assoc_args = array() ) {
-		$all = Utils\get_flag_value( $assoc_args, 'all', false );
+		$all         = Utils\get_flag_value( $assoc_args, 'all', false );
+		$all_exclude = Utils\get_flag_value( $assoc_args, 'exclude', false );
 
 		// Check if plugin names or --all is passed.
-		$args = $this->check_optional_args_and_all( $args, $all, 'delete' );
+		$args = $this->check_optional_args_and_all( $args, $all, 'delete', $all_exclude );
 		if ( ! $args ) {
 			return;
 		}

src/WP_CLI/ParsePluginNameInput.php

@@ -13,16 +13,27 @@ trait ParsePluginNameInput {
 	 * @param bool   $all All flag.
 	 * @param string $verb Optional. Verb to use. Defaults to 'install'.
 	 * @return array Same as $args if not all, otherwise all slugs.
+	 * @param string $exclude Comma separated list of plugin slugs.
 	 * @throws ExitException If neither plugin name nor --all were provided.
 	 */
-	protected function check_optional_args_and_all( $args, $all, $verb = 'install' ) {
+	protected function check_optional_args_and_all( $args, $all, $verb = 'install', $exclude = null ) {
 		if ( $all ) {
 			$args = array_map(
 				'\WP_CLI\Utils\get_plugin_name',
 				array_keys( $this->get_all_plugins() )
 			);
 		}
 
+		if ( $all && $exclude ) {
+			$exclude_list = explode( ',', trim( $exclude, ',' ) );
+			$args         = array_filter(
+				$args,
+				static function( $slug ) use ( $exclude_list ) {
+					return ! in_array( $slug, $exclude_list, true );
+				}
+			);
+		}
+
 		if ( empty( $args ) ) {
 			if ( ! $all ) {
 				WP_CLI::error( 'Please specify one or more plugins, or use --all.' );