WP_Customize_Setting::validate() WordPress Method
The WP_Customize_Setting::validate() method is used to ensure that a given setting value is valid. This is done by sanitizing the value and then validating it against the setting's rules. If the value is not valid, the method will return an error.
WP_Customize_Setting::validate( mixed $value ) #
Validates an input.
Description
See also
Parameters
- $value
(mixed)(Required)Value to validate.
Return
(true|WP_Error) True if the input was validated, otherwise WP_Error.
Source
File: wp-includes/class-wp-customize-setting.php
public function validate( $value ) { if ( is_wp_error( $value ) ) { return $value; } if ( is_null( $value ) ) { return new WP_Error( 'invalid_value', __( 'Invalid value.' ) ); } $validity = new WP_Error(); /** * Validates a Customize setting value. * * Plugins should amend the `$validity` object via its `WP_Error::add()` method. * * The dynamic portion of the hook name, `$this->ID`, refers to the setting ID. * * @since 4.6.0 * * @param WP_Error $validity Filtered from `true` to `WP_Error` when invalid. * @param mixed $value Value of the setting. * @param WP_Customize_Setting $setting WP_Customize_Setting instance. */ $validity = apply_filters( "customize_validate_{$this->id}", $validity, $value, $this ); if ( is_wp_error( $validity ) && ! $validity->has_errors() ) { $validity = true; } return $validity; }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
4.6.0 | Introduced. |