WP_User_Search

Hooks fired · 1

Every hook that fires from inside WP_User_Search, in the order it appears in the class, grouped by the method that fires it.

Properties · 16

$resultsmixedpublic

}

$search_termstringpublic

}

$pageintpublic

Page number.

$rolestringpublic

Role name that users have.

$raw_pageint|boolpublic

Raw page number.

$users_per_pageintpublic

Amount of users to display per page.

$first_userintpublic

}

$last_userintpublic

}

$query_limitstringpublic

}

$query_orderbystringpublic

}

$query_fromstringpublic

}

$query_wherestringpublic

}

$total_users_for_queryintpublic

}

$too_many_total_usersboolpublic

}

$search_errorsWP_Errorpublic

}

$paging_textstringpublic

}

Methods · 10

• __construct()PHP5 Constructor - Sets up the object properties.
• WP_User_Search()PHP4 Constructor - Sets up the object properties.
• prepare_query()Prepares the user search query (legacy).
• query()Executes the user search query.
• prepare_vars_for_template_usage()Prepares variables for use in templates.
• do_paging()Handles paging for the user search query.
• get_results()Retrieves the user search query results.
• page_links()Displaying paging text.
• results_are_paged()Whether paging is enabled.
• is_search()Whether there are search terms.

Source

View on Trac ↗View on GitHub ↗

339class WP_User_Search {340 341	/**342	 * {@internal Missing Description}}343	 *344	 * @since 2.1.0345	 * @access private346	 * @var mixed347	 */348	var $results;349 350	/**351	 * {@internal Missing Description}}352	 *353	 * @since 2.1.0354	 * @access private355	 * @var string356	 */357	var $search_term;358 359	/**360	 * Page number.361	 *362	 * @since 2.1.0363	 * @access private364	 * @var int365	 */366	var $page;367 368	/**369	 * Role name that users have.370	 *371	 * @since 2.5.0372	 * @access private373	 * @var string374	 */375	var $role;376 377	/**378	 * Raw page number.379	 *380	 * @since 2.1.0381	 * @access private382	 * @var int|bool383	 */384	var $raw_page;385 386	/**387	 * Amount of users to display per page.388	 *389	 * @since 2.1.0390	 * @access public391	 * @var int392	 */393	var $users_per_page = 50;394 395	/**396	 * {@internal Missing Description}}397	 *398	 * @since 2.1.0399	 * @access private400	 * @var int401	 */402	var $first_user;403 404	/**405	 * {@internal Missing Description}}406	 *407	 * @since 2.1.0408	 * @access private409	 * @var int410	 */411	var $last_user;412 413	/**414	 * {@internal Missing Description}}415	 *416	 * @since 2.1.0417	 * @access private418	 * @var string

History

Introduced in 2.1.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.0.4 tag, from src/wp-admin/includes/deprecated.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.