• Home
  • WC_REST_Customers_Controller

PHP Class WC_REST_Customers_Controller

Inheritance: extends WP_REST_Controller
Show file Open project: woocommerce/woocommerce

Protected Properties

Property Type Description
$namespace string Endpoint namespace.
$rest_base string Route base.

Public Methods

Method Description
batch_items_permissions_check ( WP_REST_Request $request ) : boolean Check if a given request has access batch create, update and delete items.
create_item ( WP_REST_Request $request ) : WP_Error | WP_REST_Response Create a single customer.
create_item_permissions_check ( WP_REST_Request $request ) : boolean Check if a given request has access create customers.
delete_item ( WP_REST_Request $request ) : WP_Error | WP_REST_Response Delete a single customer.
delete_item_permissions_check ( WP_REST_Request $request ) : boolean Check if a given request has access delete a customer.
get_collection_params ( ) : array Get the query params for collections.
get_item ( WP_REST_Request $request ) : WP_Error | WP_REST_Response Get a single customer.
get_item_permissions_check ( WP_REST_Request $request ) : WP_Error | boolean Check if a given request has access to read a customer.
get_item_schema ( ) : array Get the Customer's schema, conforming to JSON Schema.
get_items ( WP_REST_Request $request ) : WP_Error | WP_REST_Response Get all customers.
get_items_permissions_check ( WP_REST_Request $request ) : WP_Error | boolean Check whether a given request has permission to read customers.
prepare_item_for_response ( WP_User $user_data, WP_REST_Request $request ) : WP_REST_Response Prepare a single customer output for response.
register_routes ( ) Register the routes for customers.
update_item ( WP_REST_Request $request ) : WP_Error | WP_REST_Response Update a single user.
update_item_permissions_check ( WP_REST_Request $request ) : boolean Check if a given request has access update a customer.

Protected Methods

Method Description
get_role_names ( ) : array Get role names.
prepare_links ( WP_User $customer ) : array Prepare links for the request.
update_customer_meta_fields ( WC_Customer $customer, WP_REST_Request $request ) Update customer meta fields.

Method Details

batch_items_permissions_check() public method

Check if a given request has access batch create, update and delete items.
public batch_items_permissions_check ( WP_REST_Request $request ) : boolean
$request WP_REST_Request Full details about the request.
return boolean

create_item() public method

Create a single customer.
public create_item ( WP_REST_Request $request ) : WP_Error | WP_REST_Response
$request WP_REST_Request Full details about the request.
return WP_Error | WP_REST_Response

create_item_permissions_check() public method

Check if a given request has access create customers.
public create_item_permissions_check ( WP_REST_Request $request ) : boolean
$request WP_REST_Request Full details about the request.
return boolean

delete_item() public method

Delete a single customer.
public delete_item ( WP_REST_Request $request ) : WP_Error | WP_REST_Response
$request WP_REST_Request Full details about the request.
return WP_Error | WP_REST_Response

delete_item_permissions_check() public method

Check if a given request has access delete a customer.
public delete_item_permissions_check ( WP_REST_Request $request ) : boolean
$request WP_REST_Request Full details about the request.
return boolean

get_collection_params() public method

Get the query params for collections.
public get_collection_params ( ) : array
return array

get_item() public method

Get a single customer.
public get_item ( WP_REST_Request $request ) : WP_Error | WP_REST_Response
$request WP_REST_Request Full details about the request.
return WP_Error | WP_REST_Response

get_item_permissions_check() public method

Check if a given request has access to read a customer.
public get_item_permissions_check ( WP_REST_Request $request ) : WP_Error | boolean
$request WP_REST_Request Full details about the request.
return WP_Error | boolean

get_item_schema() public method

Get the Customer's schema, conforming to JSON Schema.
public get_item_schema ( ) : array
return array

get_items() public method

Get all customers.
public get_items ( WP_REST_Request $request ) : WP_Error | WP_REST_Response
$request WP_REST_Request Full details about the request.
return WP_Error | WP_REST_Response

get_items_permissions_check() public method

Check whether a given request has permission to read customers.
public get_items_permissions_check ( WP_REST_Request $request ) : WP_Error | boolean
$request WP_REST_Request Full details about the request.
return WP_Error | boolean

get_role_names() protected method

Get role names.
protected get_role_names ( ) : array
return array

prepare_item_for_response() public method

Prepare a single customer output for response.
public prepare_item_for_response ( WP_User $user_data, WP_REST_Request $request ) : WP_REST_Response
$user_data WP_User User object.
$request WP_REST_Request Request object.
return WP_REST_Response $response Response data.

register_routes() public method

Register the routes for customers.
public register_routes ( )

update_customer_meta_fields() protected method

Update customer meta fields.
protected update_customer_meta_fields ( WC_Customer $customer, WP_REST_Request $request )
$customer WC_Customer
$request WP_REST_Request

update_item() public method

Update a single user.
public update_item ( WP_REST_Request $request ) : WP_Error | WP_REST_Response
$request WP_REST_Request Full details about the request.
return WP_Error | WP_REST_Response

update_item_permissions_check() public method

Check if a given request has access update a customer.
public update_item_permissions_check ( WP_REST_Request $request ) : boolean
$request WP_REST_Request Full details about the request.
return boolean

Property Details

$namespace protected property

Endpoint namespace.
protected string $namespace
return string

$rest_base protected property

Route base.
protected string $rest_base
return string