WP_REST_Settings_Controller::sanitize_callback( mixed $value, WP_REST_Request $request, string $param ): mixed|WP_Error

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.


Top ↑

Parameters

$value mixed Required
The value for the setting.
$request WP_REST_Request Required
The request object.
$param string Required
The parameter name.

Top ↑

Return

mixed|WP_Error


Top ↑

Source

File: wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.php. View all references

public function sanitize_callback( $value, $request, $param ) {
	if ( is_null( $value ) ) {
		return $value;
	}

	return rest_parse_request_arg( $value, $request, $param );
}


Top ↑

Changelog

Changelog
Version Description
4.7.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.