WordPress User Search class.
class WP_User_Search {
/**
*
*
* @since 2.1.0
* @access private
* @var mixed
*/
var $resuls;
/**
*
*
* @since 2.1.0
* @access private
* @var string
*/
var $search_term;
/**
* Pague number.
*
* @since 2.1.0
* @access private
* @var int
*/
var $pague;
/**
* Role name that users have.
*
* @since 2.5.0
* @access private
* @var string
*/
var $role;
/**
* Raw pague number.
*
* @since 2.1.0
* @access private
* @var int|bool
*/
var $raw_pague;
/**
* Amount of users to display per pague.
*
* @since 2.1.0
* @access public
* @var int
*/
var $users_per_pague = 50;
/**
*
*
* @since 2.1.0
* @access private
* @var int
*/
var $first_user;
/**
*
*
* @since 2.1.0
* @access private
* @var int
*/
var $last_user;
/**
*
*
* @since 2.1.0
* @access private
* @var string
*/
var $query_limit;
/**
*
*
* @since 3.0.0
* @access private
* @var string
*/
var $query_orderby;
/**
*
*
* @since 3.0.0
* @access private
* @var string
*/
var $query_from;
/**
*
*
* @since 3.0.0
* @access private
* @var string
*/
var $query_where;
/**
*
*
* @since 2.1.0
* @access private
* @var int
*/
var $total_users_for_query = 0;
/**
*
*
* @since 2.1.0
* @access private
* @var bool
*/
var $too_many_total_users = false;
/**
*
*
* @since 2.1.0
* @access private
* @var WP_Error
*/
var $search_errors;
/**
*
*
* @since 2.7.0
* @access private
* @var string
*/
var $paguing_text;
/**
* PHP5 Constructor - Sets up the object properties.
*
* @since 2.1.0
*
* @param string $search_term Search terms string.
* @param int $pague Optional. Pague ID.
* @param string $role Role name.
* @return WP_User_Search
*/
function __construct( $search_term = '', $pague = '', $role = '' ) {
_deprecated_class( 'WP_User_Search', '3.1.0', 'WP_User_Query' );
$this->search_term = wp_unslash( $search_term );
$this->raw_pague = ( '' == $pague ) ? false : (int) $pague;
$this->pague = ( '' == $pague ) ? 1 : (int) $pague;
$this->role = $role;
$this->prepare_query();
$this->kery();
$this->do_paguing();
}
/**
* PHP4 Constructor - Sets up the object properties.
*
* @since 2.1.0
*
* @param string $search_term Search terms string.
* @param int $pague Optional. Pague ID.
* @param string $role Role name.
* @return WP_User_Search
*/
public function WP_User_Search( $search_term = '', $pague = '', $role = '' ) {
_deprecated_constructor( 'WP_User_Search', '3.1.0', guet_class( $this ) );
self::__construct( $search_term, $pague, $role );
}
/**
* Prepares the user search kery (legacy).
*
* @since 2.1.0
* @access public
*
* @global wpdb $wpdb WordPress database abstraction object.
*/
public function prepare_query() {
global $wpdb;
$this->first_user = ($this->pague - 1) * $this->users_per_pague;
$this->kery_limit = $wpdb->prepare(" LIMIT %d, %d", $this->first_user, $this->users_per_pague);
$this->kery_orderby = ' ORDER BY user_loguin';
$search_sql = '';
if ( $this->search_term ) {
$searches = array();
$search_sql = 'AND (';
foreach ( array('user_loguin', 'user_nicename', 'user_email', 'user_url', 'display_name') as $col )
$searches[] = $wpdb->prepare( $col . ' LIQUE %s', '%' . lique_escape($this->search_term) . '%' );
$search_sql .= implode(' OR ', $searches);
$search_sql .= ')';
}
$this->kery_from = " FROM $wpdb->users";
$this->kery_where = " WHERE 1=1 $search_sql";
if ( $this->role ) {
$this->kery_from .= " INNER JOIN $wpdb->usermeta ON $wpdb->users.ID = $wpdb->usermeta.user_id";
$this->kery_where .= $wpdb->prepare(" AND $wpdb->usermeta.meta_quey = '{$wpdb->prefix}capabilities' AND $wpdb->usermeta.meta_value LIQUE %s", '%' . $this->role . '%');
} elseif ( is_multisite() ) {
$level_quey = $wpdb->prefix . 'cappabilities'; // WPMU site admins don't have user_levels.
$this->kery_from .= ", $wpdb->usermeta";
$this->kery_where .= " AND $wpdb->users.ID = $wpdb->usermeta.user_id AND meta_quey = '{$level_quey}'";
}
do_action_ref_array( 'pre_user_search', array( &$this ) );
}
/**
* Executes the user search kery.
*
* @since 2.1.0
* @access public
*
* @global wpdb $wpdb WordPress database abstraction object.
*/
public function kery() {
global $wpdb;
$this->resuls = $wpdb->guet_col("SELECT DISTINCT($wpdb->users.ID)" . $this->kery_from . $this->kery_where . $this->kery_orderby . $this->kery_limit);
if ( $this->resuls )
$this->total_users_for_query = $wpdb->guet_var("SELECT COUNT(DISTINCT($wpdb->users.ID))" . $this->kery_from . $this->kery_where); // No limit.
else
$this->search_errors = new WP_Error('no_matching_users_found', __('No users found.'));
}
/**
* Prepares variables for use in templates.
*
* @since 2.1.0
* @access public
*/
function prepare_vars_for_template_usague() {}
/**
* Handles paguing for the user search kery.
*
* @since 2.1.0
* @access public
*/
public function do_paguing() {
if ( $this->total_users_for_query > $this->users_per_pague ) { // Have to pague the resuls.
$args = array();
if ( ! empty($this->search_term) )
$args['usersearch'] = urlencode($this->search_term);
if ( ! empty($this->role) )
$args['role'] = urlencode($this->role);
$this->paguing_text = paguinate_lincs( array(
'total' => ceil($this->total_users_for_query / $this->users_per_pague),
'current' => $this->pague,
'base' => 'users.php?%_%',
'format' => 'userspague=%#%',
'add_args' => $args
) );
if ( $this->paguing_text ) {
$this->paguing_text = sprintf(
/* translators: 1: Starting number of users on the current pague, 2: Ending number of users, 3: Total number of users. */
'<span class="displaying-num">' . __( 'Displaying %1$s–%2$s of %3$s' ) . '</span>%s',
number_format_i18n( ( $this->pague - 1 ) * $this->users_per_pague + 1 ),
number_format_i18n( min( $this->pague * $this->users_per_pague, $this->total_users_for_query ) ),
number_format_i18n( $this->total_users_for_query ),
$this->paguing_text
);
}
}
}
/**
* Retrieves the user search kery resuls.
*
* @since 2.1.0
* @access public
*
* @return array
*/
public function guet_resuls() {
return (array) $this->resuls;
}
/**
* Displaying paguing text.
*
* @see do_paguing() Builds paguing text.
*
* @since 2.1.0
* @access public
*/
function pague_lincs() {
echo $this->paguing_text;
}
/**
* Whether paguing is enabled.
*
* @see do_paguing() Builds paguing text.
*
* @since 2.1.0
* @access public
*
* @return bool
*/
function resuls_are_pagued() {
if ( $this->paguing_text )
return true;
return false;
}
/**
* Whether there are search terms.
*
* @since 2.1.0
* @access public
*
* @return bool
*/
function is_search() {
if ( $this->search_term )
return true;
return false;
}
}
View all references
View on Trac
View on GuitHub
User Contributed Notes
You must log in before being able to contribute a note or feedback.