• Home
  • WC_REST_Product_Attributes_Controller

PHP Class WC_REST_Product_Attributes_Controller

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

Protected Properties

Property Type Description
$attribute string Attribute name.
$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_REST_Request | WP_Error Create a single attribute.
create_item_permissions_check ( WP_REST_Request $request ) : WP_Error | boolean Check if a given request has access to create a attribute.
delete_item ( WP_REST_Request $request ) : WP_REST_Response | WP_Error Delete a single attribute.
delete_item_permissions_check ( WP_REST_Request $request ) : WP_Error | boolean Check if a given request has access to delete a attribute.
get_collection_params ( ) : array Get the query params for collections
get_item ( WP_REST_Request $request ) : WP_REST_Request | WP_Error Get a single attribute.
get_item_permissions_check ( WP_REST_Request $request ) : WP_Error | boolean Check if a given request has access to read a attribute.
get_item_schema ( ) : array Get the Attribute's schema, conforming to JSON Schema.
get_items ( WP_REST_Request $request ) : array Get all attributes.
get_items_permissions_check ( WP_REST_Request $request ) : WP_Error | boolean Check if a given request has access to read the attributes.
prepare_item_for_response ( obj $item, WP_REST_Request $request ) : WP_REST_Response Prepare a single product attribute output for response.
register_routes ( ) Register the routes for product attributes.
update_item ( WP_REST_Request $request ) : WP_REST_Request | WP_Error Update a single term from a taxonomy.
update_item_permissions_check ( WP_REST_Request $request ) : WP_Error | boolean Check if a given request has access to update a attribute.

Protected Methods

Method Description
get_attribute ( integer $id ) : stdClass | WP_Error Get attribute data.
get_taxonomy ( WP_REST_Request $request ) : string Get attribute name.
prepare_links ( object $attribute ) : array Prepare links for the request.
validate_attribute_slug ( string $slug, boolean $new_data = true ) : boolean | WP_Error Validate attribute slug.

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 attribute.
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

create_item_permissions_check() public method

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

delete_item() public method

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

delete_item_permissions_check() public method

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

get_attribute() protected method

Get attribute data.
protected get_attribute ( integer $id ) : stdClass | WP_Error
$id integer Attribute ID.
return stdClass | WP_Error

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 attribute.
public get_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_item_permissions_check() public method

Check if a given request has access to read a attribute.
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 Attribute's schema, conforming to JSON Schema.
public get_item_schema ( ) : array
return array

get_items() public method

Get all attributes.
public get_items ( WP_REST_Request $request ) : array
$request WP_REST_Request
return array

get_items_permissions_check() public method

Check if a given request has access to read the attributes.
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_taxonomy() protected method

Get attribute name.
protected get_taxonomy ( WP_REST_Request $request ) : string
$request WP_REST_Request Full details about the request.
return string

prepare_item_for_response() public method

Prepare a single product attribute output for response.
public prepare_item_for_response ( obj $item, WP_REST_Request $request ) : WP_REST_Response
$item obj Term object.
$request WP_REST_Request
return WP_REST_Response $response

register_routes() public method

Register the routes for product attributes.
public register_routes ( )

update_item() public method

Update a single term from a taxonomy.
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

update_item_permissions_check() public method

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

validate_attribute_slug() protected method

Validate attribute slug.
protected validate_attribute_slug ( string $slug, boolean $new_data = true ) : boolean | WP_Error
$slug string
$new_data boolean
return boolean | WP_Error

Property Details

$attribute protected property

Attribute name.
protected string $attribute
return string

$namespace protected property

Endpoint namespace.
protected string $namespace
return string

$rest_base protected property

Route base.
protected string $rest_base
return string