WooCommerce Code Reference

WC_REST_Network_Orders_V2_Controller extends WC_REST_Orders_V2_Controller

REST API Network Orders controller class.

Tags
extends

WC_REST_Orders_V2_Controller

Table of Contents

$hierarchical  : bool
If object is hierarchical.
$namespace  : string
Endpoint namespace.
$post_type  : string
Post type.
$public  : string
Controls visibility on frontend.
$request  : array
Stores the request.
$rest_base  : string
Route base.
batch_items()  : array
Bulk create, update and delete items.
batch_items_permissions_check()  : bool|WP_Error
Check if a given request has access batch create, update and delete items.
create_item()  : WP_Error|WP_REST_Response
Create a single item.
create_item_permissions_check()  : WP_Error|bool
Check if a given request has access to create an item.
delete_item()  : WP_REST_Response|WP_Error
Delete a single item.
delete_item_permissions_check()  : bool|WP_Error
Check if a given request has access to delete an item.
get_collection_params()  : array
Get the query params for collections of attachments.
get_endpoint_args_for_item_schema()  : array
Compatibility functions for WP 5.5, since custom types are not supported anymore.
get_fields_for_response()  : array
Gets an array of fields to be included on the response.
get_item()  : WP_Error|WP_REST_Response
Get a single item.
get_item_permissions_check()  : WP_Error|bool
Check if a given request has access to read an item.
get_item_schema()  : array
Get the Order's schema, conforming to JSON Schema.
get_items()  : WP_Error|WP_REST_Response
Get a collection of posts.
get_items_permissions_check()  : WP_Error|bool
Check if a given request has access to read items.
get_public_batch_schema()  : array
Get the batch schema, conforming to JSON Schema.
get_public_item_schema()  : array
Retrieves the item's schema for display / public consumption purposes.
network_orders()  : WP_REST_Response
Get a collection of orders from the requested blog id
network_orders_filter_args()  : array
Filters the post statuses to on hold and processing for the network order query.
network_orders_permissions_check()  : bool
Does a permissions check for the proper requested blog
register_routes()  : mixed
Register the routes for network orders.
update_item()  : WP_Error|WP_REST_Response
Update a single post.
update_item_permissions_check()  : WP_Error|bool
Check if a given request has access to update an item.
validate_setting_checkbox_field()  : string|WP_Error
Validate checkbox based settings.
validate_setting_image_width_field()  : string|WP_Error
Validate image_width based settings.
validate_setting_multiselect_field()  : array|WP_Error
Validate multiselect based settings.
validate_setting_radio_field()  : string|WP_Error
Validate radio based settings.
validate_setting_select_field()  : string|WP_Error
Validate select based settings.
validate_setting_text_field()  : string
Validate a text value for a text based setting.
validate_setting_textarea_field()  : string
Validate textarea based settings.
add_additional_fields_schema()  : array
Add the schema from additional fields to an schema array.
add_meta_query()  : array
Add meta query.
add_post_meta_fields()  : bool|WP_Error
Add post meta fields.
adjust_wp_5_5_datatype_compatibility()  : mixed
Change datatypes `date-time` to string, and `mixed` to composite of all built in types. This is required for maintaining forward compatibility with WP 5.5 since custom post types are not supported anymore.
check_batch_limit()  : bool|WP_Error
Check batch limit.
delete_post()  : mixed
Delete post.
filter_writable_props()  : bool
Only return writable props from schema.
get_allowed_query_vars()  : array
Get all the WP Query vars that are allowed for the API request.
get_formatted_item_data()  : array
Get formatted item data.
get_normalized_rest_base()  : string
Get normalized rest base.
get_object()  : object
Get object.
get_objects()  : array
Get objects.
get_order_item_data()  : array
Expands an order item to get its data.
get_order_statuses()  : array
Get order statuses without prefixes.
get_permalink()  : string
Get object permalink.
get_product_id()  : int
Gets the product ID from the SKU or posted ID.
item_is_null()  : bool
Helper method to check if the resource ID associated with the provided item is null.
maybe_set_item_meta_data()  : mixed
Maybe set item meta if posted.
maybe_set_item_prop()  : mixed
Maybe set an item prop if the value was posted.
maybe_set_item_props()  : mixed
Maybe set item props if the values were posted.
prepare_coupon_lines()  : WC_Order_Item_Coupon
Create or update an order coupon.
prepare_fee_lines()  : WC_Order_Item_Fee
Create or update an order fee.
prepare_items_query()  : array
Determine the allowed query_vars for a get_items() response and prepare for WP_Query.
prepare_line_items()  : WC_Order_Item_Product
Create or update a line item.
prepare_links()  : array
Prepare links for the request.
prepare_object_for_database()  : WP_Error|WC_Data
Prepares one object for create or update operation.
prepare_object_for_response()  : WP_Error|WP_REST_Response
Prepares the object for the REST response.
prepare_objects_query()  : array
Prepare objects query.
prepare_shipping_lines()  : WC_Order_Item_Shipping
Create or update an order shipping method.
save_object()  : WC_Data|WP_Error
Save an object data.
set_item()  : mixed
Wrapper method to create/update order items.
update_address()  : mixed
Update address.
update_post_meta_fields()  : bool|WP_Error
Update post meta fields.

Properties

Methods

batch_items_permissions_check()

Check if a given request has access batch create, update and delete items.

public batch_items_permissions_check(WP_REST_Request $request) : bool|WP_Error
Parameters
$request : WP_REST_Request

Full details about the request.

Return values
bool|WP_Error

get_fields_for_response()

Gets an array of fields to be included on the response.

