rest_insert_user

Action Hook

Description

Updates a single user.

Hook Information

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

Hook Parameters

Type	Name	Description
`WP_REST_Request`	`$request`	Full details about the request.

Usage Examples

Basic Usage

<?php
// Hook into rest_insert_user
add_action('rest_insert_user', 'my_custom_function', 10, 1);

function my_custom_function($request) {
    // Your custom code here
}

Source Code Context

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

<?php
 811  		}
 812  
 813  		$user = get_user_by( 'id', $user_id );
 814  
 815  		/** This action is documented in wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php */
 816  		do_action( 'rest_insert_user', $user, $request, false );
 817  
 818  		if ( ! empty( $request['roles'] ) ) {
 819  			array_map( array( $user, 'add_role' ), $request['roles'] );
 820  		}
 821

PHP Documentation

<?php
/**
	 * Updates a single user.
	 *
	 * @since 4.7.0
	 *
	 * @param WP_REST_Request $request Full details about the request.
	 * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
	 */

Quick Info

Hook Type: Action
Parameters: 1
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.