Add nicename__in and nicename__not_in to WP_User_Query

[johnjamesjacoby]

I have a need to query for multiple users by their nicenames. Right now, I do something like this:

// Get usernames
$usernames = some_function_to_get_usernames();

// Loop through usernames and link to profiles
foreach ( (array) $usernames as $username ) {

	// Skip if username does not exist or user is not active
	$user = get_user_by( 'slug', $username );
	if ( empty( $user->ID ) ) {
		continue;
	}

	// Some things...
}

It would be great if WP_User_Query worked in the following ways:

__in:

$users = new WP_User_Query( array(
	'nicename__in' => array( 'admin', 'john', 'paul' )
) );

__not_in:

$users = new WP_User_Query( array(
	'nicename__not_in' => array( 'admin' )
) );

---

The "nice" thing about this, is user_nicename is an indexed column, so these queries should be speedy and internally optimized by MySQL.

[sebastian.pisula]

I like this, great idea :)

[boonebgorges]

If we're going to add nicename__*, it probably makes sense to do login__* at the same time.

[johnjamesjacoby]

Replying to boonebgorges:

If we're going to add nicename__*, it probably makes sense to do login__* at the same time.

Sure thing. I can refresh the patch.

[atomicadam]

Replying to johnjamesjacoby:

Replying to boonebgorges:

If we're going to add nicename__*, it probably makes sense to do login__* at the same time.

Sure thing. I can work on a patch.

@johnjamesjacoby - you still working on this?

[johnjamesjacoby]

@atomicadam I have yet to, so don't let that stop you from taking a stab at it. It's mostly a copy-paste job from existing (don't forget the orderby additions.)

[atomicadam]

Replying to johnjamesjacoby:

@atomicadam I have yet to, so don't let that stop you from taking a stab at it. It's mostly a copy-paste job from existing (don't forget the orderby additions.)

sounds good, i'll see what I can come up with. thanks

[ryanplas]

Took a stab at it. This is my first patch with real code and unit tests, so let me know if I missed something.

[boonebgorges]

Took a stab at it. This is my first patch with real code and unit tests, so let me know if I missed something.

Wow, this is a great first patch! Thanks, @ryanplas! A few small things:

• We'll need a @since annotation for the new WP_User_Query::prepare_query() parameters.
• "Matched users must have at least one..." is a weird thing to say about logins or nicenames, since users can only have one :) Maybe find a better way to phrase it.
• The __in and __not_in clauses need to have their values sanitized. Something like this should work: array_map( 'esc_sql', $qv['nicename__in'] ) ...

[ryanplas]

Cleaned up the wording in the docs, added the @since annotation and added sanitization.

[boonebgorges]

Thank you @ryanplas - The orderby clauses need sanitization too, which I'll add.

[boonebgorges]

In 38715:

Query: Add nicename and login params to user query.

New parameters are: login, login__in, login__not_in, nicename,
nicename__in, nicename__not_in.

login__in and nicename__in are also now valid values for the
'orderby' parameter.

Props ryanplas.
Fixes #36624.

[ryanplas]

@boonebgorges oops - my bad. Thanks for taking the time to review my patch!