Users
in package
Extended user admin functionality.
Adds fields showing registration and last login dates to admin screens. Removes obsolete default contact methods. Shows meta data for additional profile content.
Tags
Table of Contents
Constants
- ACTIVITY_CONTAINER = 'table-user-activity.php'
- Partial to display user activity.
Properties
- $activity_container : string
- Fully qualified path to user activity display partial.
- $common_users : Users
- The instance of the Common_Users class.
- $instances : array<string|int, object>
- The array of instances of this class and sub-classes.
Methods
- add_custom_columns() : array<string|int, string>
- Add registration date and last login date columns to the user admin table.
- additional_fields() : void
- Show additional user fields on profile page.
- get_instance() : object
- Creates and/or returns the instance of this class.
- make_sortable_custom_columns() : array<string|int, string>
- Make custom columns sortable.
- populate_custom_columns() : string
- Sets data for the custom columns on the all users admin page.
- revise_contact_methods() : array<string|int, mixed>
- Remove obsolete user contact methods.
- sortable_custom_columns_orderby() : void
- Modify query to include custom columns.
- __construct() : void
- Initialise the class.
Constants
ACTIVITY_CONTAINER
Partial to display user activity.
protected
string
ACTIVITY_CONTAINER
= 'table-user-activity.php'
Tags
Properties
$activity_container
Fully qualified path to user activity display partial.
protected
string
$activity_container
= ''
Tags
$common_users
The instance of the Common_Users class.
protected
Users
$common_users
Tags
$instances
The array of instances of this class and sub-classes.
protected
static array<string|int, object>
$instances
= array()
Tags
Methods
add_custom_columns()
Add registration date and last login date columns to the user admin table.
public
add_custom_columns(array<string|int, string> $columns) : array<string|int, string>
Parameters
- $columns : array<string|int, string>
-
Array of column name => label pairs.
Tags
Return values
array<string|int, string> —The modified columns array.
additional_fields()
Show additional user fields on profile page.
public
additional_fields(object $profile_user) : void
Parameters
- $profile_user : object
-
WP_User object.
Tags
get_instance()
Creates and/or returns the instance of this class.
public
static get_instance() : object
Tags
Return values
object —The instance of this class.
make_sortable_custom_columns()
Make custom columns sortable.
public
make_sortable_custom_columns(array<string|int, string> $columns) : array<string|int, string>
Parameters
- $columns : array<string|int, string>
-
Array of column name => label pairs.
Tags
Return values
array<string|int, string> —The modified columns array.
populate_custom_columns()
Sets data for the custom columns on the all users admin page.
public
populate_custom_columns(string $output, string $column_name, int $user_id) : string
Parameters
- $output : string
-
Custom column output.
- $column_name : string
-
Name of the custom column.
- $user_id : int
-
User id.
Tags
Return values
string —The data to display in the column.
revise_contact_methods()
Remove obsolete user contact methods.
public
revise_contact_methods(array<string|int, mixed> $methods) : array<string|int, mixed>
Parameters
- $methods : array<string|int, mixed>
-
Array of contact methods and their labels.
Tags
Return values
array<string|int, mixed> —The modified contact methods.
sortable_custom_columns_orderby()
Modify query to include custom columns.
public
sortable_custom_columns_orderby(object $query) : void
Parameters
- $query : object
-
Query object, passed by reference.
Tags
__construct()
Initialise the class.
protected
__construct() : void