WC_API_Customers::get_customers( array $fields = null, array $filter = array(), int $page = 1 )
Get all customers
Description Description
Parameters Parameters
- $fields
-
(Optional)
Default value: null
- $filter
-
(Optional)
Default value: array()
- $page
-
(Optional)
Default value: 1
Return Return
(array)
Source Source
File: includes/legacy/api/v2/class-wc-api-customers.php
public function get_customers( $fields = null, $filter = array(), $page = 1 ) {
$filter['page'] = $page;
$query = $this->query_customers( $filter );
$customers = array();
foreach ( $query->get_results() as $user_id ) {
if ( ! $this->is_readable( $user_id ) ) {
continue;
}
$customers[] = current( $this->get_customer( $user_id, $fields ) );
}
$this->server->add_pagination_headers( $query );
return array( 'customers' => $customers );
}
Changelog Changelog
| Version | Description |
|---|---|
| 2.1 | Introduced. |