From c60ef4ba6239c3c5f50b13c2250d6194bb26d12b Mon Sep 17 00:00:00 2001 From: Claudio Sanches Date: Wed, 2 Mar 2016 20:28:31 -0300 Subject: [PATCH] List and get product tags --- .../wc-rest-product-categories-controller.php | 4 +- .../api/wc-rest-product-tags-controller.php | 90 ++++++++++++++++++- 2 files changed, 88 insertions(+), 6 deletions(-) diff --git a/includes/api/wc-rest-product-categories-controller.php b/includes/api/wc-rest-product-categories-controller.php index 086572c81a7..ee248aa88cc 100644 --- a/includes/api/wc-rest-product-categories-controller.php +++ b/includes/api/wc-rest-product-categories-controller.php @@ -65,8 +65,8 @@ class WC_REST_Product_Categories_Controller extends WC_REST_Terms_Controller { ); $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; - $data = $this->add_additional_fields_to_object( $data, $request ); - $data = $this->filter_response_by_context( $data, $context ); + $data = $this->add_additional_fields_to_object( $data, $request ); + $data = $this->filter_response_by_context( $data, $context ); $response = rest_ensure_response( $data ); diff --git a/includes/api/wc-rest-product-tags-controller.php b/includes/api/wc-rest-product-tags-controller.php index 71263144a32..86b2f760fa7 100644 --- a/includes/api/wc-rest-product-tags-controller.php +++ b/includes/api/wc-rest-product-tags-controller.php @@ -30,16 +30,98 @@ class WC_REST_Product_Tags_Controller extends WC_REST_Terms_Controller { protected $rest_base = 'products/tags'; /** - * Type of object. + * Taxonomy. * * @var string */ - protected $object = 'product_tag'; + protected $taxonomy = 'product_tag'; /** - * Register the routes for product tags. + * Prepare a single product tag output for response. + * + * @param obj $item Term object. + * @param WP_REST_Request $request + * @return WP_REST_Response $response */ - public function register_routes() { + public function prepare_item_for_response( $item, $request ) { + $data = array( + 'id' => (int) $item->term_id, + 'name' => $item->name, + 'slug' => $item->slug, + 'description' => $item->description, + 'count' => (int) $item->count, + ); + $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; + $data = $this->add_additional_fields_to_object( $data, $request ); + $data = $this->filter_response_by_context( $data, $context ); + + $response = rest_ensure_response( $data ); + + $response->add_links( $this->prepare_links( $item ) ); + + /** + * Filter a term item returned from the API. + * + * Allows modification of the term data right before it is returned. + * + * @param WP_REST_Response $response The response object. + * @param object $item The original term object. + * @param WP_REST_Request $request Request used to generate the response. + */ + return apply_filters( "woocommerce_rest_prepare_{$this->taxonomy}", $response, $item, $request ); + } + + /** + * Get the Term's schema, conforming to JSON Schema. + * + * @return array + */ + public function get_item_schema() { + $schema = array( + '$schema' => 'http://json-schema.org/draft-04/schema#', + 'title' => $this->taxonomy, + 'type' => 'object', + 'properties' => array( + 'id' => array( + 'description' => __( 'Unique identifier for the resource.', 'woocommerce' ), + 'type' => 'integer', + 'context' => array( 'view', 'edit' ), + 'readonly' => true, + ), + 'name' => array( + 'description' => __( 'Tag name.', 'woocommerce' ), + 'type' => 'string', + 'context' => array( 'view', 'edit' ), + 'arg_options' => array( + 'sanitize_callback' => 'sanitize_text_field', + ), + ), + 'slug' => array( + 'description' => __( 'An alphanumeric identifier for the resource unique to its type.', 'woocommerce' ), + 'type' => 'string', + 'context' => array( 'view', 'edit' ), + 'arg_options' => array( + 'sanitize_callback' => 'sanitize_title', + ), + ), + 'description' => array( + 'description' => __( 'HTML description of the resource.', 'woocommerce' ), + 'type' => 'string', + 'context' => array( 'view', 'edit' ), + 'arg_options' => array( + 'sanitize_callback' => 'wp_filter_post_kses', + ), + ), + 'count' => array( + 'description' => __( 'Number of published products for the resource.', 'woocommerce' ), + 'type' => 'integer', + 'context' => array( 'view', 'edit', 'woocommerce' ), + 'readonly' => true, + ), + ), + ); + + return $this->add_additional_fields_schema( $schema ); } }