rest_pre_insert_user

Filters user data before insertion via the REST API.

Description

apply_filters( 'rest_pre_insert_user', (object) $prepared_user, (WP_REST_Request) $request ); 

Parameters (2)

0. $prepared_user (object)
The prepared user.
1. $request (WP_REST_Request)
Request object.

Usage

To run the hook, copy the example below.
  1. $prepared_user = apply_filters( 'rest_pre_insert_user', $prepared_user, $request ); 
  2.  
  3. if ( !empty( $prepared_user ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the rest_pre_insert_user callback 
  2. function filter_rest_pre_insert_user( $prepared_user, $request ) { 
  3. // make filter magic happen here... 
  4. return $prepared_user
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'rest_pre_insert_user', 'filter_rest_pre_insert_user', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'rest_pre_insert_user', 'filter_rest_pre_insert_user', 10, 2 ); 

Defined (1)

The filter is defined in the following location(s).

/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php  
  1. return apply_filters( 'rest_pre_insert_user', $prepared_user, $request );