Merge branch 'main' into copilot/add-ranges-to-commands

Author: swissspidy

.gitattributes

@@ -0,0 +1,14 @@
+/.actrc export-ignore
+/.distignore export-ignore
+/.editorconfig export-ignore
+/.github export-ignore
+/.gitignore export-ignore
+/.typos.toml export-ignore
+/AGENTS.md export-ignore
+/behat.yml export-ignore
+/features export-ignore
+/phpcs.xml.dist export-ignore
+/phpstan.neon.dist export-ignore
+/phpunit.xml.dist export-ignore
+/tests export-ignore
+/wp-cli.yml export-ignore

.github/workflows/copilot-setup-steps.yml

@@ -25,7 +25,7 @@ jobs:
 
       - name: Set up PHP environment
         if: steps.check_composer_file.outputs.files_exists == 'true'
-        uses: shivammathur/setup-php@44454db4f0199b8b9685a5d763dc37cbf79108e1 # v2
+        uses: shivammathur/setup-php@accd6127cb78bee3e8082180cb391013d204ef9f # v2
         with:
           php-version: 'latest'
           ini-values: zend.assertions=1, error_reporting=-1, display_errors=On
@@ -36,7 +36,7 @@ jobs:
 
       - name: Install Composer dependencies & cache dependencies
         if: steps.check_composer_file.outputs.files_exists == 'true'
-        uses: ramsey/composer-install@a35c6ebd3d08125aaf8852dff361e686a1a67947 # v3
+        uses: ramsey/composer-install@65e4f84970763564f46a70b8a54b90d033b3bdda # v3
         env:
           COMPOSER_ROOT_VERSION: dev-${{ github.event.repository.default_branch }}
         with:

README.md

@@ -5339,7 +5339,7 @@ These fields are optionally available:
 Lists all sites in a multisite installation.
 
 ~~~
-wp site list [--network=<id>] [--<field>=<value>] [--site__in=<value>] [--site_user=<value>] [--field=<field>] [--fields=<fields>] [--format=<format>]
+wp site list [--network=<id>] [--<field>=<value>] [--site__in=<value>] [--site_user=<value>] [--site-path=<path>] [--field=<field>] [--fields=<fields>] [--format=<format>]
 ~~~
 
 **OPTIONS**
