rest_prepare_user

Filter Hook

Description

Filters user data returned from the REST API.

Hook Information

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

Hook Parameters

Type	Name	Description
`WP_REST_Response`	`$response`	The response object.
`WP_User`	`$user`	User object used to create response.
`WP_REST_Request`	`$request`	Request object.

Usage Examples

Basic Usage

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

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

Source Code Context

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

<?php
1130  		 *
1131  		 * @param WP_REST_Response $response The response object.
1132  		 * @param WP_User          $user     User object used to create response.
1133  		 * @param WP_REST_Request  $request  Request object.
1134  		 */
1135  		return apply_filters( 'rest_prepare_user', $response, $user, $request );
1136  	}
1137  
1138  	/**
1139  	 * Prepares links for the user request.
1140  	 *

PHP Documentation

<?php
/**
		 * Filters user data returned from the REST API.
		 *
		 * @since 4.7.0
		 *
		 * @param WP_REST_Response $response The response object.
		 * @param WP_User          $user     User object used to create response.
		 * @param WP_REST_Request  $request  Request object.
		 */

Quick Info

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

Links

WordPress Docs View Source Code Search Examples

Related Hooks

Related hooks will be displayed here in future updates.