woocommerce_rest_<object_type>_schema

The WooCommerce woocommerce rest object type schema hook.

Description

apply_filters( 'woocommerce_rest_<object_type>_schema', (unknown) $schema_properties ); 

Parameters (1)

0. $schema_properties (unknown)
The schema properties.

Usage

To run the hook, copy the example below.
  1. $schema_properties = apply_filters( 'woocommerce_rest_{$object_type}_schema', $schema_properties ); 
  2.  
  3. if ( !empty( $schema_properties ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the woocommerce_rest_<object_type>_schema callback 
  2. function filter_woocommerce_rest_object_type_schema( $schema_properties ) { 
  3. // make filter magic happen here... 
  4. return $schema_properties
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( "woocommerce_rest_{$object_type}_schema", 'filter_woocommerce_rest_object_type_schema', 10, 1 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( "woocommerce_rest_{$object_type}_schema", 'filter_woocommerce_rest_object_type_schema', 10, 1 ); 

Defined (1)

The filter is defined in the following location(s).

/includes/abstracts/abstract-wc-rest-controller.php  
  1. $schema['properties'] = apply_filters( 'woocommerce_rest_' . $object_type . '_schema', $schema['properties'] );