woocommerce_admin_settings_sanitize_option
Sanitize the value of an option.
Description
apply_filters( 'woocommerce_admin_settings_sanitize_option', (unknown) $value, (unknown) $option, (unknown) $raw_value );
Parameters (3)
- 0. $value (unknown)
- The value.
- 1. $option (unknown)
- The option.
- 2. $raw_value (unknown)
- The raw value.
Usage
- To run the hook, copy the example below.
- $value = apply_filters( 'woocommerce_admin_settings_sanitize_option', $value, $option, $raw_value );
- if ( !empty( $value ) ) {
- // everything has led up to this point...
- }
- The following example is for adding a hook callback.
- // define the woocommerce_admin_settings_sanitize_option callback
- function filter_woocommerce_admin_settings_sanitize_option( $value, $option, $raw_value ) {
- // make filter magic happen here...
- return $value;
- };
- // add the filter
- add_filter( 'woocommerce_admin_settings_sanitize_option', 'filter_woocommerce_admin_settings_sanitize_option', 10, 3 );
- To remove a hook callback, use the example below.
- // remove the filter
- remove_filter( 'woocommerce_admin_settings_sanitize_option', 'filter_woocommerce_admin_settings_sanitize_option', 10, 3 );
Defined (1)
The filter is defined in the following location(s).
- /includes/admin/class-wc-admin-settings.php
- $value = apply_filters( 'woocommerce_admin_settings_sanitize_option', $value, $option, $raw_value );