WC_API_Customers::query_customers() private WC 2.1

Helper method to get customer user objects

Note that WP_User_Query does not have built-in pagination so limit & offset are used to provide limited pagination support

{} It's a method of the class: WC_API_Customers{}

No Hooks.

Return

WP_User_Query.

Usage

// private - for code of main (parent) class only
$result = $this->query_customers( $args );

$args(array)

request arguments for filtering query

Changelog

Code of WC_API_Customers::query_customers() WC API Customers::query customers ^{WC 5.0.0}

<?php
private function query_customers( $args = array() ) {

	// default users per page
	$users_per_page = get_option( 'posts_per_page' );

	// set base query arguments
	$query_args = array(
		'fields'  => 'ID',
		'role'    => 'customer',
		'orderby' => 'registered',
		'number'  => $users_per_page,
	);

	// search
	if ( ! empty( $args['q'] ) ) {
		$query_args['search'] = $args['q'];
	}

	// limit number of users returned
	if ( ! empty( $args['limit'] ) ) {

		$query_args['number'] = absint( $args['limit'] );

		$users_per_page = absint( $args['limit'] );
	}

	// page
	$page = ( isset( $args['page'] ) ) ? absint( $args['page'] ) : 1;

	// offset
	if ( ! empty( $args['offset'] ) ) {
		$query_args['offset'] = absint( $args['offset'] );
	} else {
		$query_args['offset'] = $users_per_page * ( $page - 1 );
	}

	// created date
	if ( ! empty( $args['created_at_min'] ) ) {
		$this->created_at_min = $this->server->parse_datetime( $args['created_at_min'] );
	}

	if ( ! empty( $args['created_at_max'] ) ) {
		$this->created_at_max = $this->server->parse_datetime( $args['created_at_max'] );
	}

	$query = new WP_User_Query( $query_args );

	// helper members for pagination headers
	$query->total_pages = ceil( $query->get_total() / $users_per_page );
	$query->page = $page;

	return $query;
}