• Home
  • WC_REST_Order_Refunds_Controller

PHP Class WC_REST_Order_Refunds_Controller

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

Protected Properties

Property Type Description
$namespace string Endpoint namespace.
$post_type string Post type.
$request array Stores the request.
$rest_base string Route base.

Public Methods

Method Description
__construct ( ) Order refunds actions.
create_item ( WP_REST_Request $request ) : WP_Error | WP_REST_Response Create a single item.
get_collection_params ( ) : array Get the query params for collections.
get_item_schema ( ) : array Get the Order's schema, conforming to JSON Schema.
prepare_item_for_response ( WP_Post $post, WP_REST_Request $request ) : WP_REST_Response Prepare a single order refund output for response.
query_args ( array $args, WP_REST_Request $request ) : array Query args.
register_routes ( ) Register the routes for order refunds.

Protected Methods

Method Description
prepare_links ( WC_Order_Refund $refund, WP_REST_Request $request ) : array Prepare links for the request.

Method Details

__construct() public method

Order refunds actions.
public __construct ( )

create_item() public method

Create a single item.
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

get_collection_params() public method

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

get_item_schema() public method

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

prepare_item_for_response() public method

Prepare a single order refund output for response.
public prepare_item_for_response ( WP_Post $post, WP_REST_Request $request ) : WP_REST_Response
$post WP_Post Post object.
$request WP_REST_Request Request object.
return WP_REST_Response $data

query_args() public method

Query args.
public query_args ( array $args, WP_REST_Request $request ) : array
$args array
$request WP_REST_Request
return array

register_routes() public method

Register the routes for order refunds.
public register_routes ( )

Property Details

$namespace protected property

Endpoint namespace.
protected string $namespace
return string

$post_type protected property

Post type.
protected string $post_type
return string

$request protected property

Stores the request.
protected array $request
return array

$rest_base protected property

Route base.
protected string $rest_base
return string