invite_user │ action-hook │ WP 4.4.0

Fires immediately after an existing user is invited to join the site, but before the notification is sent.

Usage

add_action( 'invite_user', 'wp_kama_invite_user_action', 10, 3 );

/**
 * Function for `invite_user` action-hook.
 * 
 * @param int    $user_id     The invited user's ID.
 * @param array  $role        Array containing role information for the invited user.
 * @param string $newuser_key The key of the invitation.
 *
 * @return void
 */
function wp_kama_invite_user_action( $user_id, $role, $newuser_key ){

	// action...
}

$user_id(int)

The invited user's ID.

$role(array)

Array containing role information for the invited user.

$newuser_key(string)

The key of the invitation.

Changelog

Where the hook is called

do_action( 'invite_user', $user_id, $role, $newuser_key );

Where the hook is used in WordPress