WC_REST_Product_Reviews_V1_Controller::register_routes() │ public │ WC 1.0

Register the routes for product reviews.

Method of the class: WC_REST_Product_Reviews_V1_Controller{}

No Hooks.

Return

null. Nothing (null).

Usage

$WC_REST_Product_Reviews_V1_Controller = new WC_REST_Product_Reviews_V1_Controller();
$WC_REST_Product_Reviews_V1_Controller->register_routes();

WC_REST_Product_Reviews_V1_Controller::register_routes() WC REST Product Reviews V1 Controller::register routes code ^{WC 9.8.1}

public function register_routes() {
	register_rest_route( $this->namespace, '/' . $this->rest_base, array(
		'args' => array(
			'product_id' => array(
				'description' => __( 'Unique identifier for the variable product.', 'woocommerce' ),
				'type'        => 'integer',
			),
			'id' => array(
				'description' => __( 'Unique identifier for the variation.', 'woocommerce' ),
				'type'        => 'integer',
			),
		),
		array(
			'methods'             => WP_REST_Server::READABLE,
			'callback'            => array( $this, 'get_items' ),
			'permission_callback' => array( $this, 'get_items_permissions_check' ),
			'args'                => $this->get_collection_params(),
		),
		array(
			'methods'             => WP_REST_Server::CREATABLE,
			'callback'            => array( $this, 'create_item' ),
			'permission_callback' => array( $this, 'create_item_permissions_check' ),
			'args'                => array_merge( $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ), array(
				'review' => array(
					'required'    => true,
					'type'        => 'string',
					'description' => __( 'Review content.', 'woocommerce' ),
				),
				'name' => array(
					'required'    => true,
					'type'        => 'string',
					'description' => __( 'Name of the reviewer.', 'woocommerce' ),
				),
				'email' => array(
					'required'    => true,
					'type'        => 'string',
					'description' => __( 'Email of the reviewer.', 'woocommerce' ),
				),
			) ),
		),
		'schema' => array( $this, 'get_public_item_schema' ),
	) );

	register_rest_route( $this->namespace, '/' . $this->rest_base . '/(?P<id>[\d]+)', array(
		'args' => array(
			'product_id' => array(
				'description' => __( 'Unique identifier for the variable product.', 'woocommerce' ),
				'type'        => 'integer',
			),
			'id' => array(
				'description' => __( 'Unique identifier for the resource.', 'woocommerce' ),
				'type'        => 'integer',
			),
		),
		array(
			'methods'             => WP_REST_Server::READABLE,
			'callback'            => array( $this, 'get_item' ),
			'permission_callback' => array( $this, 'get_item_permissions_check' ),
			'args'                => array(
				'context' => $this->get_context_param( array( 'default' => 'view' ) ),
			),
		),
		array(
			'methods'             => WP_REST_Server::EDITABLE,
			'callback'            => array( $this, 'update_item' ),
			'permission_callback' => array( $this, 'update_item_permissions_check' ),
			'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
		),
		array(
			'methods'             => WP_REST_Server::DELETABLE,
			'callback'            => array( $this, 'delete_item' ),
			'permission_callback' => array( $this, 'delete_item_permissions_check' ),
			'args'                => array(
				'force' => array(
					'default'     => false,
					'type'        => 'boolean',
					'description' => __( 'Whether to bypass trash and force deletion.', 'woocommerce' ),
				),
			),
		),
		'schema' => array( $this, 'get_public_item_schema' ),
	) );
}