Automattic\WooCommerce\StoreApi\Routes\V1

ProductAttributeTerms{} │ WC 1.0

ProductAttributeTerms class.

No Hooks.

Usage

$ProductAttributeTerms = new ProductAttributeTerms();
// use class methods

Methods

1. public get_args()
2. public get_collection_params()
3. ERROR: no method name found on line `*/`
4. ERROR: no method name found on line ``
5. ERROR: no method name found on line ``
6. public if ( ! $attribute || ! taxonomy_exists( $attribute->slug ) )
7. public get_path()
8. public static get_path_regex()
9. protected get_route_response( \WP_REST_Request $request )
10. ERROR: no method name found on line `return '/products/attributes/(?P<attribute_id>[\d]+)/terms';`

ProductAttributeTerms{} ProductAttributeTerms{} code ^{WC 9.3.3}

class ProductAttributeTerms extends AbstractTermsRoute {
	/**
	 * The route identifier.
	 *
	 * @var string
	 */
	const IDENTIFIER = 'product-attribute-terms';

	/**
	 * Get the path of this REST route.
	 *
	 * @return string
	 */
	public function get_path() {
		return self::get_path_regex();
	}

	/**
	 * Get the path of this rest route.
	 *
	 * @return string
	 */
	public static function get_path_regex() {
		return '/products/attributes/(?P<attribute_id>[\d]+)/terms';
	}

	/**
	 * Get method arguments for this REST route.
	 *
	 * @return array An array of endpoints.
	 */
	public function get_args() {
		return [
			'args'   => array(
				'attribute_id' => array(
					'description' => __( 'Unique identifier for the attribute.', 'woocommerce' ),
					'type'        => 'integer',
				),
			),
			[
				'methods'             => \WP_REST_Server::READABLE,
				'callback'            => [ $this, 'get_response' ],
				'permission_callback' => '__return_true',
				'args'                => $this->get_collection_params(),
			],
			'schema' => [ $this->schema, 'get_public_item_schema' ],
		];
	}

	/**
	 * Get the query params for collections of attributes.
	 *
	 * @return array
	 */
	public function get_collection_params() {
		$params                      = parent::get_collection_params();
		$params['orderby']['enum'][] = 'menu_order';
		$params['orderby']['enum'][] = 'name_num';
		$params['orderby']['enum'][] = 'id';
		return $params;
	}

	/**
	 * Get a collection of attribute terms.
	 *
	 * @throws RouteException On error.
	 * @param \WP_REST_Request $request Request object.
	 * @return \WP_REST_Response
	 */
	protected function get_route_response( \WP_REST_Request $request ) {
		$attribute = wc_get_attribute( $request['attribute_id'] );

		if ( ! $attribute || ! taxonomy_exists( $attribute->slug ) ) {
			throw new RouteException( 'woocommerce_rest_taxonomy_invalid', __( 'Attribute does not exist.', 'woocommerce' ), 404 );
		}

		return $this->get_terms_response( $attribute->slug, $request );
	}
}