2013-11-04 06:36:31 +00:00
< ? php
/**
* WooCommerce API Customers Class
*
* Handles requests to the / customers endpoint
*
2015-01-05 18:06:52 +00:00
* @ author WooThemes
* @ category API
* @ package WooCommerce / API
* @ since 2.2
2013-11-04 06:36:31 +00:00
*/
2014-09-20 19:24:20 +00:00
if ( ! defined ( 'ABSPATH' ) ) {
exit ; // Exit if accessed directly
}
2013-11-04 06:36:31 +00:00
2013-11-09 21:20:23 +00:00
class WC_API_Customers extends WC_API_Resource {
2013-11-04 06:36:31 +00:00
/** @var string $base the route base */
protected $base = '/customers' ;
2013-11-10 23:28:58 +00:00
/** @var string $created_at_min for date filtering */
private $created_at_min = null ;
/** @var string $created_at_max for date filtering */
private $created_at_max = null ;
2013-11-04 06:36:31 +00:00
/**
* Setup class , overridden to provide customer data to order response
*
* @ since 2.1
2013-11-06 06:54:19 +00:00
* @ param WC_API_Server $server
2013-11-04 06:36:31 +00:00
*/
2013-11-06 06:54:19 +00:00
public function __construct ( WC_API_Server $server ) {
2013-11-04 06:36:31 +00:00
parent :: __construct ( $server );
// add customer data to order responses
2013-11-11 00:29:36 +00:00
add_filter ( 'woocommerce_api_order_response' , array ( $this , 'add_customer_data' ), 10 , 2 );
2013-11-10 23:28:58 +00:00
// modify WP_User_Query to support created_at date filtering
add_action ( 'pre_user_query' , array ( $this , 'modify_user_query' ) );
2013-11-04 06:36:31 +00:00
}
/**
* Register the routes for this class
*
2013-11-23 20:01:53 +00:00
* GET / customers
2013-11-04 06:36:31 +00:00
* GET / customers / count
2013-11-23 20:01:53 +00:00
* GET / customers /< id >
2013-11-04 06:36:31 +00:00
* GET / customers /< id >/ orders
*
2014-03-05 01:48:54 +00:00
* @ since 2.2
2013-11-04 06:36:31 +00:00
* @ param array $routes
* @ return array
*/
2013-11-11 00:29:36 +00:00
public function register_routes ( $routes ) {
2013-11-04 06:36:31 +00:00
2014-03-04 00:13:44 +00:00
# GET/POST /customers
2013-11-04 06:36:31 +00:00
$routes [ $this -> base ] = array (
2014-03-05 01:48:54 +00:00
array ( array ( $this , 'get_customers' ), WC_API_SERVER :: READABLE ),
array ( array ( $this , 'create_customer' ), WC_API_SERVER :: CREATABLE | WC_API_Server :: ACCEPT_DATA ),
2013-11-04 06:36:31 +00:00
);
# GET /customers/count
2016-08-27 03:11:30 +00:00
$routes [ $this -> base . '/count' ] = array (
2013-11-11 00:29:36 +00:00
array ( array ( $this , 'get_customers_count' ), WC_API_SERVER :: READABLE ),
2013-11-04 06:36:31 +00:00
);
2014-03-04 01:16:54 +00:00
# GET/PUT/DELETE /customers/<id>
2013-11-04 06:36:31 +00:00
$routes [ $this -> base . '/(?P<id>\d+)' ] = array (
2014-03-05 01:48:54 +00:00
array ( array ( $this , 'get_customer' ), WC_API_SERVER :: READABLE ),
array ( array ( $this , 'edit_customer' ), WC_API_SERVER :: EDITABLE | WC_API_SERVER :: ACCEPT_DATA ),
2014-03-04 01:16:54 +00:00
array ( array ( $this , 'delete_customer' ), WC_API_SERVER :: DELETABLE ),
2013-11-04 06:36:31 +00:00
);
2014-08-30 19:50:40 +00:00
# GET /customers/email/<email>
2014-02-17 17:13:01 +00:00
$routes [ $this -> base . '/email/(?P<email>.+)' ] = array (
2014-03-05 01:48:54 +00:00
array ( array ( $this , 'get_customer_by_email' ), WC_API_SERVER :: READABLE ),
2014-02-17 13:19:11 +00:00
);
2013-11-04 06:36:31 +00:00
# GET /customers/<id>/orders
$routes [ $this -> base . '/(?P<id>\d+)/orders' ] = array (
2013-11-11 00:29:36 +00:00
array ( array ( $this , 'get_customer_orders' ), WC_API_SERVER :: READABLE ),
2013-11-04 06:36:31 +00:00
);
2014-05-28 17:06:46 +00:00
# GET /customers/<id>/downloads
$routes [ $this -> base . '/(?P<id>\d+)/downloads' ] = array (
array ( array ( $this , 'get_customer_downloads' ), WC_API_SERVER :: READABLE ),
);
2015-05-07 16:09:59 +00:00
# POST|PUT /customers/bulk
$routes [ $this -> base . '/bulk' ] = array (
array ( array ( $this , 'bulk' ), WC_API_Server :: EDITABLE | WC_API_Server :: ACCEPT_DATA ),
);
2013-11-04 06:36:31 +00:00
return $routes ;
}
/**
* Get all customers
*
2014-03-05 17:24:47 +00:00
* @ since 2.1
2013-11-04 06:36:31 +00:00
* @ param array $fields
2013-11-11 00:29:36 +00:00
* @ param array $filter
2013-11-19 02:06:45 +00:00
* @ param int $page
2013-11-04 06:36:31 +00:00
* @ return array
*/
2013-11-19 02:06:45 +00:00
public function get_customers ( $fields = null , $filter = array (), $page = 1 ) {
$filter [ 'page' ] = $page ;
2013-11-04 06:36:31 +00:00
2013-11-11 00:29:36 +00:00
$query = $this -> query_customers ( $filter );
2013-11-04 06:36:31 +00:00
$customers = array ();
2014-03-05 01:48:54 +00:00
foreach ( $query -> get_results () as $user_id ) {
2013-11-04 06:36:31 +00:00
2014-03-05 01:48:54 +00:00
if ( ! $this -> is_readable ( $user_id ) ) {
2013-11-11 00:29:36 +00:00
continue ;
2014-03-05 01:48:54 +00:00
}
2013-11-11 00:29:36 +00:00
2013-11-22 08:41:32 +00:00
$customers [] = current ( $this -> get_customer ( $user_id , $fields ) );
2013-11-04 06:36:31 +00:00
}
2013-11-19 02:06:45 +00:00
$this -> server -> add_pagination_headers ( $query );
2013-11-11 00:29:36 +00:00
2013-11-04 06:36:31 +00:00
return array ( 'customers' => $customers );
}
/**
* Get the customer for the given ID
*
2014-03-05 17:24:47 +00:00
* @ since 2.1
2013-11-04 06:36:31 +00:00
* @ param int $id the customer ID
2015-02-03 14:17:49 +00:00
* @ param array $fields
2017-05-15 11:50:52 +00:00
* @ return array | WP_Error
2013-11-04 06:36:31 +00:00
*/
2013-11-11 00:29:36 +00:00
public function get_customer ( $id , $fields = null ) {
2013-11-04 06:36:31 +00:00
global $wpdb ;
2013-11-11 00:29:36 +00:00
$id = $this -> validate_request ( $id , 'customer' , 'read' );
2013-11-04 06:36:31 +00:00
2014-03-05 01:48:54 +00:00
if ( is_wp_error ( $id ) ) {
2013-11-11 00:29:36 +00:00
return $id ;
2014-03-05 01:48:54 +00:00
}
2013-11-04 06:36:31 +00:00
2016-11-17 23:55:52 +00:00
$customer = new WC_Customer ( $id );
$last_order = $customer -> get_last_order ();
2013-11-04 06:36:31 +00:00
$customer_data = array (
2016-11-17 23:55:52 +00:00
'id' => $customer -> get_id (),
2017-03-10 21:10:03 +00:00
'created_at' => $this -> server -> format_datetime ( $customer -> get_date_created () ? $customer -> get_date_created () -> getTimestamp () : 0 ), // API gives UTC times.
'last_update' => $this -> server -> format_datetime ( $customer -> get_date_modified () ? $customer -> get_date_modified () -> getTimestamp () : 0 ), // API gives UTC times.
2016-11-17 23:55:52 +00:00
'email' => $customer -> get_email (),
'first_name' => $customer -> get_first_name (),
'last_name' => $customer -> get_last_name (),
'username' => $customer -> get_username (),
'role' => $customer -> get_role (),
2016-08-05 14:56:23 +00:00
'last_order_id' => is_object ( $last_order ) ? $last_order -> get_id () : null ,
2017-03-10 21:10:03 +00:00
'last_order_date' => is_object ( $last_order ) ? $this -> server -> format_datetime ( $last_order -> get_date_created () ? $last_order -> get_date_created () -> getTimestamp () : 0 ) : null , // API gives UTC times.
2016-11-17 23:55:52 +00:00
'orders_count' => $customer -> get_order_count (),
'total_spent' => wc_format_decimal ( $customer -> get_total_spent (), 2 ),
'avatar_url' => $customer -> get_avatar_url (),
2013-11-04 06:36:31 +00:00
'billing_address' => array (
2016-11-17 23:55:52 +00:00
'first_name' => $customer -> get_billing_first_name (),
'last_name' => $customer -> get_billing_last_name (),
'company' => $customer -> get_billing_company (),
'address_1' => $customer -> get_billing_address_1 (),
'address_2' => $customer -> get_billing_address_2 (),
'city' => $customer -> get_billing_city (),
'state' => $customer -> get_billing_state (),
'postcode' => $customer -> get_billing_postcode (),
'country' => $customer -> get_billing_country (),
'email' => $customer -> get_billing_email (),
'phone' => $customer -> get_billing_phone (),
2013-11-04 06:36:31 +00:00
),
'shipping_address' => array (
2016-11-17 23:55:52 +00:00
'first_name' => $customer -> get_shipping_first_name (),
'last_name' => $customer -> get_shipping_last_name (),
'company' => $customer -> get_shipping_company (),
'address_1' => $customer -> get_shipping_address_1 (),
'address_2' => $customer -> get_shipping_address_2 (),
'city' => $customer -> get_shipping_city (),
'state' => $customer -> get_shipping_state (),
'postcode' => $customer -> get_shipping_postcode (),
'country' => $customer -> get_shipping_country (),
2013-11-04 06:36:31 +00:00
),
);
2013-11-22 08:41:32 +00:00
return array ( 'customer' => apply_filters ( 'woocommerce_api_customer_response' , $customer_data , $customer , $fields , $this -> server ) );
2013-11-04 06:36:31 +00:00
}
2014-02-17 14:39:56 +00:00
/**
* Get the customer for the given email
*
2014-03-05 17:24:47 +00:00
* @ since 2.1
2017-05-15 11:50:52 +00:00
*
2014-02-17 14:39:56 +00:00
* @ param string $email the customer email
2015-02-03 14:44:53 +00:00
* @ param array $fields
2017-05-15 11:50:52 +00:00
*
* @ return array | WP_Error
2014-02-17 14:39:56 +00:00
*/
2014-08-30 19:50:40 +00:00
public function get_customer_by_email ( $email , $fields = null ) {
2015-01-05 18:06:52 +00:00
try {
if ( is_email ( $email ) ) {
$customer = get_user_by ( 'email' , $email );
if ( ! is_object ( $customer ) ) {
2016-11-18 06:16:38 +00:00
throw new WC_API_Exception ( 'woocommerce_api_invalid_customer_email' , __ ( 'Invalid customer email' , 'woocommerce' ), 404 );
2015-01-05 18:06:52 +00:00
}
} else {
2016-11-18 06:16:38 +00:00
throw new WC_API_Exception ( 'woocommerce_api_invalid_customer_email' , __ ( 'Invalid customer email' , 'woocommerce' ), 404 );
2014-02-17 14:39:56 +00:00
}
2015-01-05 18:06:52 +00:00
return $this -> get_customer ( $customer -> ID , $fields );
} catch ( WC_API_Exception $e ) {
return new WP_Error ( $e -> getErrorCode (), $e -> getMessage (), array ( 'status' => $e -> getCode () ) );
}
2014-02-17 14:39:56 +00:00
}
2013-11-04 06:36:31 +00:00
/**
* Get the total number of customers
*
2014-03-05 17:24:47 +00:00
* @ since 2.1
2017-05-15 11:50:52 +00:00
*
2013-11-11 00:29:36 +00:00
* @ param array $filter
2017-05-15 11:50:52 +00:00
*
* @ return array | WP_Error
2013-11-04 06:36:31 +00:00
*/
2013-11-11 00:29:36 +00:00
public function get_customers_count ( $filter = array () ) {
2015-01-05 18:06:52 +00:00
try {
if ( ! current_user_can ( 'list_users' ) ) {
throw new WC_API_Exception ( 'woocommerce_api_user_cannot_read_customers_count' , __ ( 'You do not have permission to read the customers count' , 'woocommerce' ), 401 );
}
2013-11-04 06:36:31 +00:00
2015-01-05 18:06:52 +00:00
$query = $this -> query_customers ( $filter );
2013-11-11 00:29:36 +00:00
2015-10-01 08:54:30 +00:00
return array ( 'count' => $query -> get_total () );
2015-01-05 18:06:52 +00:00
} catch ( WC_API_Exception $e ) {
return new WP_Error ( $e -> getErrorCode (), $e -> getMessage (), array ( 'status' => $e -> getCode () ) );
2014-03-05 01:48:54 +00:00
}
2013-11-04 06:36:31 +00:00
}
2014-08-30 19:50:40 +00:00
/**
* Get customer billing address fields .
*
* @ since 2.2
* @ return array
*/
protected function get_customer_billing_address () {
$billing_address = apply_filters ( 'woocommerce_api_customer_billing_address' , array (
'first_name' ,
'last_name' ,
'company' ,
'address_1' ,
'address_2' ,
'city' ,
'state' ,
'postcode' ,
'country' ,
'email' ,
'phone' ,
) );
return $billing_address ;
}
/**
* Get customer shipping address fields .
*
* @ since 2.2
* @ return array
*/
protected function get_customer_shipping_address () {
$shipping_address = apply_filters ( 'woocommerce_api_customer_shipping_address' , array (
'first_name' ,
'last_name' ,
'company' ,
'address_1' ,
'address_2' ,
'city' ,
'state' ,
'postcode' ,
'country' ,
) );
return $shipping_address ;
}
2014-03-04 02:01:07 +00:00
/**
* Add / Update customer data .
*
* @ since 2.2
* @ param int $id the customer ID
* @ param array $data
2016-11-18 06:16:38 +00:00
* @ param WC_Customer $customer
2014-03-04 02:01:07 +00:00
*/
2016-11-18 06:16:38 +00:00
protected function update_customer_data ( $id , $data , $customer ) {
2014-03-04 02:01:07 +00:00
// Customer first name.
if ( isset ( $data [ 'first_name' ] ) ) {
2016-11-18 06:16:38 +00:00
$customer -> set_first_name ( wc_clean ( $data [ 'first_name' ] ) );
2014-03-04 02:01:07 +00:00
}
// Customer last name.
if ( isset ( $data [ 'last_name' ] ) ) {
2016-11-18 06:16:38 +00:00
$customer -> set_last_name ( wc_clean ( $data [ 'last_name' ] ) );
2014-03-04 02:01:07 +00:00
}
// Customer billing address.
if ( isset ( $data [ 'billing_address' ] ) ) {
2016-11-18 06:16:38 +00:00
foreach ( $this -> get_customer_billing_address () as $field ) {
if ( isset ( $data [ 'billing_address' ][ $field ] ) ) {
if ( is_callable ( array ( $customer , " set_billing_ { $field } " ) ) ) {
$customer -> { " set_billing_ { $field } " }( $data [ 'billing_address' ][ $field ] );
} else {
2017-02-16 03:42:47 +00:00
$customer -> update_meta_data ( 'billing_' . $field , wc_clean ( $data [ 'billing_address' ][ $field ] ) );
2016-11-18 06:16:38 +00:00
}
2014-03-04 02:01:07 +00:00
}
}
}
// Customer shipping address.
if ( isset ( $data [ 'shipping_address' ] ) ) {
2016-11-18 06:16:38 +00:00
foreach ( $this -> get_customer_shipping_address () as $field ) {
if ( isset ( $data [ 'shipping_address' ][ $field ] ) ) {
if ( is_callable ( array ( $customer , " set_shipping_ { $field } " ) ) ) {
$customer -> { " set_shipping_ { $field } " }( $data [ 'shipping_address' ][ $field ] );
} else {
2017-02-16 03:42:47 +00:00
$customer -> update_meta_data ( 'shipping_' . $field , wc_clean ( $data [ 'shipping_address' ][ $field ] ) );
2016-11-18 06:16:38 +00:00
}
2014-03-04 02:01:07 +00:00
}
}
}
2016-11-18 06:16:38 +00:00
do_action ( 'woocommerce_api_update_customer_data' , $id , $data , $customer );
2014-03-04 02:01:07 +00:00
}
2013-11-04 06:36:31 +00:00
/**
* Create a customer
*
2014-03-04 00:04:40 +00:00
* @ since 2.2
2017-05-15 11:50:52 +00:00
*
2013-11-04 06:36:31 +00:00
* @ param array $data
2017-05-15 11:50:52 +00:00
*
* @ return array | WP_Error
2013-11-04 06:36:31 +00:00
*/
2013-11-11 00:29:36 +00:00
public function create_customer ( $data ) {
2015-01-05 18:06:52 +00:00
try {
2015-04-13 16:06:19 +00:00
if ( ! isset ( $data [ 'customer' ] ) ) {
throw new WC_API_Exception ( 'woocommerce_api_missing_customer_data' , sprintf ( __ ( 'No %1$s data specified to create %1$s' , 'woocommerce' ), 'customer' ), 400 );
}
$data = $data [ 'customer' ];
2013-11-11 00:29:36 +00:00
2015-01-05 18:06:52 +00:00
// Checks with can create new users.
if ( ! current_user_can ( 'create_users' ) ) {
throw new WC_API_Exception ( 'woocommerce_api_user_cannot_create_customer' , __ ( 'You do not have permission to create this customer' , 'woocommerce' ), 401 );
}
2014-03-04 00:04:40 +00:00
2015-01-05 18:06:52 +00:00
$data = apply_filters ( 'woocommerce_api_create_customer_data' , $data , $this );
2014-08-30 19:50:40 +00:00
2015-01-05 18:06:52 +00:00
// Checks with the email is missing.
if ( ! isset ( $data [ 'email' ] ) ) {
throw new WC_API_Exception ( 'woocommerce_api_missing_customer_email' , sprintf ( __ ( 'Missing parameter %s' , 'woocommerce' ), 'email' ), 400 );
}
2014-03-04 00:04:40 +00:00
2016-11-18 06:16:38 +00:00
// Create customer.
$customer = new WC_Customer ;
$customer -> set_username ( ! empty ( $data [ 'username' ] ) ? $data [ 'username' ] : '' );
$customer -> set_password ( ! empty ( $data [ 'password' ] ) ? $data [ 'password' ] : '' );
$customer -> set_email ( $data [ 'email' ] );
$customer -> save ();
2014-03-04 00:04:40 +00:00
2016-11-18 06:16:38 +00:00
if ( ! $customer -> get_id () ) {
throw new WC_API_Exception ( 'woocommerce_api_user_cannot_create_customer' , __ ( 'This resource cannot be created.' , 'woocommerce' ), 400 );
2015-01-05 18:06:52 +00:00
}
2014-03-04 00:04:40 +00:00
2015-01-05 18:06:52 +00:00
// Added customer data.
2016-11-18 06:16:38 +00:00
$this -> update_customer_data ( $customer -> get_id (), $data , $customer );
$customer -> save ();
2013-11-04 06:36:31 +00:00
2016-11-18 06:16:38 +00:00
do_action ( 'woocommerce_api_create_customer' , $customer -> get_id (), $data );
2014-03-04 01:09:05 +00:00
2015-01-05 18:06:52 +00:00
$this -> server -> send_status ( 201 );
2014-03-06 07:28:42 +00:00
2016-11-18 06:16:38 +00:00
return $this -> get_customer ( $customer -> get_id () );
} catch ( Exception $e ) {
2015-01-05 18:06:52 +00:00
return new WP_Error ( $e -> getErrorCode (), $e -> getMessage (), array ( 'status' => $e -> getCode () ) );
}
2013-11-04 06:36:31 +00:00
}
/**
* Edit a customer
*
2014-03-04 01:07:28 +00:00
* @ since 2.2
2017-05-15 11:50:52 +00:00
*
2013-11-04 06:36:31 +00:00
* @ param int $id the customer ID
* @ param array $data
2017-05-15 11:50:52 +00:00
*
* @ return array | WP_Error
2013-11-04 06:36:31 +00:00
*/
2013-11-11 00:29:36 +00:00
public function edit_customer ( $id , $data ) {
2015-04-13 16:06:19 +00:00
try {
if ( ! isset ( $data [ 'customer' ] ) ) {
throw new WC_API_Exception ( 'woocommerce_api_missing_customer_data' , sprintf ( __ ( 'No %1$s data specified to edit %1$s' , 'woocommerce' ), 'customer' ), 400 );
}
2013-11-11 00:29:36 +00:00
2015-04-13 16:06:19 +00:00
$data = $data [ 'customer' ];
2014-08-30 19:50:40 +00:00
2015-04-13 16:06:19 +00:00
// Validate the customer ID.
$id = $this -> validate_request ( $id , 'customer' , 'edit' );
2013-11-11 00:29:36 +00:00
2015-04-13 16:06:19 +00:00
// Return the validate error.
if ( is_wp_error ( $id ) ) {
throw new WC_API_Exception ( $id -> get_error_code (), $id -> get_error_message (), 400 );
}
2014-03-04 01:07:28 +00:00
2015-04-13 16:06:19 +00:00
$data = apply_filters ( 'woocommerce_api_edit_customer_data' , $data , $this );
2014-08-30 19:50:40 +00:00
2016-11-18 06:16:38 +00:00
$customer = new WC_Customer ( $id );
2015-04-13 16:06:19 +00:00
// Customer email.
if ( isset ( $data [ 'email' ] ) ) {
2016-11-18 06:16:38 +00:00
$customer -> set_email ( $data [ 'email' ] );
2015-04-13 16:06:19 +00:00
}
2014-03-04 01:07:28 +00:00
2015-04-13 16:06:19 +00:00
// Customer password.
if ( isset ( $data [ 'password' ] ) ) {
2016-11-18 06:16:38 +00:00
$customer -> set_password ( $data [ 'password' ] );
2015-04-13 16:06:19 +00:00
}
2014-03-04 01:07:28 +00:00
2015-04-13 16:06:19 +00:00
// Update customer data.
2016-11-18 06:16:38 +00:00
$this -> update_customer_data ( $customer -> get_id (), $data , $customer );
2013-11-04 06:36:31 +00:00
2016-11-18 06:16:38 +00:00
$customer -> save ();
2014-03-04 01:09:50 +00:00
2016-11-18 06:16:38 +00:00
do_action ( 'woocommerce_api_edit_customer' , $customer -> get_id (), $data );
return $this -> get_customer ( $customer -> get_id () );
} catch ( Exception $e ) {
2015-04-13 16:06:19 +00:00
return new WP_Error ( $e -> getErrorCode (), $e -> getMessage (), array ( 'status' => $e -> getCode () ) );
}
2013-11-04 06:36:31 +00:00
}
/**
* Delete a customer
*
2014-03-04 01:16:54 +00:00
* @ since 2.2
2013-11-04 06:36:31 +00:00
* @ param int $id the customer ID
2017-05-15 11:50:52 +00:00
* @ return array | WP_Error
2013-11-04 06:36:31 +00:00
*/
2013-11-11 00:29:36 +00:00
public function delete_customer ( $id ) {
2014-03-04 01:16:54 +00:00
// Validate the customer ID.
2013-11-11 00:29:36 +00:00
$id = $this -> validate_request ( $id , 'customer' , 'delete' );
2014-03-04 01:16:54 +00:00
// Return the validate error.
if ( is_wp_error ( $id ) ) {
2014-03-05 02:42:36 +00:00
return $id ;
2014-03-04 01:16:54 +00:00
}
2013-11-04 06:36:31 +00:00
2014-08-30 19:50:40 +00:00
do_action ( 'woocommerce_api_delete_customer' , $id , $this );
2013-11-11 00:29:36 +00:00
return $this -> delete ( $id , 'customer' );
2013-11-04 06:36:31 +00:00
}
/**
* Get the orders for a customer
*
2014-03-05 17:24:47 +00:00
* @ since 2.1
2013-11-04 06:36:31 +00:00
* @ param int $id the customer ID
2013-11-11 00:29:36 +00:00
* @ param string $fields fields to include in response
2015-09-21 22:11:54 +00:00
* @ param array $filter filters
2017-05-15 11:50:52 +00:00
* @ return array | WP_Error
2013-11-04 06:36:31 +00:00
*/
2015-09-21 22:11:54 +00:00
public function get_customer_orders ( $id , $fields = null , $filter = array () ) {
2013-11-11 00:29:36 +00:00
$id = $this -> validate_request ( $id , 'customer' , 'read' );
2013-11-04 06:36:31 +00:00
2014-03-05 01:48:54 +00:00
if ( is_wp_error ( $id ) ) {
2013-11-11 00:29:36 +00:00
return $id ;
2014-03-05 01:48:54 +00:00
}
2013-11-04 06:36:31 +00:00
2015-09-21 22:11:54 +00:00
$filter [ 'customer_id' ] = $id ;
$orders = WC () -> api -> WC_API_Orders -> get_orders ( $fields , $filter , null , - 1 );
2013-11-04 06:36:31 +00:00
2015-09-21 22:11:54 +00:00
return $orders ;
2013-11-04 06:36:31 +00:00
}
2014-05-28 17:06:46 +00:00
/**
* Get the available downloads for a customer
*
* @ since 2.2
* @ param int $id the customer ID
* @ param string $fields fields to include in response
2017-05-15 11:50:52 +00:00
* @ return array | WP_Error
2014-05-28 17:06:46 +00:00
*/
public function get_customer_downloads ( $id , $fields = null ) {
$id = $this -> validate_request ( $id , 'customer' , 'read' );
if ( is_wp_error ( $id ) ) {
return $id ;
}
2015-01-21 12:38:33 +00:00
$downloads = array ();
$_downloads = wc_get_customer_available_downloads ( $id );
2014-05-28 17:06:46 +00:00
2015-01-21 12:38:33 +00:00
foreach ( $_downloads as $key => $download ) {
2017-03-14 18:40:36 +00:00
$downloads [] = array (
'download_url' => $download [ 'download_url' ],
'download_id' => $download [ 'download_id' ],
'product_id' => $download [ 'product_id' ],
'download_name' => $download [ 'download_name' ],
'order_id' => $download [ 'order_id' ],
'order_key' => $download [ 'order_key' ],
'downloads_remaining' => $download [ 'downloads_remaining' ],
'access_expires' => $download [ 'access_expires' ] ? $this -> server -> format_datetime ( $download [ 'access_expires' ] ) : null ,
'file' => $download [ 'file' ],
);
2014-05-28 17:06:46 +00:00
}
return array ( 'downloads' => apply_filters ( 'woocommerce_api_customer_downloads_response' , $downloads , $id , $fields , $this -> server ) );
}
2013-11-04 06:36:31 +00:00
/**
* Helper method to get customer user objects
*
2013-11-19 02:06:45 +00:00
* Note that WP_User_Query does not have built - in pagination so limit & offset are used to provide limited
* pagination support
2015-04-13 16:06:19 +00:00
*
2015-02-07 06:08:48 +00:00
* The filter for role can only be a single role in a string .
2013-11-19 02:06:45 +00:00
*
2015-02-04 11:59:25 +00:00
* @ since 2.3
2013-11-04 06:36:31 +00:00
* @ param array $args request arguments for filtering query
2014-02-07 17:39:40 +00:00
* @ return WP_User_Query
2013-11-04 06:36:31 +00:00
*/
2013-11-11 00:29:36 +00:00
private function query_customers ( $args = array () ) {
2013-11-04 06:36:31 +00:00
2013-11-19 02:06:45 +00:00
// default users per page
$users_per_page = get_option ( 'posts_per_page' );
2015-01-05 18:06:52 +00:00
// Set base query arguments
2013-11-04 06:36:31 +00:00
$query_args = array (
'fields' => 'ID' ,
'role' => 'customer' ,
'orderby' => 'registered' ,
2013-11-19 02:06:45 +00:00
'number' => $users_per_page ,
2013-11-04 06:36:31 +00:00
);
2015-02-04 12:31:14 +00:00
// Custom Role
2015-02-04 11:59:25 +00:00
if ( ! empty ( $args [ 'role' ] ) ) {
2015-02-04 12:31:14 +00:00
$query_args [ 'role' ] = $args [ 'role' ];
2015-09-30 16:10:43 +00:00
2015-09-30 16:12:12 +00:00
// Show users on all roles
2015-09-30 16:10:43 +00:00
if ( 'all' === $query_args [ 'role' ] ) {
unset ( $query_args [ 'role' ] );
}
2015-02-04 11:59:25 +00:00
}
2015-01-05 18:06:52 +00:00
// Search
2013-11-19 02:06:45 +00:00
if ( ! empty ( $args [ 'q' ] ) ) {
2013-11-04 06:36:31 +00:00
$query_args [ 'search' ] = $args [ 'q' ];
2013-11-19 02:06:45 +00:00
}
2013-11-04 06:36:31 +00:00
2015-01-05 18:06:52 +00:00
// Limit number of users returned
2013-11-19 02:06:45 +00:00
if ( ! empty ( $args [ 'limit' ] ) ) {
2016-09-09 00:14:28 +00:00
if ( - 1 == $args [ 'limit' ] ) {
2014-10-14 22:31:56 +00:00
unset ( $query_args [ 'number' ] );
} else {
2014-10-15 17:43:13 +00:00
$query_args [ 'number' ] = absint ( $args [ 'limit' ] );
$users_per_page = absint ( $args [ 'limit' ] );
2014-10-14 22:31:56 +00:00
}
2015-01-05 14:36:50 +00:00
} else {
$args [ 'limit' ] = $query_args [ 'number' ];
2013-11-19 02:06:45 +00:00
}
2013-11-04 06:36:31 +00:00
2015-01-05 18:06:52 +00:00
// Page
2013-11-22 08:41:32 +00:00
$page = ( isset ( $args [ 'page' ] ) ) ? absint ( $args [ 'page' ] ) : 1 ;
2013-11-04 06:36:31 +00:00
2015-01-05 18:06:52 +00:00
// Offset
2013-11-19 02:06:45 +00:00
if ( ! empty ( $args [ 'offset' ] ) ) {
$query_args [ 'offset' ] = absint ( $args [ 'offset' ] );
} else {
$query_args [ 'offset' ] = $users_per_page * ( $page - 1 );
}
2015-01-05 18:06:52 +00:00
// Created date
2013-11-19 02:06:45 +00:00
if ( ! empty ( $args [ 'created_at_min' ] ) ) {
2013-11-18 21:47:38 +00:00
$this -> created_at_min = $this -> server -> parse_datetime ( $args [ 'created_at_min' ] );
2013-11-19 02:06:45 +00:00
}
2013-11-10 23:28:58 +00:00
2013-11-19 02:06:45 +00:00
if ( ! empty ( $args [ 'created_at_max' ] ) ) {
2013-11-18 21:47:38 +00:00
$this -> created_at_max = $this -> server -> parse_datetime ( $args [ 'created_at_max' ] );
2013-11-19 02:06:45 +00:00
}
2015-01-05 18:06:52 +00:00
// Order (ASC or DESC, ASC by default)
2014-07-28 23:38:21 +00:00
if ( ! empty ( $args [ 'order' ] ) ) {
$query_args [ 'order' ] = $args [ 'order' ];
}
2014-07-28 23:40:28 +00:00
2017-07-17 10:10:52 +00:00
// Order by
2014-07-28 23:40:28 +00:00
if ( ! empty ( $args [ 'orderby' ] ) ) {
$query_args [ 'orderby' ] = $args [ 'orderby' ];
2015-01-05 18:06:52 +00:00
// Allow sorting by meta value
2014-07-28 23:49:56 +00:00
if ( ! empty ( $args [ 'orderby_meta_key' ] ) ) {
2014-07-28 23:40:28 +00:00
$query_args [ 'meta_key' ] = $args [ 'orderby_meta_key' ];
}
}
2013-11-19 02:06:45 +00:00
$query = new WP_User_Query ( $query_args );
2013-11-10 23:28:58 +00:00
2015-01-05 18:06:52 +00:00
// Helper members for pagination headers
2016-09-09 00:14:28 +00:00
$query -> total_pages = ( - 1 == $args [ 'limit' ] ) ? 1 : ceil ( $query -> get_total () / $users_per_page );
2013-11-19 02:06:45 +00:00
$query -> page = $page ;
2013-11-04 06:36:31 +00:00
2013-11-19 02:06:45 +00:00
return $query ;
2013-11-04 06:36:31 +00:00
}
/**
* Add customer data to orders
*
* @ since 2.1
* @ param $order_data
* @ param $order
2013-11-11 00:29:36 +00:00
* @ return array
2013-11-04 06:36:31 +00:00
*/
2013-11-11 00:29:36 +00:00
public function add_customer_data ( $order_data , $order ) {
2013-11-04 06:36:31 +00:00
2016-08-05 15:09:40 +00:00
if ( 0 == $order -> get_user_id () ) {
2013-11-04 06:36:31 +00:00
2014-01-23 21:38:08 +00:00
// add customer data from order
$order_data [ 'customer' ] = array (
'id' => 0 ,
2016-08-05 14:57:40 +00:00
'email' => $order -> get_billing_email (),
2016-08-05 14:58:44 +00:00
'first_name' => $order -> get_billing_first_name (),
2016-08-05 14:57:40 +00:00
'last_name' => $order -> get_billing_last_name (),
2014-01-23 21:38:08 +00:00
'billing_address' => array (
2016-08-05 14:58:44 +00:00
'first_name' => $order -> get_billing_first_name (),
2016-08-05 14:57:40 +00:00
'last_name' => $order -> get_billing_last_name (),
2016-08-05 15:03:09 +00:00
'company' => $order -> get_billing_company (),
2016-08-08 15:46:58 +00:00
'address_1' => $order -> get_billing_address_1 (),
'address_2' => $order -> get_billing_address_2 (),
'city' => $order -> get_billing_city (),
'state' => $order -> get_billing_state (),
'postcode' => $order -> get_billing_postcode (),
'country' => $order -> get_billing_country (),
2016-08-05 14:57:40 +00:00
'email' => $order -> get_billing_email (),
2016-08-05 15:09:04 +00:00
'phone' => $order -> get_billing_phone (),
2014-01-23 21:38:08 +00:00
),
'shipping_address' => array (
2016-08-08 15:46:58 +00:00
'first_name' => $order -> get_shipping_first_name (),
'last_name' => $order -> get_shipping_last_name (),
'company' => $order -> get_shipping_company (),
'address_1' => $order -> get_shipping_address_1 (),
'address_2' => $order -> get_shipping_address_2 (),
'city' => $order -> get_shipping_city (),
'state' => $order -> get_shipping_state (),
'postcode' => $order -> get_shipping_postcode (),
'country' => $order -> get_shipping_country (),
2014-01-23 21:38:08 +00:00
),
);
2013-11-04 06:36:31 +00:00
} else {
2016-08-05 15:09:40 +00:00
$order_data [ 'customer' ] = current ( $this -> get_customer ( $order -> get_user_id () ) );
2013-11-04 06:36:31 +00:00
}
return $order_data ;
}
2013-11-10 23:28:58 +00:00
/**
* Modify the WP_User_Query to support filtering on the date the customer was created
*
2014-03-05 17:24:47 +00:00
* @ since 2.1
2013-11-10 23:28:58 +00:00
* @ param WP_User_Query $query
*/
public function modify_user_query ( $query ) {
2014-03-05 01:48:54 +00:00
if ( $this -> created_at_min ) {
2015-01-12 17:01:12 +00:00
$query -> query_where .= sprintf ( " AND user_registered >= STR_TO_DATE( '%s', '%%Y-%%m-%%d %%H:%%i:%%s' ) " , esc_sql ( $this -> created_at_min ) );
2014-03-05 01:48:54 +00:00
}
2013-11-10 23:28:58 +00:00
2014-03-05 01:48:54 +00:00
if ( $this -> created_at_max ) {
2015-01-12 17:01:12 +00:00
$query -> query_where .= sprintf ( " AND user_registered <= STR_TO_DATE( '%s', '%%Y-%%m-%%d %%H:%%i:%%s' ) " , esc_sql ( $this -> created_at_max ) );
2014-03-05 01:48:54 +00:00
}
2013-11-10 23:28:58 +00:00
}
2013-11-11 00:29:36 +00:00
/**
* Validate the request by checking :
*
* 1 ) the ID is a valid integer
* 2 ) the ID returns a valid WP_User
* 3 ) the current user has the proper permissions
*
2014-03-05 17:24:47 +00:00
* @ since 2.1
2013-11-11 00:29:36 +00:00
* @ see WC_API_Resource :: validate_request ()
2014-09-07 23:37:55 +00:00
* @ param integer $id the customer ID
2013-11-11 00:29:36 +00:00
* @ param string $type the request type , unused because this method overrides the parent class
* @ param string $context the context of the request , either `read` , `edit` or `delete`
* @ return int | WP_Error valid user ID or WP_Error if any of the checks fails
*/
protected function validate_request ( $id , $type , $context ) {
2015-01-05 18:06:52 +00:00
try {
$id = absint ( $id );
2014-02-17 14:44:08 +00:00
2015-01-05 18:06:52 +00:00
// validate ID
if ( empty ( $id ) ) {
throw new WC_API_Exception ( 'woocommerce_api_invalid_customer_id' , __ ( 'Invalid customer ID' , 'woocommerce' ), 404 );
}
2013-11-11 00:29:36 +00:00
2015-01-05 18:06:52 +00:00
// non-existent IDs return a valid WP_User object with the user ID = 0
$customer = new WP_User ( $id );
2013-11-11 00:29:36 +00:00
2015-01-05 18:06:52 +00:00
if ( 0 === $customer -> ID ) {
throw new WC_API_Exception ( 'woocommerce_api_invalid_customer' , __ ( 'Invalid customer' , 'woocommerce' ), 404 );
}
2013-11-11 00:29:36 +00:00
2015-01-05 18:06:52 +00:00
// validate permissions
switch ( $context ) {
case 'read' :
if ( ! current_user_can ( 'list_users' ) ) {
throw new WC_API_Exception ( 'woocommerce_api_user_cannot_read_customer' , __ ( 'You do not have permission to read this customer' , 'woocommerce' ), 401 );
}
break ;
case 'edit' :
if ( ! current_user_can ( 'edit_users' ) ) {
throw new WC_API_Exception ( 'woocommerce_api_user_cannot_edit_customer' , __ ( 'You do not have permission to edit this customer' , 'woocommerce' ), 401 );
}
break ;
case 'delete' :
if ( ! current_user_can ( 'delete_users' ) ) {
throw new WC_API_Exception ( 'woocommerce_api_user_cannot_delete_customer' , __ ( 'You do not have permission to delete this customer' , 'woocommerce' ), 401 );
}
break ;
}
2013-11-11 00:29:36 +00:00
2015-01-05 18:06:52 +00:00
return $id ;
} catch ( WC_API_Exception $e ) {
return new WP_Error ( $e -> getErrorCode (), $e -> getMessage (), array ( 'status' => $e -> getCode () ) );
2013-11-11 00:29:36 +00:00
}
}
/**
* Check if the current user can read users
*
* @ since 2.1
* @ see WC_API_Resource :: is_readable ()
* @ param int | WP_Post $post unused
* @ return bool true if the current user can read users , false otherwise
*/
protected function is_readable ( $post ) {
return current_user_can ( 'list_users' );
}
2015-05-07 16:09:59 +00:00
/**
* Bulk update or insert customers
* Accepts an array with customers in the formats supported by
* WC_API_Customers -> create_customer () and WC_API_Customers -> edit_customer ()
*
* @ since 2.4 . 0
2017-05-15 11:50:52 +00:00
*
2015-05-07 16:09:59 +00:00
* @ param array $data
2017-05-15 11:50:52 +00:00
*
* @ return array | WP_Error
2015-05-07 16:09:59 +00:00
*/
public function bulk ( $data ) {
try {
if ( ! isset ( $data [ 'customers' ] ) ) {
throw new WC_API_Exception ( 'woocommerce_api_missing_customers_data' , sprintf ( __ ( 'No %1$s data specified to create/edit %1$s' , 'woocommerce' ), 'customers' ), 400 );
}
$data = $data [ 'customers' ];
$limit = apply_filters ( 'woocommerce_api_bulk_limit' , 100 , 'customers' );
// Limit bulk operation
if ( count ( $data ) > $limit ) {
2016-10-11 01:39:13 +00:00
throw new WC_API_Exception ( 'woocommerce_api_customers_request_entity_too_large' , sprintf ( __ ( 'Unable to accept more than %s items for this request.' , 'woocommerce' ), $limit ), 413 );
2015-05-07 16:09:59 +00:00
}
$customers = array ();
foreach ( $data as $_customer ) {
$customer_id = 0 ;
// Try to get the customer ID
if ( isset ( $_customer [ 'id' ] ) ) {
$customer_id = intval ( $_customer [ 'id' ] );
}
if ( $customer_id ) {
2016-09-02 03:15:49 +00:00
// Customer exists / edit customer
2015-05-07 16:09:59 +00:00
$edit = $this -> edit_customer ( $customer_id , array ( 'customer' => $_customer ) );
if ( is_wp_error ( $edit ) ) {
$customers [] = array (
'id' => $customer_id ,
2016-08-27 01:46:45 +00:00
'error' => array ( 'code' => $edit -> get_error_code (), 'message' => $edit -> get_error_message () ),
2015-05-07 16:09:59 +00:00
);
} else {
$customers [] = $edit [ 'customer' ];
}
2016-09-02 03:15:49 +00:00
} else {
2015-05-07 16:09:59 +00:00
2016-09-02 03:15:49 +00:00
// Customer don't exists / create customer
2015-05-07 16:09:59 +00:00
$new = $this -> create_customer ( array ( 'customer' => $_customer ) );
if ( is_wp_error ( $new ) ) {
$customers [] = array (
'id' => $customer_id ,
2016-08-27 01:46:45 +00:00
'error' => array ( 'code' => $new -> get_error_code (), 'message' => $new -> get_error_message () ),
2015-05-07 16:09:59 +00:00
);
} else {
$customers [] = $new [ 'customer' ];
}
}
}
return array ( 'customers' => apply_filters ( 'woocommerce_api_customers_bulk_response' , $customers , $this ) );
} catch ( WC_API_Exception $e ) {
return new WP_Error ( $e -> getErrorCode (), $e -> getMessage (), array ( 'status' => $e -> getCode () ) );
}
}
2013-11-04 06:36:31 +00:00
}