public get_fields_for_response(WP_REST_Request $request) : array

Included fields are based on item schema and _fields= request argument. Updated from WordPress 5.3, included into this class to support old versions.

Parameters
$request : WP_REST_Request

Full details about the request.

Tags
since
3.5.0
Return values
arrayFields to be included in the response.

validate_setting_checkbox_field()

Validate checkbox based settings.

public validate_setting_checkbox_field(string $value, array $setting) : string|WP_Error
Parameters
$value : string

Value.

$setting : array

Setting.

Tags
since
3.0.0
Return values
string|WP_Error

validate_setting_image_width_field()

Validate image_width based settings.

public validate_setting_image_width_field(array $values, array $setting) : string|WP_Error
Parameters
$values : array

Values.

$setting : array

Setting.

Tags
since
3.0.0
Return values
string|WP_Error

validate_setting_multiselect_field()

Validate multiselect based settings.

public validate_setting_multiselect_field(array $values, array $setting) : array|WP_Error
Parameters
$values : array

Values.

$setting : array

Setting.

Tags
since
3.0.0
Return values
array|WP_Error

add_additional_fields_schema()

Add the schema from additional fields to an schema array.

protected add_additional_fields_schema(array $schema) : array

The type of object is inferred from the passed schema.

Parameters
$schema : array

Schema array.

Return values
array

adjust_wp_5_5_datatype_compatibility()

Change datatypes `date-time` to string, and `mixed` to composite of all built in types. This is required for maintaining forward compatibility with WP 5.5 since custom post types are not supported anymore.

protected adjust_wp_5_5_datatype_compatibility(array $endpoint_args) : mixed

See @link https://core.trac.wordpress.org/changeset/48306

We still use the 'mixed' type, since if we convert to composite type everywhere, it won't work in 5.4 anymore because they require to define the full schema.

Parameters
$endpoint_args : array

Schema with datatypes to convert.

Return values
mixedSchema with converted datatype.

item_is_null()

Helper method to check if the resource ID associated with the provided item is null.

protected item_is_null(array $item) : bool

Items can be deleted by setting the resource ID to null.

Parameters
$item : array

Item provided in the request body.

Return values
boolTrue if the item resource ID is null, false otherwise.

prepare_coupon_lines()

Create or update an order coupon.

protected prepare_coupon_lines(array $posted[, string $action = 'create' ][, object $item = null ]) : WC_Order_Item_Coupon
Parameters
$posted : array

Item data.

$action : string = 'create'

'create' to add coupon or 'update' to update it.

$item : object = null

Passed when updating an item. Null during creation.

Tags
throws
WC_REST_Exception

Invalid data, server error.

Return values
WC_Order_Item_Coupon

prepare_fee_lines()

Create or update an order fee.

protected prepare_fee_lines(array $posted[, string $action = 'create' ][, object $item = null ]) : WC_Order_Item_Fee
Parameters
$posted : array

Item data.

$action : string = 'create'

'create' to add fee or 'update' to update it.

$item : object = null

Passed when updating an item. Null during creation.

Tags
throws
WC_REST_Exception

Invalid data, server error.

Return values
WC_Order_Item_Fee

prepare_items_query()

Determine the allowed query_vars for a get_items() response and prepare for WP_Query.

protected prepare_items_query([array $prepared_args = array() ][, WP_REST_Request $request = null ]) : array
Parameters
$prepared_args : array = array()

Prepared arguments.

$request : WP_REST_Request = null

Request object.

Return values
array$query_args

prepare_line_items()

Create or update a line item.

protected prepare_line_items(array $posted[, string $action = 'create' ][, object $item = null ]) : WC_Order_Item_Product
Parameters
$posted : array

Line item data.

$action : string = 'create'

'create' to add line item or 'update' to update it.

$item : object = null

Passed when updating an item. Null during creation.

Tags
throws
WC_REST_Exception

Invalid data, server error.

Return values
WC_Order_Item_Product

prepare_object_for_database()

Prepares one object for create or update operation.

protected prepare_object_for_database(WP_REST_Request $request[, bool $creating = false ]) : WP_Error|WC_Data
Parameters
$request : WP_REST_Request

Request object.

$creating : bool = false

If is creating a new object.

Tags
since
3.0.0
Return values
WP_Error|WC_DataThe prepared item, or WP_Error object on failure.

prepare_object_for_response()

Prepares the object for the REST response.

protected prepare_object_for_response(WC_Data $object, WP_REST_Request $request) : WP_Error|WP_REST_Response
Parameters
$object : WC_Data

Object data.

$request : WP_REST_Request

Request object.

Tags
since
3.0.0
Return values
WP_Error|WP_REST_ResponseResponse object on success, or WP_Error object on failure.

prepare_shipping_lines()

Create or update an order shipping method.

protected prepare_shipping_lines(array $posted[, string $action = 'create' ][, object $item = null ]) : WC_Order_Item_Shipping
Parameters
$posted : array

$shipping Item data.

$action : string = 'create'

'create' to add shipping or 'update' to update it.

$item : object = null

Passed when updating an item. Null during creation.

Tags
throws
WC_REST_Exception

Invalid data, server error.

Return values
WC_Order_Item_Shipping

set_item()

Wrapper method to create/update order items.

protected set_item(WC_Order $order, string $item_type, array $posted) : mixed

When updating, the item ID provided is checked to ensure it is associated with the order.

Parameters
$order : WC_Order

order object.

$item_type : string

The item type.

$posted : array

item provided in the request body.

Tags
throws
WC_REST_Exception

If item ID is not associated with order.

Return values
mixed