rest_pre_insert_user

Filter Hook

Description

Filters user data before insertion via 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	`1235`

Hook Parameters

Type	Name	Description
`object`	`$prepared_user`	User object.
`WP_REST_Request`	`$request`	Request object.

Usage Examples

Basic Usage

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

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

Source Code Context

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

<?php
1230  		 * @since 4.7.0
1231  		 *
1232  		 * @param object          $prepared_user User object.
1233  		 * @param WP_REST_Request $request       Request object.
1234  		 */
1235  		return apply_filters( 'rest_pre_insert_user', $prepared_user, $request );
1236  	}
1237  
1238  	/**
1239  	 * Determines if the current user is allowed to make the desired roles change.
1240  	 *

PHP Documentation

<?php
/**
		 * Filters user data before insertion via the REST API.
		 *
		 * @since 4.7.0
		 *
		 * @param object          $prepared_user User object.
		 * @param WP_REST_Request $request       Request object.
		 */

Quick Info

Hook Type: Filter
Parameters: 2
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.