woocommerce_settings_rest_api

Get settings array.

Description

(array) apply_filters( 'woocommerce_settings_rest_api', (array) $array ); 

Returns (array)

Parameters (1)

0. $array — Optional. (array) => array( array( 'title' => __( 'General options', 'woocommerce' ), 'type' => 'title', 'desc' => '', 'id' => 'general_options', ),array( 'title' => __( 'API', 'woocommerce' ), 'desc' => __( 'Enable the REST API', 'woocommerce' ), 'id' => 'woocommerce_api_enabled', 'type' => 'checkbox', 'default' => 'yes', ),array( 'type' => 'sectionend', 'id' => 'general_options', ), )
The array.

Usage

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

Defined (1)

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

/includes/admin/settings/class-wc-settings-api.php  
  1. $settings = apply_filters( 'woocommerce_settings_rest_api', array(