Added the group and groupId arguments to the users GraphQL query.

Resolved #5374
craftcms · Dec 30, 2019 · 1934c38 · 1934c38
1 parent e3a1841
commit 1934c38
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/CHANGELOG-v3.4.md b/CHANGELOG-v3.4.md
@@ -45,6 +45,7 @@
 - Added support for plugin-supplied element exporters. ([#5090](https://github.com/craftcms/cms/issues/5090))
 - Control panel pages can now implement Vue-based admin tables that support bulk actions, search, and pagination.
 - Added the `_count` field to all Elements when using GraphQL that returns the total related elements for a field. ([#4847](https://github.com/craftcms/cms/issues/4847))
+- It’s now possible to filter users by user groups when querying for them using GraphQL. ([#5374](https://github.com/craftcms/cms/issues/5374)) 
 - Added `craft\assetpreviews\HtmlPreview`.
 - Added `craft\assetpreviews\ImagePreview`.
 - Added `craft\assetpreviews\NoPreview`.

diff --git a/CHANGELOG-v3.md b/CHANGELOG-v3.md
@@ -6,6 +6,7 @@
 - Added new “View files uploaded by other users”, “Edit files uploaded by other users”, “Replace files uploaded by other users”, “Remove files uploaded by other users”, and “Edit images uploaded by other users” user permissions.
 - Assets fields now have a “Show unpermitted files setting, which determines whether the field should show files that the user doesn’t have permission to view per the new “View files uploaded by other users” permission.
 - It’s now possible to filter element query results by their related elements using relational fields’ element query params (e.g. `publisher(100)` rather than `relatedTo({targetElement: 100, field: 'publisher'})`). ([#5200](https://github.com/craftcms/cms/issues/5200))
+- It’s now possible to filter users by user groups when querying for them using GraphQL. ([#5374](https://github.com/craftcms/cms/issues/5374)) 
 - Added `craft\controllers\UsersController::actionSessionInfo()`. ([#5355](https://github.com/craftcms/cms/issues/5355))
 - Added `craft\gql\types\Number`.
 - Added the `Craft.ui.createDateRangePicker()` JavaScript method.

diff --git a/src/gql/arguments/elements/User.php b/src/gql/arguments/elements/User.php
@@ -48,6 +48,16 @@ public static function getArguments(): array
                 'type' => Type::listOf(Type::string()),
                 'description' => 'Narrows the query results based on the users’ last names.'
             ],
+            'groupId' => [
+                'name' => 'groupId',
+                'type' => Type::listOf(QueryArgument::getType()),
+                'description' => 'Narrows the query results based on the user group the users belong to, per the groups’ IDs.'
+            ],
+            'group' => [
+                'name' => 'group',
+                'type' => Type::listOf(QueryArgument::getType()),
+                'description' => 'Narrows the query results based on the user group the users belong to.'
+            ],
         ]);
     }