Schema Documentation
RootQueryToUserConnectionWhereArgs
Description
Arguments for filtering the RootQueryToUserConnection connection
Fields
Input Field | Description |
---|---|
exclude - [Int] | Array of userIds to exclude. |
hasPublishedPosts - [ContentTypeEnum] | Pass an array of post types to filter results to users who have published posts in those post types. |
include - [Int] | Array of userIds to include. |
login - String | The user login. |
loginIn - [String] | An array of logins to include. Users matching one of these logins will be included in results. |
loginNotIn - [String] | An array of logins to exclude. Users matching one of these logins will not be included in results. |
nicename - String | The user nicename. |
nicenameIn - [String] | An array of nicenames to include. Users matching one of these nicenames will be included in results. |
nicenameNotIn - [String] | An array of nicenames to exclude. Users matching one of these nicenames will not be included in results. |
orderby - [UsersConnectionOrderbyInput] | What paramater to use to order the objects by. |
role - UserRoleEnum | An array of role names that users must match to be included in results. Note that this is an inclusive list: users must match each role. |
roleIn - [UserRoleEnum] | An array of role names. Matched users must have at least one of these roles. |
roleNotIn - [UserRoleEnum] | An array of role names to exclude. Users matching one or more of these roles will not be included in results. |
search - String | Search keyword. Searches for possible string matches on columns. When "searchColumns" is left empty, it tries to determine which column to search in based on search string. |
searchColumns - [UsersConnectionSearchColumnEnum] | Array of column names to be searched. Accepts 'ID', 'login', 'nicename', 'email', 'url'. |
Example
{"exclude":[987],"hasPublishedPosts":["ATTACHMENT"],"include":[123],"login":"xyz789","loginIn":["abc123"],"loginNotIn":["abc123"],"nicename":"abc123","nicenameIn":["xyz789"],"nicenameNotIn":["abc123"],"orderby":[UsersConnectionOrderbyInput],"role":"AUTHOR","roleIn":["AUTHOR"],"roleNotIn":["AUTHOR"],"search":"xyz789","searchColumns":["EMAIL"]}