PHP Class WC_REST_Shipping_Zones_Controller

Inheritance: extends WC_REST_Shipping_Zones_Controller_Base

Show file Open project: woocommerce/woocommerce

Public Methods

Method	Description
create_item ( WP_REST_Request $request ) : WP_REST_Request \| WP_Error	Create a single Shipping Zone.
delete_item ( WP_REST_Request $request ) : WP_REST_Request \| WP_Error	Delete a single Shipping Zone.
get_item ( WP_REST_Request $request ) : WP_REST_Response	Get a single Shipping Zone.
get_item_schema ( ) : array	Get the Shipping Zones schema, conforming to JSON Schema
get_items ( WP_REST_Request $request ) : WP_REST_Response	Get all Shipping Zones.
prepare_item_for_response ( array $item, WP_REST_Request $request ) : WP_REST_Response	Prepare the Shipping Zone for the REST response.
register_routes ( )	Register the routes for Shipping Zones.
update_item ( WP_REST_Request $request ) : WP_REST_Request \| WP_Error	Update a single Shipping Zone.

Method	Description
prepare_links ( integer $zone_id ) : array	Prepare links for the request.

Create a single Shipping Zone.

public create_item ( WP_REST_Request $request ) : WP_REST_Request \| WP_Error
$request	WP_REST_Request	Full details about the request.
return	WP_REST_Request \| WP_Error

Delete a single Shipping Zone.

public delete_item ( WP_REST_Request $request ) : WP_REST_Request \| WP_Error
$request	WP_REST_Request	Full details about the request.
return	WP_REST_Request \| WP_Error

Get a single Shipping Zone.

public get_item ( WP_REST_Request $request ) : WP_REST_Response
$request	WP_REST_Request
return	WP_REST_Response

Get the Shipping Zones schema, conforming to JSON Schema

public get_item_schema ( ) : array
return	array

Get all Shipping Zones.

public get_items ( WP_REST_Request $request ) : WP_REST_Response
$request	WP_REST_Request
return	WP_REST_Response

Prepare the Shipping Zone for the REST response.

public prepare_item_for_response ( array $item, WP_REST_Request $request ) : WP_REST_Response
$item	array	Shipping Zone.
$request	WP_REST_Request	Request object.
return	WP_REST_Response	$response

Prepare links for the request.

protected prepare_links ( integer $zone_id ) : array
$zone_id	integer	Given Shipping Zone ID.
return	array	Links for the given Shipping Zone.

public register_routes ( )

Update a single Shipping Zone.

public update_item ( WP_REST_Request $request ) : WP_REST_Request \| WP_Error
$request	WP_REST_Request	Full details about the request.
return	WP_REST_Request \| WP_Error