-
-
Notifications
You must be signed in to change notification settings - Fork 50
/
user-switching.php
1644 lines (1437 loc) · 52.2 KB
/
user-switching.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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* User Switching plugin for WordPress
*
* @package user-switching
* @link https://github.com/johnbillion/user-switching
* @author John Blackbourn
* @copyright 2009-2024 John Blackbourn
* @license GPL v2 or later
*
* Plugin Name: User Switching
* Description: Instant switching between user accounts in WordPress
* Version: 1.9.1
* Plugin URI: https://wordpress.org/plugins/user-switching/
* Author: John Blackbourn
* Author URI: https://johnblackbourn.com
* Text Domain: user-switching
* Domain Path: /languages/
* Network: true
* Requires at least: 5.9
* Requires PHP: 7.4
* License URI: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* Main singleton class for the User Switching plugin.
*/
final class user_switching {
/**
* The name used to identify the application during a WordPress redirect.
*
* @var string
*/
public static string $application = 'WordPress/User Switching';
const REDIRECT_TYPE_NONE = null;
const REDIRECT_TYPE_URL = 'url';
const REDIRECT_TYPE_POST = 'post';
const REDIRECT_TYPE_TERM = 'term';
const REDIRECT_TYPE_USER = 'user';
const REDIRECT_TYPE_COMMENT = 'comment';
/**
* Sets up all the filters and actions.
*/
public function init_hooks(): void {
// Required functionality:
add_filter( 'user_has_cap', [ $this, 'filter_user_has_cap' ], 10, 4 );
add_filter( 'map_meta_cap', [ $this, 'filter_map_meta_cap' ], 10, 4 );
add_filter( 'user_row_actions', [ $this, 'filter_user_row_actions' ], 10, 2 );
add_action( 'plugins_loaded', [ $this, 'action_plugins_loaded' ], 1 );
add_action( 'init', [ $this, 'action_init' ] );
add_action( 'all_admin_notices', [ $this, 'action_admin_notices' ], 1 );
add_action( 'wp_logout', 'user_switching_clear_olduser_cookie', 10, 0 );
add_action( 'wp_login', 'user_switching_clear_olduser_cookie', 10, 0 );
// Nice-to-haves:
add_filter( 'ms_user_row_actions', [ $this, 'filter_user_row_actions' ], 10, 2 );
add_filter( 'login_message', [ $this, 'filter_login_message' ], 1 );
add_filter( 'removable_query_args', [ $this, 'filter_removable_query_args' ] );
add_action( 'wp_meta', [ $this, 'action_wp_meta' ] );
add_filter( 'plugin_row_meta', [ $this, 'filter_plugin_row_meta' ], 10, 2 );
add_action( 'wp_footer', [ $this, 'action_wp_footer' ] );
add_action( 'personal_options', [ $this, 'action_personal_options' ] );
add_action( 'admin_bar_menu', [ $this, 'action_admin_bar_menu' ], 11 );
add_action( 'shutdown', [ $this, 'action_shutdown_for_wp_die' ], 1, 0 );
// BuddyPress integration:
add_action( 'bp_member_header_actions', [ $this, 'action_bp_button' ], 11 );
add_action( 'bp_directory_members_actions', [ $this, 'action_bp_button' ], 11 );
// bbPress integration:
add_action( 'bbp_template_after_user_details_menu_items', [ $this, 'action_bbpress_button' ] );
// WooCommerce integration:
add_action( 'woocommerce_login_form_start', [ $this, 'action_woocommerce_login_form_start' ], 10, 0 );
add_action( 'woocommerce_admin_order_data_after_order_details', [ $this, 'action_woocommerce_order_details' ], 1 );
add_filter( 'woocommerce_account_menu_items', [ $this, 'filter_woocommerce_account_menu_items' ], 999 );
add_filter( 'woocommerce_get_endpoint_url', [ $this, 'filter_woocommerce_get_endpoint_url' ], 10, 2 );
add_action( 'switch_to_user', [ $this, 'forget_woocommerce_session' ] );
add_action( 'switch_back_user', [ $this, 'forget_woocommerce_session' ] );
}
/**
* Defines the names of the cookies used by User Switching.
*/
public function action_plugins_loaded(): void {
// User Switching's auth_cookie
if ( ! defined( 'USER_SWITCHING_COOKIE' ) ) {
define( 'USER_SWITCHING_COOKIE', 'wordpress_user_sw_' . COOKIEHASH );
}
// User Switching's secure_auth_cookie
if ( ! defined( 'USER_SWITCHING_SECURE_COOKIE' ) ) {
define( 'USER_SWITCHING_SECURE_COOKIE', 'wordpress_user_sw_secure_' . COOKIEHASH );
}
// User Switching's logged_in_cookie
if ( ! defined( 'USER_SWITCHING_OLDUSER_COOKIE' ) ) {
define( 'USER_SWITCHING_OLDUSER_COOKIE', 'wordpress_user_sw_olduser_' . COOKIEHASH );
}
}
/**
* Outputs the 'Switch To' link on the user editing screen if the current user has permission to switch to them.
*
* @param WP_User $user User object for this screen.
*/
public function action_personal_options( WP_User $user ): void {
$link = self::maybe_switch_url( $user );
if ( ! $link ) {
return;
}
?>
<tr class="user-switching-wrap">
<th scope="row">
<?php echo esc_html_x( 'User Switching', 'User Switching title on user profile screen', 'user-switching' ); ?>
</th>
<td>
<a id="user_switching_switcher" href="<?php echo esc_url( $link ); ?>">
<?php esc_html_e( 'Switch To', 'user-switching' ); ?>
</a>
</td>
</tr>
<?php
}
/**
* Returns whether the current logged in user is being remembered in the form of a persistent browser cookie
* (ie. they checked the 'Remember Me' check box when they logged in). This is used to persist the 'remember me'
* value when the user switches to another user.
*
* @return bool Whether the current user is being 'remembered'.
*/
public static function remember(): bool {
/** This filter is documented in wp-includes/pluggable.php */
$cookie_life = apply_filters( 'auth_cookie_expiration', 172800, get_current_user_id(), false );
$current = wp_parse_auth_cookie( '', 'logged_in' );
if ( ! $current ) {
return false;
}
// Here we calculate the expiration length of the current auth cookie and compare it to the default expiration.
// If it's greater than this, then we know the user checked 'Remember Me' when they logged in.
return ( intval( $current['expiration'] ) - time() > $cookie_life );
}
/**
* Loads localisation files and routes actions depending on the 'action' query var.
*/
public function action_init(): void {
load_plugin_textdomain( 'user-switching', false, dirname( plugin_basename( __FILE__ ) ) . '/languages' );
if ( ! isset( $_REQUEST['action'] ) ) {
return;
}
switch ( $_REQUEST['action'] ) {
// We're attempting to switch to another user:
case 'switch_to_user':
$user_id = absint( $_REQUEST['user_id'] ?? 0 );
// Check authentication:
if ( ! current_user_can( 'switch_to_user', $user_id ) ) {
wp_die( esc_html__( 'Could not switch users.', 'user-switching' ), 403 );
}
// Check intent:
check_admin_referer( "switch_to_user_{$user_id}" );
$current_user = wp_get_current_user();
$target = get_userdata( $user_id );
if ( ! $target ) {
wp_die( esc_html__( 'Could not switch users.', 'user-switching' ), 404 );
}
$duplicate = self::get_duplicated_switch( $target, $current_user );
if ( $duplicate && ! isset( $_GET['force_switch_user'] ) ) {
// Prevent Query Monitor from showing a stack trace for the wp_die() call:
// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
do_action( 'qm/cease' );
$message = sprintf(
/* Translators: 1: The name of the user who is currently switched to the target user, 2: The name of the target user, 3: Period of time (for example "5 minutes") */
__( '%1$s is currently switched to %2$s. They switched %3$s ago. Do you want to continue switching?', 'user-switching' ),
$duplicate['user']->display_name,
$target->display_name,
human_time_diff( $duplicate['login'] ),
);
$yes = sprintf(
/* Translators: %s is the name of the target user */
__( 'Yes, switch to %s', 'user-switching' ),
$target->display_name,
);
$no = __( 'No, go back', 'user-switching' );
wp_die(
sprintf(
'%1$s<br><br><a class="button" href="%2$s">%3$s</a> <a class="button" href="%4$s">%5$s</a>',
esc_html( $message ),
esc_url( add_query_arg( 'force_switch_user', '1' ) ),
esc_html( $yes ),
'javascript:history.back()',
esc_html( $no ),
),
'',
[
'response' => 409,
'back_link' => false,
],
);
}
// Switch user:
$user = switch_to_user( $target->ID, self::remember() );
if ( $user ) {
$redirect_to = self::get_redirect( $user, $current_user );
// Redirect to the dashboard or the home URL depending on capabilities:
$args = [
'user_switched' => 'true',
];
if ( $redirect_to ) {
wp_safe_redirect( add_query_arg( $args, $redirect_to ), 302, self::$application );
} elseif ( ! current_user_can( 'read' ) ) {
wp_safe_redirect( add_query_arg( $args, home_url() ), 302, self::$application );
} else {
wp_safe_redirect( add_query_arg( $args, admin_url() ), 302, self::$application );
}
exit;
} else {
wp_die( esc_html__( 'Could not switch users.', 'user-switching' ), 404 );
}
break;
// We're attempting to switch back to the originating user:
case 'switch_to_olduser':
// Fetch the originating user data:
$old_user = self::get_old_user();
if ( ! $old_user ) {
wp_die( esc_html__( 'Could not switch users.', 'user-switching' ), 400 );
}
// Check authentication:
if ( ! self::authenticate_old_user( $old_user ) ) {
wp_die( esc_html__( 'Could not switch users.', 'user-switching' ), 403 );
}
// Check intent:
check_admin_referer( "switch_to_olduser_{$old_user->ID}" );
$current_user = wp_get_current_user();
// Switch user:
if ( switch_to_user( $old_user->ID, self::remember(), false ) ) {
if ( ! empty( $_REQUEST['interim-login'] ) && function_exists( 'login_header' ) ) {
// phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
$GLOBALS['interim_login'] = 'success';
login_header( '', '' );
exit;
}
$redirect_to = self::get_redirect( $old_user, $current_user );
$args = [
'user_switched' => 'true',
'switched_back' => 'true',
];
if ( $redirect_to ) {
wp_safe_redirect( add_query_arg( $args, $redirect_to ), 302, self::$application );
} else {
wp_safe_redirect( add_query_arg( $args, admin_url( 'users.php' ) ), 302, self::$application );
}
exit;
} else {
wp_die( esc_html__( 'Could not switch users.', 'user-switching' ), 404 );
}
break;
// We're attempting to switch off the current user:
case 'switch_off':
// Check authentication:
if ( ! current_user_can( 'switch_off' ) ) {
/* Translators: "switch off" means to temporarily log out */
wp_die( esc_html__( 'Could not switch off.', 'user-switching' ), 403 );
}
$current_user = wp_get_current_user();
// Check intent:
check_admin_referer( 'switch_off' );
// Switch off:
if ( switch_off_user() ) {
$redirect_to = self::get_redirect( null, $current_user );
$args = [
'switched_off' => 'true',
];
if ( $redirect_to ) {
wp_safe_redirect( add_query_arg( $args, $redirect_to ), 302, self::$application );
} else {
wp_safe_redirect( add_query_arg( $args, home_url() ), 302, self::$application );
}
exit;
} else {
/* Translators: "switch off" means to temporarily log out */
wp_die( esc_html__( 'Could not switch off.', 'user-switching' ), 403 );
}
break;
}
}
/**
* Detects if the target user has any sessions that originated from another user switching into their account.
*
* Returns information about the first such session, if any.
*
* @param WP_User $target Target user.
* @param WP_User $ignore User to ignore when checking for duplicate switches.
* @return array|null {
* Information about the duplicate, or null if there is none.
*
* @type int $login The login time of the session that originated from another user.
* @type WP_User $user The user who switched into the target user's account.
* }
* @phpstan-return array{
* login: int,
* user: WP_User,
* }|null
*/
public static function get_duplicated_switch( WP_User $target, WP_User $ignore ): ?array {
// Fetch the user sessions for the target user:
$sessions = WP_Session_Tokens::get_instance( $target->ID );
// Determine if any of the target user's sessions originated from another user:
$other_user_sessions = array_filter(
$sessions->get_all(),
static fn ( array $session ): bool => (
isset( $session['switched_from_id'] ) && $session['switched_from_id'] !== $ignore->ID
)
);
if ( empty( $other_user_sessions ) ) {
return null;
}
$session = reset( $other_user_sessions );
$switched_from_user = get_userdata( $session['switched_from_id'] );
if ( ! $switched_from_user ) {
return null;
}
return [
'login' => $session['login'],
'user' => $switched_from_user,
];
}
/**
* Fetches the URL to redirect to for a given user (used after switching).
*
* @param WP_User $new_user Optional. The new user's WP_User object.
* @param WP_User $old_user Optional. The old user's WP_User object.
* @return string The URL to redirect to.
*/
protected static function get_redirect( ?WP_User $new_user = null, ?WP_User $old_user = null ): string {
$redirect_to = '';
$requested_redirect_to = '';
$redirect_type = self::REDIRECT_TYPE_NONE;
if ( ! empty( $_REQUEST['redirect_to'] ) ) {
// URL
$redirect_to = self::remove_query_args( wp_unslash( $_REQUEST['redirect_to'] ) );
$requested_redirect_to = wp_unslash( $_REQUEST['redirect_to'] );
$redirect_type = self::REDIRECT_TYPE_URL;
} elseif ( ! empty( $_GET['redirect_to_post'] ) ) {
// Post
$post_id = absint( $_GET['redirect_to_post'] );
$redirect_type = self::REDIRECT_TYPE_POST;
if ( is_post_publicly_viewable( $post_id ) ) {
$link = get_permalink( $post_id );
if ( is_string( $link ) ) {
$redirect_to = $link;
$requested_redirect_to = $link;
}
}
} elseif ( ! empty( $_GET['redirect_to_term'] ) ) {
// Term
$term = get_term( absint( $_GET['redirect_to_term'] ) );
$redirect_type = self::REDIRECT_TYPE_TERM;
if ( ( $term instanceof WP_Term ) && is_taxonomy_viewable( $term->taxonomy ) ) {
$link = get_term_link( $term );
if ( is_string( $link ) ) {
$redirect_to = $link;
$requested_redirect_to = $link;
}
}
} elseif ( ! empty( $_GET['redirect_to_user'] ) ) {
// User
$user = get_userdata( absint( $_GET['redirect_to_user'] ) );
$redirect_type = self::REDIRECT_TYPE_USER;
if ( $user instanceof WP_User ) {
$link = get_author_posts_url( $user->ID );
if ( is_string( $link ) ) {
$redirect_to = $link;
$requested_redirect_to = $link;
}
}
} elseif ( ! empty( $_GET['redirect_to_comment'] ) ) {
// Comment
$comment = get_comment( absint( $_GET['redirect_to_comment'] ) );
$redirect_type = self::REDIRECT_TYPE_COMMENT;
if ( $comment instanceof WP_Comment ) {
if ( 'approved' === wp_get_comment_status( $comment ) ) {
$link = get_comment_link( $comment );
if ( is_string( $link ) ) {
$redirect_to = $link;
$requested_redirect_to = $link;
}
} elseif ( is_post_publicly_viewable( (int) $comment->comment_post_ID ) ) {
$link = get_permalink( (int) $comment->comment_post_ID );
if ( is_string( $link ) ) {
$redirect_to = $link;
$requested_redirect_to = $link;
}
}
}
}
if ( ! $new_user ) {
/** This filter is documented in wp-login.php */
$redirect_to = apply_filters( 'logout_redirect', $redirect_to, $requested_redirect_to, $old_user );
} else {
/** This filter is documented in wp-login.php */
$redirect_to = apply_filters( 'login_redirect', $redirect_to, $requested_redirect_to, $new_user );
}
/**
* Filters the redirect location after a user switches to another account or switches off.
*
* @since 1.7.0
*
* @param string $redirect_to The target redirect location, or an empty string if none is specified.
* @param string|null $redirect_type The redirect type, see the `user_switching::REDIRECT_*` constants.
* @param WP_User|null $new_user The user being switched to, or null if there is none.
* @param WP_User|null $old_user The user being switched from, or null if there is none.
*/
return apply_filters( 'user_switching_redirect_to', $redirect_to, $redirect_type, $new_user, $old_user );
}
/**
* Displays the 'Switched to {user}' and 'Switch back to {user}' messages in the admin area.
*/
public function action_admin_notices(): void {
$user = wp_get_current_user();
$old_user = self::get_old_user();
if ( $old_user ) {
$switched_locale = false;
$lang_attr = '';
$locale = get_user_locale( $old_user );
$switched_locale = switch_to_locale( $locale );
$lang_attr = str_replace( '_', '-', $locale );
?>
<div id="user_switching" class="updated notice notice-success is-dismissible">
<?php
if ( $lang_attr ) {
printf(
'<p lang="%s">',
esc_attr( $lang_attr )
);
} else {
echo '<p>';
}
?>
<span class="dashicons dashicons-admin-users" style="color:#56c234" aria-hidden="true"></span>
<?php
$message = '';
$just_switched = isset( $_GET['user_switched'] );
if ( $just_switched ) {
$message = esc_html( self::switched_to_message( $user ) );
}
$switch_back_url = add_query_arg( [
'redirect_to' => rawurlencode( self::current_url() ),
], self::switch_back_url( $old_user ) );
$message .= sprintf(
' <a href="%s">%s</a>.',
esc_url( $switch_back_url ),
esc_html( self::switch_back_message( $old_user ) )
);
/**
* Filters the contents of the message that's displayed to switched users in the admin area.
*
* @since 1.1.0
*
* @param string $message The message displayed to the switched user.
* @param WP_User $user The current user object.
* @param WP_User $old_user The old user object.
* @param string $switch_back_url The switch back URL.
* @param bool $just_switched Whether the user made the switch on this page request.
*/
$message = apply_filters( 'user_switching_switched_message', $message, $user, $old_user, $switch_back_url, $just_switched );
echo wp_kses( $message, [
'a' => [
'href' => [],
],
] );
?>
</p>
</div>
<?php
if ( $switched_locale ) {
restore_previous_locale();
}
} elseif ( isset( $_GET['user_switched'] ) ) {
?>
<div id="user_switching" class="updated notice notice-success is-dismissible">
<p>
<?php
if ( isset( $_GET['switched_back'] ) ) {
echo esc_html( self::switched_back_message( $user ) );
} else {
echo esc_html( self::switched_to_message( $user ) );
}
?>
</p>
</div>
<?php
}
}
/**
* Validates the old user cookie and returns its user data.
*
* @return false|WP_User False if there's no old user cookie or it's invalid, WP_User object if it's present and valid.
*/
public static function get_old_user() {
$cookie = user_switching_get_olduser_cookie();
if ( ! empty( $cookie ) ) {
$old_user_id = wp_validate_auth_cookie( $cookie, 'logged_in' );
if ( $old_user_id ) {
return get_userdata( $old_user_id );
}
}
return false;
}
/**
* Authenticates an old user by verifying the latest entry in the auth cookie.
*
* @param WP_User $user A WP_User object (usually from the logged_in cookie).
* @return bool Whether verification with the auth cookie passed.
*/
public static function authenticate_old_user( WP_User $user ): bool {
$cookie = user_switching_get_auth_cookie();
if ( ! empty( $cookie ) ) {
if ( self::secure_auth_cookie() ) {
$scheme = 'secure_auth';
} else {
$scheme = 'auth';
}
$old_user_id = wp_validate_auth_cookie( end( $cookie ), $scheme );
if ( $old_user_id ) {
return ( $user->ID === $old_user_id );
}
}
return false;
}
/**
* Adds a 'Switch back to {user}' link to the account menu, and a `Switch To` link to the user edit menu.
*
* @param WP_Admin_Bar $wp_admin_bar The admin bar object.
*/
public function action_admin_bar_menu( WP_Admin_Bar $wp_admin_bar ): void {
if ( ! is_admin_bar_showing() ) {
return;
}
if ( $wp_admin_bar->get_node( 'user-actions' ) ) {
$parent = 'user-actions';
} else {
return;
}
$old_user = self::get_old_user();
if ( $old_user ) {
$wp_admin_bar->add_node( [
'parent' => $parent,
'id' => 'switch-back',
'title' => esc_html( self::switch_back_message( $old_user ) ),
'href' => add_query_arg( [
'redirect_to' => rawurlencode( self::current_url() ),
], self::switch_back_url( $old_user ) ),
] );
}
if ( current_user_can( 'switch_off' ) ) {
$url = self::switch_off_url();
$redirect_to = is_admin() ? self::get_admin_redirect_to() : [
'redirect_to' => rawurlencode( self::current_url() ),
];
if ( is_array( $redirect_to ) ) {
$url = add_query_arg( $redirect_to, $url );
}
$wp_admin_bar->add_node( [
'parent' => $parent,
'id' => 'switch-off',
/* Translators: "switch off" means to temporarily log out */
'title' => esc_html__( 'Switch Off', 'user-switching' ),
'href' => $url,
] );
}
if ( ! is_admin() && is_author() && ( get_queried_object() instanceof WP_User ) ) {
if ( $old_user ) {
$wp_admin_bar->add_node( [
'parent' => 'edit',
'id' => 'author-switch-back',
'title' => esc_html( self::switch_back_message( $old_user ) ),
'href' => add_query_arg( [
'redirect_to' => rawurlencode( self::current_url() ),
], self::switch_back_url( $old_user ) ),
] );
} elseif ( current_user_can( 'switch_to_user', get_queried_object_id() ) ) {
$wp_admin_bar->add_node( [
'parent' => 'edit',
'id' => 'author-switch-to',
'title' => esc_html__( 'Switch To', 'user-switching' ),
'href' => add_query_arg( [
'redirect_to' => rawurlencode( self::current_url() ),
], self::switch_to_url( get_queried_object() ) ),
] );
}
}
}
/**
* Adds a 'Switch back to {user}' link to access denied messages within the admin area.
*
* Note that this doesn't appear for the "You need a higher level of permission" errors
* because they use a standard `wp_die()` call rather than `admin_page_access_denied`.
*/
public function action_shutdown_for_wp_die(): void {
if ( ! did_action( 'admin_page_access_denied' ) ) {
return;
}
$old_user = self::get_old_user();
if ( ! ( $old_user instanceof WP_User ) ) {
return;
}
$url = add_query_arg( [
'redirect_to' => rawurlencode( self::current_url() ),
], self::switch_back_url( $old_user ) );
printf(
'<p style="%s" id="user_switching_wp_die"><a href="%s">%s</a></p>',
'border-top: 1px solid #dadada; margin-top: 3em; padding-top: 2em',
esc_url( $url ),
esc_html( self::switch_back_message( $old_user ) )
);
?>
<script>
// Move the switch back link so it's within the wp_die message container.
document.addEventListener( 'DOMContentLoaded', function() {
document.querySelector( '.wp-die-message' ).appendChild(
document.getElementById( 'user_switching_wp_die' )
);
} );
</script>
<?php
}
/**
* Returns a context-aware redirect parameter for use when switching off in the admin area.
*
* This is used to redirect the user to the URL of the item they're editing at the time.
*
* @return ?array<string, int>
*/
public static function get_admin_redirect_to(): ?array {
if ( ! empty( $_GET['post'] ) ) {
// Post
return [
'redirect_to_post' => intval( $_GET['post'] ),
];
} elseif ( ! empty( $_GET['tag_ID'] ) ) {
// Term
return [
'redirect_to_term' => intval( $_GET['tag_ID'] ),
];
} elseif ( ! empty( $_GET['user_id'] ) ) {
// User
return [
'redirect_to_user' => intval( $_GET['user_id'] ),
];
} elseif ( ! empty( $_GET['c'] ) ) {
// Comment
return [
'redirect_to_comment' => intval( $_GET['c'] ),
];
}
return null;
}
/**
* Adds a 'Switch back to {user}' link to the Meta sidebar widget.
*/
public function action_wp_meta(): void {
$old_user = self::get_old_user();
if ( $old_user instanceof WP_User ) {
$url = add_query_arg( [
'redirect_to' => rawurlencode( self::current_url() ),
], self::switch_back_url( $old_user ) );
printf(
'<li id="user_switching_switch_on"><a href="%s">%s</a></li>',
esc_url( $url ),
esc_html( self::switch_back_message( $old_user ) )
);
}
}
/**
* Adds a 'Switch back to {user}' link to the WordPress footer if the admin toolbar isn't showing.
*/
public function action_wp_footer(): void {
if ( is_admin_bar_showing() || did_action( 'wp_meta' ) ) {
return;
}
/**
* Allows the 'Switch back to {user}' link in the WordPress footer to be disabled.
*
* @since 1.5.5
*
* @param bool $show_in_footer Whether to show the 'Switch back to {user}' link in footer.
*/
if ( ! apply_filters( 'user_switching_in_footer', true ) ) {
return;
}
$old_user = self::get_old_user();
if ( $old_user instanceof WP_User ) {
$url = add_query_arg( [
'redirect_to' => rawurlencode( self::current_url() ),
], self::switch_back_url( $old_user ) );
printf(
'<p id="user_switching_switch_on" style="%s"><a href="%s" style="%s">%s</a></p>',
'position: fixed; bottom: 40px; padding: 0; margin: 0; left: 10px; font-size: 13px; z-index:99999;',
esc_url( $url ),
'padding: 8px 10px; background: #fff; color: #3858e9;',
esc_html( self::switch_back_message( $old_user ) )
);
}
}
/**
* Adds a 'Switch back to {user}' link to the WordPress login screen.
*
* @param string $message The login screen message.
* @return string The login screen message.
*/
public function filter_login_message( string $message ): string {
$old_user = self::get_old_user();
if ( $old_user instanceof WP_User ) {
$url = self::switch_back_url( $old_user );
if ( ! empty( $_REQUEST['interim-login'] ) ) {
$url = add_query_arg( [
'interim-login' => '1',
], $url );
} elseif ( ! empty( $_REQUEST['redirect_to'] ) ) {
$url = add_query_arg( [
'redirect_to' => rawurlencode( wp_unslash( $_REQUEST['redirect_to'] ) ),
], $url );
}
$message .= '<p class="message" id="user_switching_switch_on">';
$message .= '<span class="dashicons dashicons-admin-users" style="color:#56c234" aria-hidden="true"></span> ';
$message .= sprintf(
'<a href="%1$s" onclick="window.location.href=\'%1$s\';return false;">%2$s</a>',
esc_url( $url ),
esc_html( self::switch_back_message( $old_user ) )
);
$message .= '</p>';
}
return $message;
}
/**
* Adds a 'Switch To' link to each list of user actions on the Users screen.
*
* @param array<string,string> $actions Array of actions to display for this user row.
* @param WP_User $user The user object displayed in this row.
* @return array<string,string> Array of actions to display for this user row.
*/
public function filter_user_row_actions( array $actions, WP_User $user ): array {
$link = self::maybe_switch_url( $user );
if ( ! $link ) {
return $actions;
}
$actions['switch_to_user'] = sprintf(
'<a href="%s">%s</a>',
esc_url( $link ),
esc_html__( 'Switch To', 'user-switching' )
);
return $actions;
}
/**
* Adds a 'Switch To' link to each member's profile page and profile listings in BuddyPress.
*/
public function action_bp_button(): void {
$user = null;
if ( bp_is_user() ) {
$user = get_userdata( bp_displayed_user_id() );
} elseif ( bp_is_members_directory() ) {
$user = get_userdata( bp_get_member_user_id() );
}
if ( ! $user ) {
return;
}
$link = self::maybe_switch_url( $user );
if ( ! $link ) {
return;
}
if ( function_exists( 'bp_members_get_user_url' ) ) {
$redirect_to = bp_members_get_user_url( $user->ID );
} elseif ( function_exists( 'bp_core_get_user_domain' ) ) {
$redirect_to = bp_core_get_user_domain( $user->ID );
} else {
$redirect_to = home_url();
}
$link = add_query_arg( [
'redirect_to' => rawurlencode( $redirect_to ),
], $link );
$components = array_keys( buddypress()->active_components );
echo bp_get_button( [
'id' => 'user_switching',
'component' => reset( $components ),
'link_href' => esc_url( $link ),
'link_text' => esc_html__( 'Switch To', 'user-switching' ),
'wrapper_id' => 'user_switching_switch_to',
] );
}
/**
* Adds a 'Switch To' link to each member's profile page in bbPress.
*/
public function action_bbpress_button(): void {
$user = get_userdata( bbp_get_user_id() );
if ( ! $user ) {
return;
}
$link = self::maybe_switch_url( $user );
if ( ! $link ) {
return;
}
$link = add_query_arg( [
'redirect_to' => rawurlencode( bbp_get_user_profile_url( $user->ID ) ),
], $link );
echo '<ul id="user_switching_switch_to">';
printf(
'<li><a href="%s">%s</a></li>',
esc_url( $link ),
esc_html__( 'Switch To', 'user-switching' )
);
echo '</ul>';
}
/**
* Filters the array of row meta for each plugin in the Plugins list table.
*
* @param array<int,string> $plugin_meta An array of the plugin row's meta data.
* @param string $plugin_file Path to the plugin file relative to the plugins directory.
* @return array<int,string> An array of the plugin row's meta data.
*/
public function filter_plugin_row_meta( array $plugin_meta, $plugin_file ): array {
if ( 'user-switching/user-switching.php' !== $plugin_file ) {
return $plugin_meta;
}
$plugin_meta[] = sprintf(
'<a href="%1$s"><span class="dashicons dashicons-star-filled" aria-hidden="true" style="font-size:14px;line-height:1.3"></span>%2$s</a>',
'https://github.com/sponsors/johnbillion',
esc_html_x( 'Sponsor', 'verb', 'user-switching' )
);
return $plugin_meta;
}
/**
* Filters the list of query arguments which get removed from admin area URLs in WordPress.
*
* @link https://core.trac.wordpress.org/ticket/23367
*
* @param array<int,string> $args Array of removable query arguments.
* @return array<int,string> Updated array of removable query arguments.
*/
public function filter_removable_query_args( array $args ): array {
return array_merge( $args, [
'user_switched',
'switched_off',
'switched_back',
] );
}
/**
* Returns the switch to or switch back URL for a given user.
*
* @param WP_User $user The user to be switched to.
* @return string|false The required URL, or false if there's no old user or the user doesn't have the required capability.
*/
public static function maybe_switch_url( WP_User $user ) {
$old_user = self::get_old_user();
if ( $old_user && ( $old_user->ID === $user->ID ) ) {
return self::switch_back_url( $old_user );
} elseif ( current_user_can( 'switch_to_user', $user->ID ) ) {
return self::switch_to_url( $user );
} else {
return false;
}
}
/**
* Returns the nonce-secured URL needed to switch to a given user ID.
*
* @param WP_User $user The user to be switched to.
* @return string The required URL.
*/