WP_REST_Server::get_json_encode_options() – Method

WP_REST_Server::get_json_encode_options( WP_REST_Request $request ): int

Gets the encoding options passed to wp_json_encode.

Parameters

$requestWP_REST_Requestrequired: The current request object.

Return

int The JSON encode options.

Source

protected function get_json_encode_options( WP_REST_Request $request ) {
	$options = 0;

	if ( $request->has_param( '_pretty' ) ) {
		$options |= JSON_PRETTY_PRINT;
	}

	/**
	 * Filters the JSON encoding options used to send the REST API response.
	 *
	 * @since 6.1.0
	 *
	 * @param int $options             JSON encoding options json_encode().
	 * @param WP_REST_Request $request Current request object.
	 */
	return apply_filters( 'rest_json_encode_options', $options, $request );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘rest_json_encode_options’, int $options, WP_REST_Request $request ): Filters the JSON encoding options used to send the REST API response.

Uses	Description
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.

Used by	Description
WP_REST_Server::serve_request()`wp-includes/rest-api/class-wp-rest-server.php`	Handles serving a REST API request.

Changelog

Version	Description
6.1.0	Introduced.

User Contributed Notes

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