get_users( array $args = array() ): array

User Contributed Notes

1. Skip to note 8 content

   growthwp 5 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 5You must log in to vote on the helpfulness of this note

   Please note that if you search by `meta_value` and it ends up being `”` (an empty string), the query, which is really a wrap over the `WP_User_Query` class and hence this applies to other functions as well, ends up forfeiting the check for the `meta_value` and simply downgrades to searching by `meta_key` only.

   Please be very careful when you have `meta_values` that are dynamic or that you can’t/don’t check for this exact case, if the list that you retrieve using this query is used for something important, you might end up with security holes.

   “User input should be parsed”. Yes, but, user input should not be immediately `esc_html`’d or the like, escape at output, sanitize before queries and now that we know this, check for validity — but here lies the problem, we, as well as some people who’ve been with WP for 10+ years didn’t know about this behavior. A `preg_match` fixes it all, yes, but only if your assumptions are updated with this knowledge.

   Additionally, this is not a case of “you just forgot to parse”, we parse everything that comes inside and had security audits on our core codebase pieces but just simply weren’t aware of this behavior and assumed we didn’t even need to parse.

   I’ve opened a ticket about it if you’re interested in a PoC and how it affected us specifically: https://core.trac.wordpress.org/ticket/49641
2. Skip to note 9 content

   crmunro 8 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this note

   An example of fetching users that match any one of an array of roles using role__in.

   <?php
   $blogusers = get_users( array( 'role__in' => array( 'author', 'subscriber' ) ) );
   // Array of WP_User objects.
   foreach ( $blogusers as $user ) {
       echo '<span>' . esc_html( $user->display_name ) . '</span>';
   }
3. Skip to note 10 content

   Codex 10 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note

   An example using the ‘search’ field.

   <?php
   $blogusers = get_users( array( 'search' => 'john' ) );
   // Array of WP_User objects.
   foreach ( $blogusers as $user ) {
   	echo '<span>' . esc_html( $user->user_email ) . '</span>';
   }

   This example will find and display all users that have a user name, ID, email of “john”. You can also do wild card search by adding an * before or after your search query. For example, to search for all users that start with “jo”, you would pass something like “jo*”.

   The results will be all users whose user names, IDs, or emails that start with “jo”. The * can be placed before or after your search query. When placed before, the results will be all users that end in your query.
4. Skip to note 11 content

   Codex 10 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

   A basic example to display all subscribers in an unordered list.

   <?php
   $blogusers = get_users( 'blog_id=1&orderby=nicename&role=subscriber' );
   // Array of WP_User objects.
   foreach ( $blogusers as $user ) {
   	echo '<span>' . esc_html( $user->user_email ) . '</span>';
   }
5. Skip to note 12 content

   Codex 10 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

   An example of querying by a specific field.

   <?php
   $blogusers = get_users( array( 'fields' => array( 'display_name' ) ) );
   // Array of stdClass objects.
   foreach ( $blogusers as $user ) {
   	echo '<span>' . esc_html( $user->display_name ) . '</span>';
   }
6. Skip to note 13 content

   Pepro Dev. Group 3 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

   WP_User_Query now accepts fields options in WordPress 6.0
   https://make.wordpress.org/core/2022/04/29/wp_user_query-now-accepts-fields-options-in-wordpress-6-0/
7. Skip to note 14 content

   Kowsar Hossain 2 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

   The default value of the number parameter is -1, which means it lists all the users. It can cause performance issues on larger sites, so it should be used with caution.