-
Notifications
You must be signed in to change notification settings - Fork 134
/
class-llms-admin-users-table.php
240 lines (194 loc) · 6.24 KB
/
class-llms-admin-users-table.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
<?php
/**
* Manage WP Admin users table
*
* @package LifterLMS/Admin/Classes
*
* @since 3.34.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Admin_Users_Table class
*
* @since 3.34.0
* @since 4.0.0 Add custom user table columns and action links.
* @since 6.0.0 Removed the deprecated `LLMS_Admin_Users_Table::load_dependencies()` method.
*/
class LLMS_Admin_Users_Table {
/**
* Date/time format used to format last login timestamps
*
* This "caches" the data on the instance so that multiple requests
* to get_option() / wp_cache_get() don't need to be made when outputting
* a user table view.
*
* @var string
*/
protected $login_date_format = '';
/**
* Constructor.
*
* @since 3.34.0
* @since 4.0.0 Add custom user table columns and action links.
* @since 4.7.0 Remove `load_dependencies()` method hook.
*
* @return void
*/
public function __construct() {
add_filter( 'manage_users_columns', array( $this, 'add_cols' ) );
add_filter( 'manage_users_custom_column', array( $this, 'output_col' ), 10, 3 );
add_filter( 'users_list_table_query_args', array( $this, 'modify_query_args' ) );
add_filter( 'views_users', array( $this, 'modify_views' ) );
add_filter( 'user_row_actions', array( $this, 'add_actions' ), 20, 2 );
}
/**
* Add custom actions links
*
* Outputs a "Reports" action link seen when hovering over a user in the table.
*
* @since 4.0.0
*
* @param string[] $actions Array of existing action links.
* @param WP_User $user User object.
* @return string[]
*/
public function add_actions( $actions, $user ) {
$url = LLMS_Admin_Reporting::get_current_tab_url(
array(
'student_id' => $user->ID,
)
);
$actions['llms-reporting'] = '<a href="' . esc_url( $url ) . '">' . __( 'Reports', 'lifterlms' ) . '</a>';
return $actions;
}
/**
* Add Custom Columns to the Admin Users Table Screen
*
* @param array $columns key=>val array of existing columns
*
* @return array $columns updated columns
*/
public function add_cols( $columns ) {
$columns['llms-last-login'] = __( 'Last Login', 'lifterlms' );
$columns['llms-enrollments'] = __( 'Enrollments', 'lifterlms' );
return $columns;
}
/**
* Retrieve the date/time format used to display a user's last login.
*
* @since 4.0.0
*
* @return string
*/
protected function get_login_column_date_format() {
if ( ! $this->login_date_format ) {
$this->login_date_format = get_option( 'date_format', 'Y-m-d' ) . ' ' . get_option( 'time_format', ' h:i:s a' );
}
return $this->login_date_format;
}
/**
* Retrieves the output for the "enrollments" column.
*
* @since 4.0.0
*
* @param LLMS_Student $student Student object.
* @return string
*/
protected function get_enrollments_column_output( $student ) {
$info = array();
$types = array(
'courses' => __( 'Courses', 'lifterlms' ),
'memberships' => __( 'Memberships', 'lifterlms' ),
);
foreach ( $types as $type => $name ) {
$url = LLMS_Admin_Reporting::get_current_tab_url(
array(
'stab' => $type,
'student_id' => $student->get_id(),
)
);
$query = call_user_func( array( $student, 'get_' . $type ), array( 'limit' => 1 ) );
$info[] = sprintf( '%1$s: <a href="%2$s">%3$d</a>', $name, esc_url( $url ), $query['found'] );
}
return implode( '<br>', $info );
}
/**
* Modify the query arguments of the users table query.
*
* If the current user is an instructor and no `role` argument is provided will limit the query to users
* with the `instructors_assistant` and `instructor` roles.
*
* @since 3.34.0
*
* @param array $args Array of arguments to be passed to a WP_User_Query.
* @return array
*/
public function modify_query_args( $args ) {
if ( LLMS_User_Permissions::is_current_user_instructor() && empty( $args['role'] ) ) {
$args['role__in'] = array( 'instructors_assistant', 'instructor' );
}
return $args;
}
/**
* Modify the list of role "view" filter links at the top of the user table.
*
* An instructor can only manage instructors and instructor's assistants so we'll remove these links from the list
* and additionally modify the count on the "All" filter to reflect the total number of users who are visible
* to the current instructor.
*
* @since 3.34.0
*
* @param array $views Associative array of views where the key is the role name and the value is the HTML for the view link.
* @return array
*/
public function modify_views( $views ) {
if ( LLMS_User_Permissions::is_current_user_instructor() ) {
$users = count_users();
// Allow the instructor to see roles they're allowed to edit.
$all_roles = LLMS_User_Permissions::get_editable_roles();
$roles = array_merge( array( 'all', 'instructor' ), $all_roles['instructor'] );
$all = 0;
foreach ( array_keys( $views ) as $view ) {
if ( ! in_array( $view, $roles, true ) ) {
// Unset any views they're not allowed to edit.
unset( $views[ $view ] );
} elseif ( ! empty( $users['avail_roles'][ $view ] ) ) {
// Add roles they're allowed to view to the new all count.
$all += $users['avail_roles'][ $view ];
}
}
// Replace the count on the "All" link with our updated count.
$format = '<span class="count">(%s)</span>';
$views['all'] = str_replace( sprintf( $format, $users['total_users'] ), sprintf( $format, $all ), $views['all'] );
}
return $views;
}
/**
* Register custom columns
*
* @since 4.0.0
*
* @param string $output Column output value to display (defaults to empty).
* @param string $col_name Column name/id.
* @param int $user_id WP_User ID.
* @return string
*/
public function output_col( $output, $col_name, $user_id ) {
switch ( $col_name ) {
case 'llms-enrollments':
$student = llms_get_student( $user_id );
if ( $student ) {
$output = $this->get_enrollments_column_output( $student );
}
break;
case 'llms-last-login':
$last = get_user_meta( $user_id, 'llms_last_login', true );
$last = is_numeric( $last ) ? $last : strtotime( $last );
$output = $last ? date_i18n( $this->get_login_column_date_format(), $last ) : __( 'Never', 'lifterlms' );
break;
}
return $output;
}
}
return new LLMS_Admin_Users_Table();