@@ -5350,13 +5350,18 @@ wp site list [--network=<id>] [--<field>=<value>] [--site__in=<value>] [--site_u
 	[--<field>=<value>]
 		Filter by one or more fields (see "Available Fields" section). However,
 		'url' isn't an available filter, as it comes from 'home' in wp_options.
+		Note: '--path' conflicts with the global parameter of the same name; use
+		'--site-path' to filter by path instead.
 
 	[--site__in=<value>]
 		Only list the sites with these blog_id values (comma-separated).
 
 	[--site_user=<value>]
 		Only list the sites with this user.
 
+	[--site-path=<path>]
+		Filter by path. Avoids conflict with the global `--path` parameter.
+
 	[--field=<field>]
 		Prints the value of a single field for each site.
 
@@ -7768,7 +7773,7 @@ Display WordPress users based on all arguments supported by
 		Control output by one or more arguments of WP_User_Query().
 
 	[--network]
-		List all users in the network for multisite.
+		List all users in the network for multisite. Roles are not included when using this flag, as users can have different roles on different sites in a multisite network.
 
 	[--field=<field>]
 		Prints the value of a single field for each user.

features/menu-item.feature

@@ -252,3 +252,27 @@ Feature: Manage WordPress menu items
       """
     And the return code should be 1
 
+  Scenario: Add a post type archive as a menu item
+
+    When I run `wp menu create "Archive Menu"`
+    Then STDOUT should not be empty
+
+    When I run `wp menu item add-post-type-archive archive-menu post --porcelain`
+    Then STDOUT should be a number
+    And save STDOUT as {ITEM_ID}
+
+    When I run `wp menu item list archive-menu --fields=db_id,type,object`
+    Then STDOUT should be a table containing rows:
+      | db_id     | type               | object |
+      | {ITEM_ID} | post_type_archive  | post   |
+
+    When I run `wp menu item get {ITEM_ID} --field=link`
+    Then STDOUT should not be empty
+
+    When I try `wp menu item add-post-type-archive archive-menu invalidposttype`
+    Then STDERR should be:
+      """
+      Error: Invalid post type.
+      """
+    And the return code should be 1
+

features/site.feature

@@ -98,6 +98,12 @@ Feature: Manage sites in a multisite installation
       {SCHEME}://example.com/first/
       """
 
+    When I run `wp site list --field=url --site-path=/first/`
+    Then STDOUT should be:
+      """
+      {SCHEME}://example.com/first/
+      """
+
   Scenario: Filter site list by user
     Given a WP multisite install
 

features/user-list.feature

@@ -27,6 +27,20 @@ Feature: List WordPress users
       bobjones
       """
 
+  Scenario: List network users excludes roles field
+    Given a WP multisite install
+    And I run `wp user create bobjones bob@example.com --role=author`
+
+    When I run `wp user list --network --format=csv`
+    Then STDOUT should contain:
+      """
+      ID,user_login,display_name,user_email,user_registered
+      """
+    And STDOUT should not contain:
+      """
+      roles
+      """
+
   @require-wp-4.9
   Scenario: List users without roles
     Given a WP install

features/user.feature

@@ -267,6 +267,43 @@ Feature: Manage WordPress users
       Bob Jones
       """
 
+  # The error message changed in WP 5.9.
+  @less-than-wp-5.9
+  Scenario: Creating a user with an existing email in multisite shows a clean error message
+    Given a WP multisite install
+
+    When I run `wp user create bobjones bobjones@example.com`
+    Then STDOUT should not be empty
+
+    When I try `wp user create bobjones2 bobjones@example.com`
+    Then STDERR should contain:
+      """
+      Sorry, that email address is already used!
+      """
+    And STDERR should not contain:
+      """
+      <
+      """
+    And the return code should be 1
+
+  @require-wp-5.9
+  Scenario: Creating a user with an existing email in multisite shows a clean error message
+    Given a WP multisite install
+
+    When I run `wp user create bobjones bobjones@example.com`
+    Then STDOUT should not be empty
+
+    When I try `wp user create bobjones2 bobjones@example.com`
+    Then STDERR should contain:
+      """
+      This email address is already registered.
+      """
+    And STDERR should not contain:
+      """
+      <
+      """
+    And the return code should be 1
+
   Scenario: Managing user roles
     Given a WP install
 

src/Menu_Item_Command.php

@@ -329,6 +329,69 @@ public function add_term( $args, $assoc_args ) {
 		$this->add_or_update_item( 'add', 'taxonomy', $args, $assoc_args );
 	}
 
+	/**
+	 * Adds a post type archive as a menu item.
+	 *
+	 * ## OPTIONS
+	 *
+	 * <menu>
+	 * : The name, slug, or term ID for the menu.
+	 *
+	 * <post-type>
+	 * : Post type slug.
+	 *
+	 * [--title=<title>]
+	 * : Set a custom title for the menu item.
+	 *
+	 * [--link=<link>]
+	 * : Set a custom url for the menu item.
+	 *
+	 * [--description=<description>]
+	 * : Set a custom description for the menu item.
+	 *
+	 * [--attr-title=<attr-title>]
+	 * : Set a custom title attribute for the menu item.
+	 *
+	 * [--target=<target>]
+	 * : Set a custom link target for the menu item.
+	 *
+	 * [--classes=<classes>]
+	 * : Set a custom link classes for the menu item.
+	 *
+	 * [--position=<position>]
+	 * : Specify the position of this menu item.
+	 *
+	 * [--parent-id=<parent-id>]
+	 * : Make this menu item a child of another menu item.
+	 *
+	 * [--porcelain]
+	 * : Output just the new menu item id.
+	 *
+	 * ## EXAMPLES
+	 *
+	 *     $ wp menu item add-post-type-archive sidebar-menu post
+	 *     Success: Menu item added.
+	 *
+	 * @subcommand add-post-type-archive
+	 */
+	public function add_post_type_archive( $args, $assoc_args ) {
+
+		$assoc_args['object'] = $args[1];
+		unset( $args[1] );
+
+		$post_type = $assoc_args['object'];
+
+		if ( ! get_post_type_object( $post_type ) ) {
+			WP_CLI::error( 'Invalid post type.' );
+		}
+
+		if ( false === get_post_type_archive_link( $post_type ) ) {
+			WP_CLI::error( 'Post type does not have an archive.' );
+		}
+
+		$this->add_or_update_item( 'add', 'post_type_archive', $args, $assoc_args );
+	}
+
 	/**
 	 * Adds a custom menu item.
 	 *

src/Menu_Location_Command.php

@@ -1,7 +1,6 @@
 <?php
 
 use WP_CLI\Formatter;
-use WP_CLI\Utils;
 
 /**
  * Assigns, removes, and lists a menu's locations.

src/Site_Command.php

@@ -962,13 +962,18 @@ private function get_network( $network_id ) {
 	 * [--<field>=<value>]
 	 * : Filter by one or more fields (see "Available Fields" section). However,
 	 * 'url' isn't an available filter, as it comes from 'home' in wp_options.
+	 * Note: '--path' conflicts with the global parameter of the same name; use
+	 * '--site-path' to filter by path instead.
 	 *
 	 * [--site__in=<value>]
 	 * : Only list the sites with these blog_id values (comma-separated).
 	 *
 	 * [--site_user=<value>]
 	 * : Only list the sites with this user.
 	 *
+	 * [--site-path=<path>]
+	 * : Filter by path. Avoids conflict with the global `--path` parameter.
+	 *
 	 * [--field=<field>]
 	 * : Prints the value of a single field for each site.
 	 *
@@ -1045,6 +1050,10 @@ public function list_( $args, $assoc_args ) {
 			}
 		}
 
+		if ( isset( $assoc_args['site-path'] ) ) {
+			$where['path'] = $assoc_args['site-path'];
+		}
+
 		if ( isset( $assoc_args['site__in'] ) ) {
 			$where['blog_id'] = explode( ',', $assoc_args['site__in'] );
 			$append           = 'ORDER BY FIELD( blog_id, ' . implode( ',', array_map( 'intval', $where['blog_id'] ) ) . ' )';