[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

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

WordPress user administration API.

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

Defines 13 functions

  add_user()
  edit_user()
  get_editable_roles()
  get_user_to_edit()
  get_users_drafts()
  wp_delete_user()
  wp_revoke_user()
  default_password_nag_handler()
  default_password_nag_edit_user()
  default_password_nag()
  delete_users_add_js()
  use_ssl_preference()
  admin_created_user_email()

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.

param: int $user_id Optional. User ID.
return: int|WP_Error user id of the updated user.
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.

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

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

param: int $user_id User ID.
return: array
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.

param: int $id User ID.
param: int $reassign Optional. Reassign posts and links to new User ID.
return: bool True when finished.
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: object $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: object $user User data object.
since: 2.7.0

admin_created_user_email( $text )   X-Ref

param: string $text
return: string



Generated: Sat Jul 20 01:00:03 2019 Cross-referenced by PHPXref 0.7.1