[ Index ]

PHP Cross Reference of WordPress




/wp-admin/includes/ -> user.php (summary)

WordPress user administration API.

File Size: 669 lines (21 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 14 functions


Functions that are not part of a class:

add_user()   X-Ref
Creates a new user from the "Users" form using $_POST information.

return: int|WP_Error WP_Error or User ID.
since: 2.0.0

edit_user( $user_id = 0 )   X-Ref
Edit user settings based on contents of $_POST

Used on user-edit.php and profile.php to manage and process user options, passwords etc.

return: int|WP_Error User ID of the updated user or WP_Error on failure.
param: int $user_id Optional. User ID.
since: 2.0.0

get_editable_roles()   X-Ref
Fetch a filtered list of user roles that the current user is
allowed to edit.

Simple function whose main purpose is to allow filtering of the
list of roles in the $wp_roles object so that plugins can remove
inappropriate ones depending on the situation or user making edits.
Specifically because without filtering anyone with the edit_users
capability can edit others to be administrators, even if they are
only editors or authors. This filter allows admins to delegate
user management.

return: array[] Array of arrays containing role information.
since: 2.8.0

get_user_to_edit( $user_id )   X-Ref
Retrieve user data and filter it.

return: WP_User|false WP_User object on success, false on failure.
param: int $user_id User ID.
since: 2.0.5

get_users_drafts( $user_id )   X-Ref
Retrieve the user's drafts.

return: array
param: int $user_id User ID.
since: 2.0.0

wp_delete_user( $id, $reassign = null )   X-Ref
Remove user and optionally reassign posts and links to another user.

If the $reassign parameter is not assigned to a User ID, then all posts will
be deleted of that user. The action {@see 'delete_user'} that is passed the User ID
being deleted will be run after the posts are either reassigned or deleted.
The user meta will also be deleted that are for that User ID.

return: bool True when finished.
param: int $id User ID.
param: int $reassign Optional. Reassign posts and links to new User ID.
since: 2.0.0

wp_revoke_user( $id )   X-Ref
Remove all capabilities from user.

param: int $id User ID.
since: 2.1.0

default_password_nag_handler( $errors = false )   X-Ref

param: false $errors Deprecated.
since: 2.8.0

default_password_nag_edit_user( $user_ID, $old_data )   X-Ref

param: int     $user_ID
param: WP_User $old_data
since: 2.8.0

default_password_nag()   X-Ref

since: 2.8.0

delete_users_add_js()   X-Ref

since: 3.5.0

use_ssl_preference( $user )   X-Ref
Optional SSL preference that can be turned on by hooking to the 'personal_options' action.

See the {@see 'personal_options'} action.

param: WP_User $user User data object.
since: 2.7.0

admin_created_user_email( $text )   X-Ref

return: string
param: string $text
since: MU (3.0.0)

wp_is_authorize_application_password_request_valid( $request, $user )   X-Ref
Checks if the Authorize Application Password request is valid.

return: true|WP_Error True if the request is valid, a WP_Error object contains errors if not.
param: array   $request {
param: WP_User $user The user authorizing the application.
since: 5.6.0

Generated: Sun Apr 14 01:00:02 2024 Cross-referenced by PHPXref 0.7.1