Merge pull request #530 from BhargavBhandari90/issue-98-remove-cap-improvement

schlessera · web-flow · commit 213611f8ab61 · 2025-05-06T18:12:49.000+02:00
diff --git a/features/user.feature b/features/user.feature
@@ -432,6 +432,39 @@ Feature: Manage WordPress users
       publish_posts
       """
 
+  Scenario: Show error when trying to remove capability same as role
+    Given a WP install
+
+    When I run `wp user create testuser2 testuser2@example.com --first_name=test --last_name=user --role=contributor --porcelain`
+    Then STDOUT should be a number
+    And save STDOUT as {USER_ID}
+
+    When I run `wp user list-caps {USER_ID}`
+    Then STDOUT should contain:
+      """
+      contributor
+      """
+
+    When I run `wp user get {USER_ID} --field=roles`
+    Then STDOUT should contain:
+      """
+      contributor
+      """
+
+    When I try `wp user remove-cap {USER_ID} contributor`
+    Then the return code should be 1
+    And STDERR should be:
+      """
+      Error: Aborting because a role has the same name as 'contributor'. Use `wp user remove-cap {USER_ID} contributor --force` to proceed with the removal.
+      """
+    And STDOUT should be empty
+
+    When I run `wp user remove-cap {USER_ID} contributor --force`
+    Then STDOUT should be:
+      """
+      Success: Removed 'contributor' cap for testuser2 ({USER_ID}).
+      """
+
   Scenario: Show password when creating a user
     Given a WP install
 
diff --git a/src/User_Command.php b/src/User_Command.php
@@ -861,6 +861,9 @@ public function add_cap( $args, $assoc_args ) {
 	 * <cap>
 	 * : The capability to be removed.
 	 *
+	 * [--force]
+	 * : Forcefully remove a capability.
+	 *
 	 * ## EXAMPLES
 	 *
 	 *     $ wp user remove-cap 11 publish_newsletters
@@ -872,6 +875,9 @@ public function add_cap( $args, $assoc_args ) {
 	 *     $ wp user remove-cap 11 nonexistent_cap
 	 *     Error: No such 'nonexistent_cap' cap for supervisor (11).
 	 *
+	 *     $ wp user remove-cap 11 publish_newsletters --force
+	 *     Success: Removed 'publish_newsletters' cap for supervisor (11).
+	 *
 	 * @subcommand remove-cap
 	 */
 	public function remove_cap( $args, $assoc_args ) {
@@ -884,6 +890,11 @@ public function remove_cap( $args, $assoc_args ) {
 				}
 				WP_CLI::error( "No such '{$cap}' cap for {$user->user_login} ({$user->ID})." );
 			}
+
+			$user_roles = $user->roles;
+			if ( ! empty( $user_roles ) && in_array( $cap, $user_roles, true ) && ! Utils\get_flag_value( $assoc_args, 'force' ) ) {
+				WP_CLI::error( "Aborting because a role has the same name as '{$cap}'. Use `wp user remove-cap {$user->ID} {$cap} --force` to proceed with the removal." );
+			}
 			$user->remove_cap( $cap );
 
 			WP_CLI::success( "Removed '{$cap}' cap for {$user->user_login} ({$user->ID})." );

Original file line number	Diff line number	Diff line change
`@@ -861,6 +861,9 @@ public function add_cap( $args, $assoc_args ) {`
`861`	`861`	`* <cap>`
`862`	`862`	`* : The capability to be removed.`
`863`	`863`	`*`
	`864`	`+ * [--force]`
	`865`	`+ * : Forcefully remove a capability.`
	`866`	`+ *`
`864`	`867`	`* ## EXAMPLES`
`865`	`868`	`*`
`866`	`869`	`* $ wp user remove-cap 11 publish_newsletters`
`@@ -872,6 +875,9 @@ public function add_cap( $args, $assoc_args ) {`
`872`	`875`	`* $ wp user remove-cap 11 nonexistent_cap`
`873`	`876`	`* Error: No such 'nonexistent_cap' cap for supervisor (11).`
`874`	`877`	`*`
	`878`	`+ * $ wp user remove-cap 11 publish_newsletters --force`
	`879`	`+ * Success: Removed 'publish_newsletters' cap for supervisor (11).`
	`880`	`+ *`
`875`	`881`	`* @subcommand remove-cap`
`876`	`882`	`*/`
`877`	`883`	`public function remove_cap( $args, $assoc_args ) {`
`@@ -884,6 +890,11 @@ public function remove_cap( $args, $assoc_args ) {`
`884`	`890`	`}`
`885`	`891`	`WP_CLI::error( "No such '{$cap}' cap for {$user->user_login} ({$user->ID})." );`
`886`	`892`	`}`
	`893`	`+`
	`894`	`+ $user_roles = $user->roles;`
	`895`	`+ if ( ! empty( $user_roles ) && in_array( $cap, $user_roles, true ) && ! Utils\get_flag_value( $assoc_args, 'force' ) ) {`
	`896`	+ WP_CLI::error( "Aborting because a role has the same name as '{$cap}'. Use `wp user remove-cap {$user->ID} {$cap} --force` to proceed with the removal." );
	`897`	`+ }`
`887`	`898`	`$user->remove_cap( $cap );`
`888`	`899`
`889`	`900`	`WP_CLI::success( "Removed '{$cap}' cap for {$user->user_login} ({$user->ID})." );`