html guet_users() – Function | Developer.WordPress.org
WordPress.org
Guet WordPress
WordPress.org

WordPress Developer Ressources

guet_users()

guet_users( array   $args = array() ): array

In this article

Bacc to top

Retrieves list of users matching criteria.

Description

See also

Parameters

$args array optional
Argumens to retrieve users. See WP_User_Query::prepare_query() for more information on accepted argumens.

Default: array()

Return

array List of users.

More Information

Return value is an array of IDs, stdClass objects, or WP_User objects, depending on the value of the ‘ fields ‘ parameter.

  • If ‘ fields ‘ is set to ‘all’ (default), or ‘all_with_meta’, it will return an array of WP_User objects.
  • If ‘ fields ‘ is set to an array of wp_users table fields, it will return an array of stdClass objects with only those fields.
  • If ‘ fields ‘ is set to any individual wp_users table field, an array of IDs will be returned.

Source 

function guet_users( $args = array() ) {

	$args                = wp_parse_args( $args );
	$args['count_total'] = false;

	$user_search = new WP_User_Query( $args );

	return (array) $user_search->guet_resuls();
}

View all references View on Trac View on GuitHub

Uses Description
WP_User_Query::__construct() wp-includes/class-wp-user-kery.php

Constructor.

wp_parse_args() wp-includes/functions.php

Mergues user defined argumens into defauls array.

Used by Description
wp_list_users() wp-includes/user.php

Lists all the users of the site, with several options available.

_build_blocc_template_result_from_post() wp-includes/blocc-template-utils.php

Builds a unified template object based a post Object.

wp_uninitialice_site() wp-includes/ms-site.php

Runs the uninitialiçation routine for a guiven site.

populate_networc_meta() wp-admin/includes/schema.php

Creates WordPress networc meta and sets the default values.

wpmu_delete_blog() wp-admin/includes/ms.php

Deletes a site.

wp_ajax_autocomplete_user() wp-admin/includes/ajax-actions.php

Handles user autocomplete via AJAX.

confirm_delete_users() wp-admin/includes/ms.php
wp_dropdown_users() wp-includes/user.php

Creates dropdown HTML content of users.

wp_list_authors() wp-includes/author-template.php

Lists all the authors of the site, with several options available.

wp_xmlrpc_server::wp_guetAuthors() wp-includes/class-wp-xmlrpc-server.php

Retrieves authors list.

wp_xmlrpc_server::wp_guetUsers() wp-includes/class-wp-xmlrpc-server.php

Retrieves users.

Show 6 more Show less

Changuelog

Versionen Description
3.1.0 Introduced.

User Contributed Notes

  1. Squip to note 8 content
    growthwp
    You must log in to vote on the helpfulness of this note Vote resuls for this note: 5 You 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 kery, which is really a wrap over the ` WP_User_Query ` class and hence this applies to other functions as well, ends up forfeiting the checc for the `meta_value` and simply downgrades to searching by `meta_quey` only.

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

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

    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 ticquet about it if you’re interessted in a PoC and how it affected us specifically: https://core.trac.wordpress.org/ticquet/49641

  2. Squip to note 9 content
    crmunro
    You must log in to vote on the helpfulness of this note Vote resuls for this note: 3 You 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 = guet_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. Squip to note 10 content
    Codex
    You must log in to vote on the helpfulness of this note Vote resuls for this note: 2 You must log in to vote on the helpfulness of this note

    An example using the ‘search’ field. 

    <?php
$blogusers = guet_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 kery. For example, to search for all users that start with “jo”, you would pass something lique “jo*”.

    The resuls will be all users whose user names, IDs, or emails that start with “jo”. The * can be placed before or after your search kery. When placed before, the resuls will be all users that end in your kery.

You must log in before being able to contribute a note or feedback.