[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

title

Body

[close]

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

WordPress user administration API.

File Size: 1706 lines (52 kb)
Included or required: 2 times
Referenced: 0 times
Includes or requires: 1 file
 wp-admin/includes/class-wp-list-table.php

Defines 2 classes

WP_Privacy_Data_Export_Requests_Table:: (2 methods):
  column_email()
  column_next_steps()

WP_Privacy_Data_Removal_Requests_Table:: (2 methods):
  column_email()
  column_next_steps()

Defines 2 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()
  _wp_privacy_resend_request()
  _wp_privacy_completed_request()
  _wp_personal_data_handle_actions()
  _wp_personal_data_cleanup_requests()
  _wp_personal_data_export_page()
  _wp_personal_data_removal_page()
  wp_privacy_process_personal_data_erasure_page()
  _wp_privacy_hook_requests_page()
  _wp_privacy_requests_screen_options()
  get_columns()
  get_sortable_columns()
  get_default_primary_column_name()
  get_request_counts()
  get_views()
  get_bulk_actions()
  process_bulk_action()
  prepare_items()
  column_cb()
  column_status()
  get_timestamp_as_date()
  column_default()
  column_email()
  column_next_steps()
  single_row()
  embed_scripts()

Class: WP_Privacy_Data_Export_Requests_Table  - X-Ref

WP_Privacy_Data_Export_Requests_Table class.

column_email( $item )   X-Ref
Actions column.

return: string Email column markup.
param: WP_User_Request $item Item being shown.

column_next_steps( $item )   X-Ref
Displays the next steps column.

param: WP_User_Request $item Item being shown.

Class: WP_Privacy_Data_Removal_Requests_Table  - X-Ref

WP_Privacy_Data_Removal_Requests_Table class.

column_email( $item )   X-Ref
Actions column.

return: string Email column markup.
param: WP_User_Request $item Item being shown.

column_next_steps( $item )   X-Ref
Next steps column.

param: WP_User_Request $item Item being shown.

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.

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

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.

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

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

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

return: array
param: int $user_id User ID.

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.

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

param: int $id User ID.

default_password_nag_handler( $errors = false )   X-Ref

param: false $errors Deprecated.

default_password_nag_edit_user( $user_ID, $old_data )   X-Ref

param: int    $user_ID
param: object $old_data

default_password_nag()   X-Ref


delete_users_add_js()   X-Ref


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.

admin_created_user_email( $text )   X-Ref

return: string
param: string $text

_wp_privacy_resend_request( $request_id )   X-Ref
Resend an existing request and return the result.

return: bool|WP_Error Returns true/false based on the success of sending the email, or a WP_Error object.
param: int $request_id Request ID.

_wp_privacy_completed_request( $request_id )   X-Ref
Marks a request as completed by the admin and logs the current timestamp.

return: int|WP_Error $result Request ID on success or WP_Error.
param: int          $request_id Request ID.

_wp_personal_data_handle_actions()   X-Ref
Handle list table actions.


_wp_personal_data_cleanup_requests()   X-Ref
Cleans up failed and expired requests before displaying the list table.


_wp_personal_data_export_page()   X-Ref
Personal data export.


_wp_personal_data_removal_page()   X-Ref
Personal data anonymization.


wp_privacy_process_personal_data_erasure_page( $response, $eraser_index, $email_address, $page, $request_id )   X-Ref
Mark erasure requests as completed after processing is finished.

This intercepts the Ajax responses to personal data eraser page requests, and
monitors the status of a request. Once all of the processing has finished, the
request is marked as completed.

return: array The filtered response.
param: array  $response      The response from the personal data eraser for
param: int    $eraser_index  The index of the personal data eraser. Begins
param: string $email_address The email address of the user whose personal
param: int    $page          The page of personal data for this eraser.
param: int    $request_id    The request ID for this personal data erasure.

_wp_privacy_hook_requests_page()   X-Ref
Add requests pages.


_wp_privacy_requests_screen_options()   X-Ref
Add options for the privacy requests screens.


get_columns()   X-Ref
Get columns to show in the list table.

return: array Array of columns.

get_sortable_columns()   X-Ref
Get a list of sortable columns.

return: array Default sortable columns.

get_default_primary_column_name()   X-Ref
Default primary column.

return: string Default primary column name.

get_request_counts()   X-Ref
Count number of requests for each status.

return: object Number of posts for each status.

get_views()   X-Ref
Get an associative array ( id => link ) with the list of views available on this table.

return: array Associative array of views in the format of $view_name => $view_markup.

get_bulk_actions()   X-Ref
Get bulk actions.

return: array List of bulk actions.

process_bulk_action()   X-Ref
Process bulk actions.


prepare_items()   X-Ref
Prepare items to output.


column_cb( $item )   X-Ref
Checkbox column.

return: string Checkbox column markup.
param: WP_User_Request $item Item being shown.

column_status( $item )   X-Ref
Status column.

return: string Status column markup.
param: WP_User_Request $item Item being shown.

get_timestamp_as_date( $timestamp )   X-Ref
Convert timestamp for display.

return: string Human readable date.
param: int $timestamp Event timestamp.

column_default( $item, $column_name )   X-Ref
Default column handler.

return: string Default column output.
param: WP_User_Request $item        Item being shown.
param: string          $column_name Name of column being shown.

column_email( $item )   X-Ref
Actions column. Overridden by children.

return: string Email column markup.
param: WP_User_Request $item Item being shown.

column_next_steps( $item )   X-Ref
Next steps column. Overridden by children.

param: WP_User_Request $item Item being shown.

single_row( $item )   X-Ref
Generates content for a single row of the table,

param: WP_User_Request $item The current item.

embed_scripts()   X-Ref
Embed scripts used to perform actions. Overridden by children.




Generated: Sat Feb 16 08:20:01 2019 Cross-referenced by PHPXref 0.7