BP_Core_Members_Switching
BuddyBoss Member Switching class
Description
Source
File: bp-members/classes/class-bp-core-members-switching.php
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 | class BP_Core_Members_Switching { /** * The name used to identify the application during a WordPress redirect. * * @var string */ public static $application = 'BuddyBoss/Members Switching'; /** * Sets up all the filters and actions. * @since BuddyBoss 1.0.0 */ public function init_hooks() { // Required functionality: add_filter( 'user_has_cap', array( $this, 'filter_user_has_cap' ), 10, 4 ); add_filter( 'map_meta_cap', array( $this, 'filter_map_meta_cap' ), 10, 4 ); add_filter( 'user_row_actions', array( $this, 'filter_user_row_actions' ), 10, 2 ); add_action( 'plugins_loaded', array( $this, 'action_plugins_loaded' ) ); add_action( 'init', array( $this, 'action_init' ), 11 ); add_action( 'all_admin_notices', array( $this, 'action_admin_notices' ), 1 ); add_action( 'wp_logout', 'bp_member_switching_clear_olduser_cookie' ); add_action( 'wp_login', 'bp_member_switching_clear_olduser_cookie' ); // Nice-to-haves: add_filter( 'ms_user_row_actions', array( $this, 'filter_user_row_actions' ), 10, 2 ); add_filter( 'login_message', array( $this, 'filter_login_message' ), 1 ); add_filter( 'removable_query_args', array( $this, 'filter_removable_query_args' ) ); add_action( 'wp_meta', array( $this, 'action_wp_meta' ) ); add_action( 'admin_footer', array( $this, 'action_admin_footer' ) ); add_action( 'personal_options', array( $this, 'action_personal_options' ) ); add_action( 'admin_bar_menu', array( $this, 'action_admin_bar_menu' ), 100 ); add_action( 'bbp_template_after_user_details', array( $this, 'action_bbpress_button' ) ); add_filter( 'show_admin_bar', array( $this, 'filter_show_admin_bar' ), 999, 1 ); } /** * Defines the names of the cookies used by Member Switching. * * @since BuddyBoss 1.0.0 */ public function action_plugins_loaded() { // Member Switching's auth_cookie if ( ! defined( 'BP_MEMBER_SWITCHING_COOKIE' ) ) { define( 'BP_MEMBER_SWITCHING_COOKIE', 'buddyboss_user_sw_' . COOKIEHASH ); } // Member Switching's secure_auth_cookie if ( ! defined( 'BP_MEMBER_SWITCHING_SECURE_COOKIE' ) ) { define( 'BP_MEMBER_SWITCHING_SECURE_COOKIE', 'buddyboss_user_sw_secure_' . COOKIEHASH ); } // Member Switching's logged_in_cookie if ( ! defined( 'BP_MEMBER_SWITCHING_OLDUSER_COOKIE' ) ) { define( 'BP_MEMBER_SWITCHING_OLDUSER_COOKIE', 'buddyboss_user_sw_olduser_' . COOKIEHASH ); } } /** * Outputs the 'Switch To' link on the user editing screen if the current user has permission to switch to them. * * @since BuddyBoss 1.0.0 * * @param WP_User $user User object for this screen. */ public function action_personal_options( WP_User $user ) { $link = self::maybe_switch_url( $user ); if ( ! $link ) { return; } ?> <tr> <th scope="row"><?php echo esc_html__( 'Member Switching', 'buddyboss' ); ?></th> <td><a href="<?php echo esc_url( $link ); ?>"><?php esc_html_e( 'Switch To', 'buddyboss' ); ?></a> </td> </tr> <?php } /** * Returns whether or not 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. * * @since BuddyBoss 1.0.0 * @return bool Whether the current user is being 'remembered' or not. */ public static function remember() { /** 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' ); // 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 ( ( $current['expiration'] - time() ) > $cookie_life ); } /** * Loads localisation files and routes actions depending on the 'action' query var. * * @since BuddyBoss 1.0.0 */ public function action_init() { if ( ! isset( $_REQUEST['action'] ) ) { return; } $current_user = ( is_user_logged_in() ) ? wp_get_current_user() : null; switch ( $_REQUEST['action'] ) { // We're attempting to switch to another user: case 'switch_to_user': if ( isset( $_REQUEST['user_id'] ) ) { $user_id = absint( $_REQUEST['user_id'] ); } else { $user_id = 0; } // Check authentication: $old_user = bp_current_member_switched(); if ( ! current_user_can( 'switch_to_user', $user_id ) && ( ! $old_user || ! user_can( $old_user, 'switch_to_user' ) ) ) { wp_die( esc_html__( 'Could not switch users.', 'buddyboss' ) ); } // Check intent: check_admin_referer( "switch_to_user_{$user_id}" ); // Switch user: $user = bp_member_switch_to( $user_id, self::remember() ); if ( $user ) { $redirect_to = $_GET['redirect_to'] ?: self::get_redirect( $user, $current_user ); // Redirect to the dashboard or the home URL depending on capabilities: $args = array( '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.', 'buddyboss' ) ); } 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.', 'buddyboss' ) ); } // Check authentication: if ( ! self::authenticate_old_user( $old_user ) ) { wp_die( esc_html__( 'Could not switch users.', 'buddyboss' ) ); } // Check intent: check_admin_referer( "switch_to_olduser_{$old_user->ID}" ); // Switch user: if ( bp_member_switch_to( $old_user->ID, self::remember(), false ) ) { if ( ! empty( $_REQUEST['interim-login'] ) ) { $GLOBALS['interim_login'] = 'success'; // @codingStandardsIgnoreLine login_header( '', '' ); exit; } $redirect_to = self::get_redirect( $old_user, $current_user ); $args = array( '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.', 'buddyboss' ) ); } break; } } /** * Fetches the URL to redirect to for a given user (used after switching). * * @since BuddyBoss 1.0.0 * * @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 ) { if ( ! $new_user ) { $redirect_to = bp_core_get_user_domain( $old_user->ID ); } else { $redirect_to = bp_core_get_user_domain( $new_user->ID ); } return $redirect_to; } /** * Displays the 'Switched to {user}' and 'Switch back to {user}' messages in the admin area. * * @since BuddyBoss 1.0.0 */ public function action_admin_notices() { $user = wp_get_current_user(); $old_user = self::get_old_user(); if ( $old_user ) { ?> <div id="bp_member_switching" class="updated notice is-dismissible"> <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( sprintf( /* Translators: 1: user display name; 2: username; */ __( 'Switched to %1$s (%2$s).', 'buddyboss' ), $user->display_name, $user->user_login ) ); } $switch_back_url = add_query_arg( array( 'redirect_to' => urlencode( self::current_url() ), ), self::switch_back_url( $old_user ) ); $message .= sprintf( ' <a href="%s">%s</a>.', esc_url( $switch_back_url ), esc_html( sprintf( /* Translators: 1: user display name; 2: username; */ __( 'Switch back to %1$s (%2$s)', 'buddyboss' ), $old_user->display_name, $old_user->user_login ) ) ); /** * Filters the contents of the message that's displayed to switched users in the admin area. * * @since BuddyBoss 1.0.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( 'bp_member_switching_switched_message', $message, $user, $old_user, $switch_back_url, $just_switched ); echo $message; // WPCS: XSS ok. ?> </p> </div> <?php } elseif ( isset( $_GET['user_switched'] ) ) { ?> <div id="bp_member_switching" class="updated notice is-dismissible"> <p> <?php if ( isset( $_GET['switched_back'] ) ) { echo esc_html( sprintf( /* Translators: 1: user display name; 2: username; */ __( 'Switched back to %1$s (%2$s).', 'buddyboss' ), $user->display_name, $user->user_login ) ); } else { echo esc_html( sprintf( /* Translators: 1: user display name; 2: username; */ __( 'Switched to %1$s (%2$s).', 'buddyboss' ), $user->display_name, $user->user_login ) ); } ?> </p> </div> <?php } } /** * Validates the old user cookie and returns its user data. * * @since BuddyBoss 1.0.0 * * @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 = bp_member_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. * * @since BuddyBoss 1.0.0 * * @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 ) { $cookie = bp_member_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 in WordPress' admin bar. * * @since BuddyBoss 1.0.0 * * @param WP_Admin_Bar $wp_admin_bar The admin bar object. */ public function action_admin_bar_menu( WP_Admin_Bar $wp_admin_bar ) { if ( ! function_exists( 'is_admin_bar_showing' ) ) { return; } if ( ! is_admin_bar_showing() ) { return; } $old_user = self::get_old_user(); if ( $old_user ) { $wp_admin_bar->add_menu( array( 'parent' => 'top-secondary', 'id' => 'switch-back', 'title' => esc_html( sprintf( __( 'Switch back to Admin', 'buddyboss' ), $old_user->display_name, $old_user->user_login ) ), 'href' => add_query_arg( array( 'redirect_to' => urlencode( self::current_url() ), ), self::switch_back_url( $old_user ) ), ) ); } } /** * Adds a 'Switch back to {user}' link to the Meta sidebar widget. * * @since BuddyBoss 1.0.0 */ public function action_wp_meta() { $old_user = self::get_old_user(); if ( $old_user instanceof WP_User ) { $link = sprintf( /* Translators: 1: user display name; 2: username; */ __( 'Switch back to %1$s (%2$s)', 'buddyboss' ), $old_user->display_name, $old_user->user_login ); $url = add_query_arg( array( 'redirect_to' => urlencode( self::current_url() ), ), self::switch_back_url( $old_user ) ); echo '<li id="bp_member_switching_switch_on"><a href="' . esc_url( $url ) . '">' . esc_html( $link ) . '</a></li>'; } } /** * Adds a 'Switch back to {user}' link to the WordPress footer if the admin toolbar isn't showing. * * @since BuddyBoss 1.0.0 */ public function action_admin_footer() { if ( ! function_exists( 'is_admin_bar_showing' ) ) { return; } if ( ! is_admin_bar_showing() ) { return; } $old_user = self::get_old_user(); if ( $old_user instanceof WP_User ) { $colors = self::admin_bar_link_color_scheme(); if ( isset( $colors['background'] ) && isset( $colors['color'] ) ) { ?> <style> /* Member Switching */ #wpadminbar #wp-admin-bar-top-secondary li#wp-admin-bar-switch-back a { background: <?php echo $colors['background'] ?>; color: <?php echo $colors['color'] ?>;; } </style> <?php } } } /** * Adds a 'Switch back to {user}' link to the WordPress login screen. * * @since BuddyBoss 1.0.0 * * @param string $message The login screen message. * * @return string The login screen message. */ public function filter_login_message( $message ) { $old_user = self::get_old_user(); if ( $old_user instanceof WP_User ) { $link = sprintf( /* Translators: 1: user display name; 2: username; */ __( 'Switch back to %1$s (%2$s)', 'buddyboss' ), $old_user->display_name, $old_user->user_login ); $url = self::switch_back_url( $old_user ); if ( ! empty( $_REQUEST['interim-login'] ) ) { $url = add_query_arg( array( 'interim-login' => '1', ), $url ); } elseif ( ! empty( $_REQUEST['redirect_to'] ) ) { $url = add_query_arg( array( 'redirect_to' => urlencode( wp_unslash( $_REQUEST['redirect_to'] ) ), // WPCS: sanitization ok ), $url ); } $message .= '<p class="message" id="bp_member_switching_switch_on">'; $message .= '<span class="dashicons dashicons-admin-users" style="color:#56c234" aria-hidden="true"></span> '; $message .= '<a href="' . esc_url( $url ) . '" onclick="window.location.href=\'' . esc_url( $url ) . '\';return false;">' . esc_html( $link ) . '</a>'; $message .= '</p>'; } return $message; } /** * Adds a 'Switch To' link to each list of user actions on the Users screen. * * @since BuddyBoss 1.0.0 * * @param string[] $actions The actions to display for this user row. * @param WP_User $user The user object displayed in this row. * * @return string[] The actions to display for this user row. */ public function filter_user_row_actions( array $actions, WP_User $user ) { $link = self::maybe_switch_url( $user ); if ( ! $link ) { return $actions; } $actions['switch_to_user'] = '<a href="' . esc_url( $link ) . '">' . esc_html__( 'Switch To', 'buddyboss' ) . '</a>'; return $actions; } /** * Adds a 'Switch To' link to each member's profile page and profile listings in BuddyPress. * * @since BuddyBoss 1.0.0 * */ public function action_bp_button() { $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; } $link = add_query_arg( array( 'redirect_to' => urlencode( bp_core_get_user_domain( $user->ID ) ), ), $link ); $components = array_keys( buddypress()->active_components ); echo bp_get_button( array( 'id' => 'bp_member_switching', 'component' => reset( $components ), 'link_href' => esc_url( $link ), 'link_text' => esc_html__( 'Switch To', 'buddyboss' ), 'wrapper_id' => 'bp_member_switching_switch_to', ) ); } /** * Adds a 'Switch To' link to each member's profile page in bbPress. * * @since BuddyBoss 1.0.0 * */ public function action_bbpress_button() { $user = get_userdata( bbp_get_user_id() ); if ( ! $user ) { return; } $link = self::maybe_switch_url( $user ); if ( ! $link ) { return; } $link = add_query_arg( array( 'redirect_to' => urlencode( bbp_get_user_profile_url( $user->ID ) ), ), $link ); ?> <ul id="bp_member_switching_switch_to"> <li><a href="<?php echo esc_url( $link ); ?>"><?php esc_html_e( 'Switch To', 'buddyboss' ); ?></a> </li> </ul> <?php } /** * Filters the list of query arguments which get removed from admin area URLs in WordPress. * * * @since BuddyBoss 1.0.0 * * @param string[] $args List of removable query arguments. * * @return string[] Updated list of removable query arguments. */ public function filter_removable_query_args( array $args ) { return array_merge( $args, array( '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 || bp_is_my_profile() ) ) { return self::switch_back_url( $old_user ); } elseif ( current_user_can( 'switch_to_user', $user->ID ) || user_can( $old_user, '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. * * @since BuddyBoss 1.0.0 * * @param WP_User $user The user to be switched to. * * @return string The required URL. */ public static function switch_to_url( WP_User $user ) { return wp_nonce_url( add_query_arg( array( 'action' => 'switch_to_user', 'user_id' => $user->ID, 'nr' => 1, ), wp_login_url() ), "switch_to_user_{$user->ID}" ); } /** * Returns the nonce-secured URL needed to switch back to the originating user. * * @since BuddyBoss 1.0.0 * * @param WP_User $user The old user. * * @return string The required URL. */ public static function switch_back_url( WP_User $user ) { return wp_nonce_url( add_query_arg( array( 'action' => 'switch_to_olduser', 'nr' => 1, ), wp_login_url() ), "switch_to_olduser_{$user->ID}" ); } /** * Returns the nonce-secured URL needed to switch off the current user. * * @since BuddyBoss 1.0.0 * * @param WP_User $user The user to be switched off. * * @return string The required URL. */ public static function switch_off_url( WP_User $user ) { return wp_nonce_url( add_query_arg( array( 'action' => 'switch_off', 'nr' => 1, ), wp_login_url() ), "switch_off_{$user->ID}" ); } /** * Returns the current URL. * * @since BuddyBoss 1.0.0 * * @return string The current URL. */ public static function current_url() { return ( is_ssl() ? 'https://' : 'http://' ) . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI']; // @codingStandardsIgnoreLine } /** * Removes a list of common confirmation-style query args from a URL. * * @since BuddyBoss 1.0.0 * * @param string $url A URL. * * @return string The URL with query args removed. */ public static function remove_query_args( $url ) { if ( function_exists( 'wp_removable_query_args' ) ) { $url = remove_query_arg( wp_removable_query_args(), $url ); } return $url; } /** * Returns whether or not Member Switching's equivalent of the 'logged_in' cookie should be secure. * * This is used to set the 'secure' flag on the old user cookie, for enhanced security. * * @since BuddyBoss 1.0.0 * * * @return bool Should the old user cookie be secure? */ public static function secure_olduser_cookie() { return ( is_ssl() && ( 'https' === parse_url( home_url(), PHP_URL_SCHEME ) ) ); } /** * Returns whether or not Member Switching's equivalent of the 'auth' cookie should be secure. * * This is used to determine whether to set a secure auth cookie or not. * * @since BuddyBoss 1.0.0 * * @return bool Should the auth cookie be secure? */ public static function secure_auth_cookie() { return ( is_ssl() && ( 'https' === parse_url( wp_login_url(), PHP_URL_SCHEME ) ) ); } /** * Returns background and color value base on current color scheme * * @since BuddyBoss 1.0.0 * * @return array Should the array contain background and text color */ public static function admin_bar_link_color_scheme() { $current_color = get_user_option( 'admin_color' ); switch ( $current_color ) { case 'fresh': return [ 'background' => '#0073aa', 'color' => '#fff' ]; break; case 'light': return [ 'background' => '#888', 'color' => '#fff' ]; break; case 'blue': return [ 'background' => '#096484', 'color' => '#fff' ]; break; case 'coffee': return [ 'background' => '#c7a589', 'color' => '#fff' ]; break; case 'ectoplasm': return [ 'background' => '#a3b745', 'color' => '#fff' ]; case 'midnight': return [ 'background' => '#e14d43', 'color' => '#fff' ]; case 'ocean': return [ 'background' => '#9ebaa0', 'color' => '#fff' ]; case 'sunrise': return [ 'background' => '#dd823b', 'color' => '#fff' ]; break; } } /** * Filters a user's capabilities so they can be altered at runtime. * * This is used to: * - Grant the 'bp_member_switch_to' capability to the user if they have the ability to edit the user they're trying to * switch to (and that user is not themselves). * - Grant the 'switch_off' capability to the user if they can edit other users. * * Important: This does not get called for Super Admins. See filter_map_meta_cap() below. * * @since BuddyBoss 1.0.0 * * @param bool[] $user_caps Array of key/value pairs where keys represent a capability name and boolean values * represent whether the user has that capability. * @param string[] $required_caps Required primitive capabilities for the requested capability. * @param array $args { * Arguments that accompany the requested capability check. * * @type string $0 Requested capability. * @type int $1 Concerned user ID. * @type mixed ...$2 Optional second and further parameters. * } * * @param WP_User $user Concerned user object. * * @return bool[] Concerned user's capabilities. */ public function filter_user_has_cap( array $user_caps, array $required_caps, array $args, WP_User $user ) { if ( 'switch_to_user' === $args[0] ) { if ( array_key_exists( 'switch_users', $user_caps ) ) { $user_caps['switch_to_user'] = $user_caps['switch_users']; return $user_caps; } $user_caps['switch_to_user'] = ( user_can( $user->ID, 'edit_user', $args[2] ) && ( $args[2] !== $user->ID ) ); } elseif ( 'switch_off' === $args[0] ) { if ( array_key_exists( 'switch_users', $user_caps ) ) { $user_caps['switch_off'] = $user_caps['switch_users']; return $user_caps; } $user_caps['switch_off'] = user_can( $user->ID, 'edit_users' ); } return $user_caps; } /** * Filters the required primitive capabilities for the given primitive or meta capability. * * This is used to: * - Add the 'do_not_allow' capability to the list of required capabilities when a Super Admin is trying to switch * to themselves. * * It affects nothing else as Super Admins can do everything by default. * * @since BuddyBoss 1.0.0 * * @param string[] $required_caps Required primitive capabilities for the requested capability. * @param string $cap Capability or meta capability being checked. * @param int $user_id Concerned user ID. * @param array $args { * Arguments that accompany the requested capability check. * * @type mixed ...$0 Optional second and further parameters. * } * @return string[] Required capabilities for the requested action. */ public function filter_map_meta_cap( array $required_caps, $cap, $user_id, array $args ) { if ( isset( $args[0] ) && ( 'switch_to_user' === $cap ) && ( $args[0] === $user_id ) ) { $required_caps[] = 'do_not_allow'; } return $required_caps; } /** * Filter force show the admin bar while switched to the user * * @since BuddyBoss 1.0.0 * * @param $retval * * @return bool */ public function filter_show_admin_bar( $retval ) { $old_user = self::get_old_user(); if ( $old_user instanceof WP_User ) { return true; } return $retval; } /** * Singleton instance. * * @since BuddyBoss 1.0.0 * * @return BP_Core_Members_Switching Member Switching instance. */ public static function get_instance() { static $instance; if ( ! isset( $instance ) ) { $instance = new self(); } return $instance; } /** * Private class constructor. Use `get_instance()` to get the instance. * * @since BuddyBoss 1.0.0 * */ final private function __construct() { }} |
Changelog
| Version | Description |
|---|---|
| BuddyBoss 1.0.0 | Introduced. |
Methods
- __construct — Private class constructor. Use `get_instance()` to get the instance.
- action_admin_bar_menu — Adds a 'Switch back to {user}' link in WordPress' admin bar.
- action_admin_footer — Adds a 'Switch back to {user}' link to the WordPress footer if the admin toolbar isn't showing.
- action_admin_notices — Displays the 'Switched to {user}' and 'Switch back to {user}' messages in the admin area.
- action_bbpress_button — Adds a 'View As' link to each member's profile page in bbPress.
- action_bp_button — Adds a 'View As' link to each member's profile page and profile listings in BuddyPress.
- action_init — Loads localisation files and routes actions depending on the 'action' query var.
- action_personal_options — Outputs the 'View As' link on the user editing screen if the current user has permission to switch to them.
- action_plugins_loaded — Defines the names of the cookies used by Member Switching.
- action_wp_meta — Adds a 'Switch back to {user}' link to the Meta sidebar widget.
- admin_bar_link_color_scheme — Returns background and color value base on current color scheme
- authenticate_old_user — Authenticates an old user by verifying the latest entry in the auth cookie.
- current_url — Returns the current URL.
- filter_login_message — Adds a 'Switch back to {user}' link to the WordPress login screen.
- filter_map_meta_cap — Filters the required primitive capabilities for the given primitive or meta capability.
- filter_removable_query_args — Filters the list of query arguments which get removed from admin area URLs in WordPress.
- filter_show_admin_bar — Filter force show the admin bar while switched to the user
- filter_user_has_cap — Filters a user's capabilities so they can be altered at runtime.
- filter_user_row_actions — Adds a 'View As' link to each list of user actions on the Users screen.
- get_instance — Singleton instance.
- get_old_user — Validates the old user cookie and returns its user data.
- get_redirect — Fetches the URL to redirect to for a given user (used after switching).
- init_hooks — Sets up all the filters and actions.
- maybe_switch_url — Returns the switch to or switch back URL for a given user.
- remember — Returns whether or not 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.
- remove_query_args — Removes a list of common confirmation-style query args from a URL.
- secure_auth_cookie — Returns whether or not Member Switching's equivalent of the 'auth' cookie should be secure.
- secure_olduser_cookie — Returns whether or not Member Switching's equivalent of the 'logged_in' cookie should be secure.
- switch_back_url — Returns the nonce-secured URL needed to switch back to the originating user.
- switch_off_url — Returns the nonce-secured URL needed to switch off the current user.
- switch_to_url — Returns the nonce-secured URL needed to switch to a given user ID.
Questions?
We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.