[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-admin/includes/ -> class-wp-users-list-table.php (summary)

List Table API: WP_Users_List_Table class

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

Defines 1 class

WP_Users_List_Table:: (14 methods):
  __construct()
  ajax_user_can()
  prepare_items()
  no_items()
  get_views()
  get_bulk_actions()
  extra_tablenav()
  current_action()
  get_columns()
  get_sortable_columns()
  display_rows()
  single_row()
  get_default_primary_column_name()
  get_role_list()


Class: WP_Users_List_Table  - X-Ref

Core class used to implement displaying users in a list table.

__construct( $args = array()   X-Ref
Constructor.

param: array $args An associative array of arguments.
since: 3.1.0

ajax_user_can()   X-Ref
Check the current user's permissions.

return: bool
since: 3.1.0

prepare_items()   X-Ref
Prepare the users list for display.

since: 3.1.0

no_items()   X-Ref
Output 'no users' message.

since: 3.1.0

get_views()   X-Ref
Return an associative array listing all the views that can be used
with this table.

Provides a list of roles and user count for that role for easy
Filtersing of the user table.

return: array An array of HTML links, one for each view.
since: 3.1.0

get_bulk_actions()   X-Ref
Retrieve an associative array of bulk actions available on this table.

return: array Array of bulk actions.
since: 3.1.0

extra_tablenav( $which )   X-Ref
Output the controls to allow user roles to be changed in bulk.

param: string $which Whether this is being invoked above ("top")
since: 3.1.0

current_action()   X-Ref
Capture the bulk action required, and return it.

Overridden from the base class implementation to capture
the role change drop-down.

return: string The bulk action required.
since: 3.1.0

get_columns()   X-Ref
Get a list of columns for the list table.

return: array Array in which the key is the ID of the column,
since: 3.1.0

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

return: array Array of sortable columns.
since: 3.1.0

display_rows()   X-Ref
Generate the list table rows.

since: 3.1.0

single_row( $user_object, $style = '', $role = '', $numposts = 0 )   X-Ref
Generate HTML for a single row on the users.php admin panel.

param: WP_User $user_object The current user object.
param: string  $style       Deprecated. Not used.
param: string  $role        Deprecated. Not used.
param: int     $numposts    Optional. Post count to display for this user. Defaults
return: string Output for a single row.
since: 3.1.0
since: 4.2.0 The `$style` parameter was deprecated.
since: 4.4.0 The `$role` parameter was deprecated.

get_default_primary_column_name()   X-Ref
Gets the name of the default primary column.

return: string Name of the default primary column, in this case, 'username'.
since: 4.3.0

get_role_list( $user_object )   X-Ref
Returns an array of user roles for a given user object.

param: WP_User $user_object The WP_User object.
return: string[] An array of user roles.
since: 4.4.0



Generated: Tue Sep 17 01:00:03 2019 Cross-referenced by PHPXref 0.7.1