rest_prepare_widget

Filter Hook

Description

Filters the REST API response for a widget.

Hook Information

File Location	`wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php` View on GitHub
Hook Type	Filter
Line Number	`753`

Hook Parameters

Type	Name	Description
`WP_REST_Response\|WP_Error`	`$response`	The response object, or WP_Error object on failure.
`array`	`$widget`	The registered widget data.
`WP_REST_Request`	`$request`	Request used to generate the response.

Usage Examples

Basic Usage

<?php
// Hook into rest_prepare_widget
add_filter('rest_prepare_widget', 'my_custom_filter', 10, 3);

function my_custom_filter($response, $widget, $request) {
    // Your custom filtering logic here
    return $response;
}

Source Code Context

wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php:753 - How this hook is used in WordPress core

<?php
 748  		 *
 749  		 * @param WP_REST_Response|WP_Error $response The response object, or WP_Error object on failure.
 750  		 * @param array                     $widget   The registered widget data.
 751  		 * @param WP_REST_Request           $request  Request used to generate the response.
 752  		 */
 753  		return apply_filters( 'rest_prepare_widget', $response, $widget, $request );
 754  	}
 755  
 756  	/**
 757  	 * Prepares links for the widget.
 758  	 *

PHP Documentation

<?php
/**
		 * Filters the REST API response for a widget.
		 *
		 * @since 5.8.0
		 *
		 * @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.
		 */

Quick Info

Hook Type: Filter
Parameters: 3
File: wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php

Links

WordPress Docs View Source Code Search Examples

Related Hooks

Related hooks will be displayed here in future updates.