rest_post_dispatch

Filter Hook

Description

Serves the batch/v1 request.

Hook Information

File Location	`wp-includes/rest-api/class-wp-rest-server.php` View on GitHub
Hook Type	Filter
Line Number	`1860`

Hook Parameters

Type	Name	Description
`WP_REST_Request`	`$batch_request`	The batch request object.

Usage Examples

Basic Usage

<?php
// Hook into rest_post_dispatch
add_filter('rest_post_dispatch', 'my_custom_filter', 10, 1);

function my_custom_filter($batch_request) {
    // Your custom filtering logic here
    return $batch_request;
}

Source Code Context

wp-includes/rest-api/class-wp-rest-server.php:1860 - How this hook is used in WordPress core

<?php
1855  					$result = $this->respond_to_request( $single_request, $route, $handler, $error );
1856  				}
1857  			}
1858  
1859  			/** This filter is documented in wp-includes/rest-api/class-wp-rest-server.php */
1860  			$result = apply_filters( 'rest_post_dispatch', rest_ensure_response( $result ), $this, $single_request );
1861  
1862  			$responses[] = $this->envelope_response( $result, false )->get_data();
1863  		}
1864  
1865  		return new WP_REST_Response( array( 'responses' => $responses ), WP_Http::MULTI_STATUS );

PHP Documentation

<?php
/**
	 * Serves the batch/v1 request.
	 *
	 * @since 5.6.0
	 *
	 * @param WP_REST_Request $batch_request The batch request object.
	 * @return WP_REST_Response The generated response object.
	 */

Quick Info

Hook Type: Filter
Parameters: 1
File: wp-includes/rest-api/class-wp-rest-server.php

Links

WordPress Docs View Source Code Search Examples

Related Hooks

Related hooks will be displayed here in future updates.