BP_User_Query - user_ids parameter breaks pagination

[shanebp]

When using the bp_pre_user_query_construct hook to pass ids to the 'user_ids' parameter, the results on the Members page are as expected:

$query_array->query_vars['user_ids'] = $custom_ids_array;

But the pagination says:

Viewing member 1 to 0 (of 0 active members)

[shanebp]

If it's the case that using the 'user_ids' parameters assumes you are not on the Members page and are using the return for some other use case, then I will note that on the codex page for the class.

[imath]

hi @shanebp,

I confirm. I suggest 5271.diff to set $this->total_users if not in function do_wp_user_query()

[shanebp]

@imath -

I confirm your patch works on BP 1.8.1

Thank you!

Hopefully the patch will make it into 1.9 if not already there.

[DJPaul]

I think there's merit in the patch but Boone's the expert on this part of the code, as he wrote it.

Boone/JJJ/Ray: do we want this for BP 1.9 or 2.0?

[boonebgorges]

Good catch, imath. The technique seems good. I guess it makes more sense to me to do something like 5271.02.diff - same idea, but done in a place where I think it's easier to trace. imath, do you have any thoughts about it? Can you make sure it does what your patch does?

[imath]

Replying to boonebgorges:

Good catch, imath.

Thanks Boone, actually at first i did what you did in 5271.02.patch. The problem with this technique is that in this case if the array of user ids contains an id that doesn't exist, then the number of members displayed can be different than the total.

Example : the array( 1, 2, 9999999) will give you a total of 3 with your technique, but if 9999999 id doesn't exist it won't be displayed so the total is 3 and the number of displayed members is 2.

That's why i've chosen this part because we're sure to have a consistent total.

[boonebgorges]

Aha, good call. It's certainly an edge case that people would be passing invalid user IDs to BP_User_Query, but I suppose we should account for it. Thanks!

[boonebgorges]

In 7660:

Calculate fallback value for BP_User_Query::total_users

BP_User_Query normally calculates the total_users count with a separate COUNT
query; see BP_User_Query::do_user_ids_query(). However, this method is not
called when a $user_ids parameter is passed to BP_User_Query. This changeset
introduces an alternative method for calculating total_users in this case,
ensuring that pagination works as expected.

Fixes #5271

Props imath

[imath]

Replying to boonebgorges:

Aha, good call. It's certainly an edge case that people would be passing invalid user IDs to BP_User_Query, but I suppose we should account for it. Thanks!

you're welcome :)