rest_prepare_widget │ filter-hook │ WP 5.8.0

Filters the REST API response for a widget.

Usage

add_filter( 'rest_prepare_widget', 'wp_kama_rest_prepare_widget_filter', 10, 3 );

/**
 * Function for `rest_prepare_widget` filter-hook.
 * 
 * @param WP_REST_Response|WP_Error $response The response object, or WP_Error object on failure.
 * @param array                     $widget   The registered widget data.
 * @param WP_REST_Request           $request  Request used to generate the response.
 *
 * @return WP_REST_Response|WP_Error
 */
function wp_kama_rest_prepare_widget_filter( $response, $widget, $request ){

	// filter...
	return $response;
}

$response(WP_REST_Response|WP_Error)

The response object, or WP_Error object on failure.

$widget(array)

The registered widget data.

$request(WP_REST_Request)

Request used to generate the response.

Changelog

Where the hook is called

return apply_filters( 'rest_prepare_widget', $response, $widget, $request );

return apply_filters( 'rest_prepare_widget', new WP_REST_Response( array() ), $widget, $request );

Where the hook is used in WordPress