Filter hook 'rest_envelope_response'

Hook Information

Hook Parameters

Usage Examples

<?php
// Hook into rest_envelope_response
add_filter('rest_envelope_response', 'my_custom_filter', 10, 2);

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

Source Code Context

<?php
 876  		 *     @type int   $status  The 3-digit HTTP status code.
 877  		 *     @type array $headers Map of header name to header value.
 878  		 * }
 879  		 * @param WP_REST_Response $response Original response data.
 880  		 */
 881  		$envelope = apply_filters( 'rest_envelope_response', $envelope, $response );
 882  
 883  		// Ensure it's still a response and return.
 884  		return rest_ensure_response( $envelope );
 885  	}
 886  

PHP Documentation

<?php
/**
		 * Filters the enveloped form of a REST API response.
		 *
		 * @since 4.4.0
		 *
		 * @param array            $envelope {
		 *     Envelope data.
		 *
		 *     @type array $body    Response data.
		 *     @type int   $status  The 3-digit HTTP status code.
		 *     @type array $headers Map of header name to header value.
		 * }
		 * @param WP_REST_Response $response Original response data.
		 */