WP_REST_Settings_Controller::sanitize_callback() WordPress Method
The WP_REST_Settings_Controller::sanitize_callback() method is used to sanitize data before it is saved to the database. This is a safety measure to ensure that only valid data is stored in the database.
WP_REST_Settings_Controller::sanitize_callback( mixed $value, WP_REST_Request $request, string $param ) #
Custom sanitize callback used for all options to allow the use of ‘null’.
Description
By default, the schema of settings will throw an error if a value is set to null as it’s not a valid value for something like "type => string". We provide a wrapper sanitizer to allow the use of null.
Parameters
- $value
(mixed)(Required)The value for the setting.
- $request
(WP_REST_Request)(Required)The request object.
- $param
(string)(Required)The parameter name.
Return
(mixed|WP_Error)
Source
File: wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.php
public function sanitize_callback( $value, $request, $param ) {
if ( is_null( $value ) ) {
return $value;
}
return rest_parse_request_arg( $value, $request, $param );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 4.7.0 | Introduced. |