rest_prepare_sidebar

Filter Hook

Description

Filters the REST API response for a sidebar.

Hook Information

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

Hook Parameters

Type	Name	Description
`WP_REST_Response`	`$response`	The response object.
`array`	`$raw_sidebar`	The raw sidebar data.
`WP_REST_Request`	`$request`	The request object.

Usage Examples

Basic Usage

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

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

Source Code Context

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

<?php
 397  		 *
 398  		 * @param WP_REST_Response $response    The response object.
 399  		 * @param array            $raw_sidebar The raw sidebar data.
 400  		 * @param WP_REST_Request  $request     The request object.
 401  		 */
 402  		return apply_filters( 'rest_prepare_sidebar', $response, $raw_sidebar, $request );
 403  	}
 404  
 405  	/**
 406  	 * Prepares links for the sidebar.
 407  	 *

PHP Documentation

<?php
/**
		 * Filters the REST API response for a sidebar.
		 *
		 * @since 5.8.0
		 *
		 * @param WP_REST_Response $response    The response object.
		 * @param array            $raw_sidebar The raw sidebar data.
		 * @param WP_REST_Request  $request     The request object.
		 */

Quick Info

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

Links

WordPress Docs View Source Code Search Examples

Related Hooks

Related hooks will be displayed here in future updates.