Changeset 13105 for trunk/src/bp-members/bp-members-template.php
- Timestamp:
- 09/11/2021 05:26:17 PM (4 years ago)
- File:
-
- 1 edited
-
trunk/src/bp-members/bp-members-template.php (modified) (85 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/src/bp-members/bp-members-template.php
r12951 r13105 6 6 * 7 7 * @package BuddyPress 8 * @subpackage Members 8 * @subpackage MembersTemplate 9 9 * @since 1.5.0 10 10 */ … … 17 17 * 18 18 * @since 2.4.0 19 *20 19 */ 21 20 function bp_profile_slug() { … … 45 44 * 46 45 * @since 1.5.0 47 *48 46 */ 49 47 function bp_members_slug() { … … 73 71 * 74 72 * @since 1.5.0 75 *76 73 */ 77 74 function bp_members_root_slug() { … … 92 89 * @since 1.5.0 93 90 * 94 * @param string $ slug Members component root slug.91 * @param string $root_slug Members component root slug. 95 92 */ 96 93 return apply_filters( 'bp_get_members_root_slug', buddypress()->members->root_slug ); … … 106 103 } 107 104 /** 108 * Get the member type base slug.105 * Get the member type URL base. 109 106 * 110 107 * The base slug is the string used as the base prefix when generating member type directory URLs. … … 117 114 */ 118 115 function bp_get_members_member_type_base() { 116 119 117 /** 120 118 * Filters the member type URL base. … … 122 120 * @since 2.3.0 123 121 * 124 * @param string $base 122 * @param string $base Base slug for the member type. 125 123 */ 126 124 return apply_filters( 'bp_members_member_type_base', _x( 'type', 'member type URL base', 'buddypress' ) ); … … 131 129 * 132 130 * @since 1.5.0 133 *134 131 */ 135 132 function bp_members_directory_permalink() { … … 160 157 * @since 2.5.0 161 158 * 162 * @param string $member_type Optional. Member type. 159 * @param string $member_type Optional. Member type. Defaults to current member type. 163 160 */ 164 161 function bp_member_type_directory_permalink( $member_type = '' ) { … … 205 202 * 206 203 * @since 1.5.0 207 *208 204 */ 209 205 function bp_signup_slug() { … … 215 211 * @since 1.5.0 216 212 * 213 * @global BuddyPress $bp The one true BuddyPress instance. 214 * 217 215 * @return string 218 216 */ … … 220 218 $bp = buddypress(); 221 219 222 if ( ! empty( $bp->pages->register->slug ) ) {220 if ( ! empty( $bp->pages->register->slug ) ) { 223 221 $slug = $bp->pages->register->slug; 224 222 } elseif ( defined( 'BP_REGISTER_SLUG' ) ) { … … 242 240 * 243 241 * @since 1.5.0 244 *245 242 */ 246 243 function bp_activate_slug() { … … 252 249 * @since 1.5.0 253 250 * 251 * @global BuddyPress $bp The one true BuddyPress instance. 252 * 254 253 * @return string 255 254 */ … … 257 256 $bp = buddypress(); 258 257 259 if ( ! empty( $bp->pages->activate->slug ) ) {258 if ( ! empty( $bp->pages->activate->slug ) ) { 260 259 $slug = $bp->pages->activate->slug; 261 260 } elseif ( defined( 'BP_ACTIVATION_SLUG' ) ) { … … 279 278 * 280 279 * @since 8.0.0 281 *282 280 */ 283 281 function bp_members_invitations_slug() { … … 313 311 * @since 7.0.0 Added `xprofile_query` parameter. Added `user_ids` parameter. 314 312 * 315 * @global object $members_template {@link BP_Members_Template}313 * @global BP_Core_Members_Template $members_template 316 314 * 317 315 * @param array|string $args { … … 440 438 * @since 2.6.0 Added the `$r` parameter 441 439 * 442 * @param bool $value Whether or not there are members to iterate over.443 * @param array$members_template Populated $members_template global.444 * @param array $r Array of arguments passed into the BP_Core_Members_Template class.440 * @param bool $value Whether or not there are members to iterate over. 441 * @param BP_Core_Members_Template $members_template Populated $members_template global. 442 * @param array $r Array of arguments passed into the BP_Core_Members_Template class. 445 443 */ 446 444 return apply_filters( 'bp_has_members', $members_template->has_members(), $members_template, $r ); … … 451 449 * 452 450 * @since 1.2.0 451 * 452 * @global BP_Core_Members_Template $members_template 453 453 * 454 454 * @return object … … 464 464 * @since 1.2.0 465 465 * 466 * @global BP_Core_Members_Template $members_template 467 * 466 468 * @return bool 467 469 */ … … 484 486 * @since 1.5.0 485 487 * 488 * @global BP_Core_Members_Template $members_template 489 * 486 490 * @return string 487 491 */ … … 489 493 global $members_template; 490 494 491 if ( empty( $members_template->type ) ) 495 if ( empty( $members_template->type ) ) { 492 496 $members_template->type = ''; 497 } 493 498 494 499 $start_num = intval( ( $members_template->pag_page - 1 ) * $members_template->pag_num ) + 1; … … 550 555 * @since 1.2.0 551 556 * 557 * @global BP_Core_Members_Template $members_template 558 * 552 559 * @return string 553 560 */ … … 569 576 * 570 577 * @since 1.2.0 571 *572 578 */ 573 579 function bp_member_user_id() { … … 579 585 * @since 1.2.0 580 586 * 581 * @return string Member ID. 587 * @global BP_Core_Members_Template $members_template 588 * 589 * @return int Member ID. 582 590 */ 583 591 function bp_get_member_user_id() { 584 592 global $members_template; 585 $member_id = isset( $members_template->member->id ) ? (int) $members_template->member->id : false; 593 594 $member_id = isset( $members_template->member->id ) 595 ? (int) $members_template->member->id 596 : 0; 586 597 587 598 /** … … 592 603 * @param int $member_id ID of the member being iterated over. 593 604 */ 594 return apply_filters( 'bp_get_member_user_id', $member_id );605 return apply_filters( 'bp_get_member_user_id', (int) $member_id ); 595 606 } 596 607 … … 610 621 * @since 1.7.0 611 622 * 623 * @global BP_Core_Members_Template $members_template 624 * 612 625 * @param array $classes Array of custom classes. 626 * 613 627 * @return string Row class of the member 614 628 */ … … 679 693 * @since 1.2.5 680 694 * 695 * @global BP_Core_Members_Template $members_template 696 * 681 697 * @return string Members nicename. 682 698 */ … … 707 723 * @since 1.2.5 708 724 * 725 * @global BP_Core_Members_Template $members_template 726 * 709 727 * @return string Member's login. 710 728 */ … … 735 753 * @since 1.2.5 736 754 * 755 * @global BP_Core_Members_Template $members_template 756 * 737 757 * @return string Member's email address. 738 758 */ … … 754 774 * 755 775 * @since 1.2.5 776 * @since 10.0.0 Updated to get member ID from `bp_get_member_user_id`. 756 777 * 757 778 * @return bool 758 779 */ 759 780 function bp_member_is_loggedin_user() { 760 global $members_template;761 781 762 782 /** … … 767 787 * @param bool $value Whether current member in the loop is logged in. 768 788 */ 769 return apply_filters( 'bp_member_is_loggedin_user', bp_loggedin_user_id() == $members_template->member->id ? true : false);789 return apply_filters( 'bp_member_is_loggedin_user', ( bp_loggedin_user_id() === bp_get_member_user_id() ) ); 770 790 } 771 791 … … 796 816 * 797 817 * @since 1.2.0 818 * 819 * @global BP_Core_Members_Template $members_template 798 820 * 799 821 * @see bp_core_fetch_avatar() For a description of arguments and … … 809 831 * @type int|bool $width Default: false. 810 832 * @type int|bool $height Default: false. 833 * @type bool $no_grav Default: false. 811 834 * @type bool $id Currently unused. 812 * @type bool $no_grav Default: false.813 835 * } 814 836 * @return string User avatar string. … … 817 839 global $members_template; 818 840 819 $fullname = !empty( $members_template->member->fullname ) ? $members_template->member->fullname : $members_template->member->display_name; 820 821 $defaults = array( 822 'type' => 'thumb', 823 'width' => false, 824 'height' => false, 825 'class' => 'avatar', 826 'id' => false, 827 'alt' => sprintf( __( 'Profile picture of %s', 'buddypress' ), $fullname ) 841 $fullname = ! empty( $members_template->member->fullname ) 842 ? $members_template->member->fullname 843 : $members_template->member->display_name; 844 845 $r = wp_parse_args( 846 $args, 847 array( 848 'type' => 'thumb', 849 'width' => false, 850 'height' => false, 851 'class' => 'avatar', 852 'id' => false, 853 'no_grav' => false, 854 // translators: %s is the full name of the user. 855 'alt' => sprintf( __( 'Profile picture of %s', 'buddypress' ), $fullname ), 856 ) 828 857 ); 829 858 830 $r = wp_parse_args( $args, $defaults ); 831 extract( $r, EXTR_SKIP ); 832 833 /** 834 * Filters a members avatar. 859 $avatar = bp_core_fetch_avatar( 860 array( 861 'email' => bp_get_member_user_email(), 862 'item_id' => bp_get_member_user_id(), 863 'type' => $r['type'], 864 'alt' => $r['alt'], 865 'no_grav' => $r['no_grav'], 866 'css_id' => $r['id'], 867 'class' => $r['class'], 868 'width' => $r['width'], 869 'height' => $r['height'], 870 ) 871 ); 872 873 /** 874 * Filters a member's avatar. 835 875 * 836 876 * @since 1.2.0 … … 840 880 * @param array $r Array of parsed arguments. See {@link bp_get_member_avatar()}. 841 881 */ 842 return apply_filters( 'bp_get_member_avatar', bp_core_fetch_avatar( array( 'item_id' => $members_template->member->id, 'type' => $type, 'alt' => $alt, 'css_id' => $id, 'class' => $class, 'width' => $width, 'height' => $height, 'email' => $members_template->member->user_email ) ), $r );882 return apply_filters( 'bp_get_member_avatar', $avatar, $r ); 843 883 } 844 884 … … 856 896 * @since 1.2.0 857 897 * 898 * @global BP_Core_Members_Template $members_template 899 * 858 900 * @return string 859 901 */ … … 876 918 * @since 1.2.0 877 919 */ 878 function bp_member_link() { echo esc_url( bp_get_member_permalink() ); } 920 function bp_member_link() { 921 echo esc_url( bp_get_member_permalink() ); 922 } 879 923 880 924 /** … … 883 927 * @since 1.2.0 884 928 */ 885 function bp_get_member_link() { return bp_get_member_permalink(); } 929 function bp_get_member_link() { 930 return bp_get_member_permalink(); 931 } 886 932 887 933 /** … … 910 956 * 911 957 * @since 1.2.0 958 * 959 * @global BP_Core_Members_Template $members_template 912 960 * 913 961 * @return string The user's fullname for display. … … 964 1012 * @since 2.7.0 Added 'relative' as a parameter to $args. 965 1013 * 1014 * @global BP_Core_Members_Template $members_template 1015 * 966 1016 * @param array $args { 967 1017 * Array of optional arguments. … … 1032 1082 * @since 1.2.0 1033 1083 * 1084 * @global BP_Core_Members_Template $members_template 1085 * 1034 1086 * @param array|string $args { 1035 1087 * Array of optional arguments. … … 1108 1160 * 1109 1161 * @since 1.2.0 1162 * 1163 * @global BP_Core_Members_Template $members_template 1110 1164 * 1111 1165 * @param array|string $args { … … 1198 1252 * @since 2.7.0 Added $args as a parameter. 1199 1253 * 1200 * @param array $args Optional. {@see bp_get_member_registered()} 1254 * @param array $args Optional. {@see bp_get_member_registered()}. 1201 1255 */ 1202 1256 function bp_member_registered( $args = array() ) { … … 1207 1261 * 1208 1262 * @since 1.2.0 1209 * @since 2.7.0 Added $args as a parameter. 1263 * @since 2.7.0 Added `$args` as a parameter. 1264 * 1265 * @global BP_Core_Members_Template $members_template 1210 1266 * 1211 1267 * @param array $args { 1212 1268 * Array of optional parameters. 1213 *1214 1269 * @type bool $relative Optional. If true, returns relative registered date. eg. registered 5 months ago. 1215 1270 * If false, returns registered date value from database. 1216 1271 * } 1217 *1218 1272 * @return string 1219 1273 */ … … 1240 1294 * 1241 1295 * @param string $registered The 'registered [x days ago]' string. 1242 */ 1243 return apply_filters( 'bp_member_registered', $registered ); 1296 * @param array $r Array of parsed arguments. 1297 */ 1298 return apply_filters( 'bp_member_registered', $registered, $r ); 1244 1299 } 1245 1300 … … 1248 1303 * 1249 1304 * @since 1.2.0 1305 * @since 10.0.0 Updated to get member ID using `bp_get_member_user_id`. 1250 1306 */ 1251 1307 function bp_member_random_profile_data() { 1252 global $members_template;1253 1254 1308 if ( bp_is_active( 'xprofile' ) ) { ?> 1255 <?php $random_data = xprofile_get_random_profile_data( $members_template->member->id, true ); ?>1309 <?php $random_data = xprofile_get_random_profile_data( bp_get_member_user_id(), true ); ?> 1256 1310 <strong><?php echo wp_filter_kses( $random_data[0]->name ) ?></strong> 1257 1311 <?php echo wp_filter_kses( $random_data[0]->value ) ?> … … 1323 1377 * @since 1.2.0 1324 1378 * 1325 * @return int1379 * @return string 1326 1380 */ 1327 1381 function bp_get_total_site_member_count() { … … 1352 1406 * 1353 1407 * @since 1.1.0 1408 * 1409 * @global BuddyPress $bp The one true BuddyPress instance. 1354 1410 * 1355 1411 * @todo Move to a back-compat file? … … 1442 1498 } 1443 1499 1444 // Init the hierarchy 1500 // Init the hierarchy. 1445 1501 $template_names = array( 1446 1502 'members/single/front-id-' . (int) $displayed_user->id . '.php', … … 1460 1516 } 1461 1517 1462 $template_names[] = 'members/single/front-member-type-' . sanitize_file_name( $displayed_user_member_type ) . '.php';1463 } 1464 1465 // Add The generic template to the end of the hierarchy 1518 $template_names[] = 'members/single/front-member-type-' . sanitize_file_name( $displayed_user_member_type ) . '.php'; 1519 } 1520 1521 // Add The generic template to the end of the hierarchy. 1466 1522 $template_names[] = 'members/single/front.php'; 1467 1523 … … 1471 1527 * @since 2.6.0 1472 1528 * 1473 * @param array $template_names Array of template paths. 1474 */ 1475 return bp_locate_template( apply_filters( 'bp_displayed_user_get_front_template', $template_names ), false, true ); 1529 * @param array $template_names Array of template paths. 1530 */ 1531 $template_names = apply_filters( 'bp_displayed_user_get_front_template', $template_names ); 1532 1533 return bp_locate_template( $template_names, false, true ); 1476 1534 } 1477 1535 … … 1491 1549 * 1492 1550 * @since 1.1.0 1551 * 1552 * @global BuddyPress $bp The one true BuddyPress instance. 1493 1553 */ 1494 1554 function bp_get_displayed_user_nav() { … … 1665 1725 * @since 1.5.0 1666 1726 * 1727 * @global BuddyPress $bp The one true BuddyPress instance. 1728 * 1667 1729 * @return string 1668 1730 */ … … 1671 1733 1672 1734 // If displayed user exists, return email address. 1673 if ( isset( $bp->displayed_user->userdata->user_email ) ) 1735 if ( isset( $bp->displayed_user->userdata->user_email ) ) { 1674 1736 $retval = $bp->displayed_user->userdata->user_email; 1675 else1737 } else { 1676 1738 $retval = ''; 1739 } 1677 1740 1678 1741 /** … … 1696 1759 */ 1697 1760 function bp_last_activity( $user_id = 0 ) { 1698 1699 /** 1700 * Filters the 'active [x days ago]' string for a user. 1701 * 1702 * @since 1.0.0 1703 * 1704 * @param string $value Formatted 'active [x days ago]' string. 1705 */ 1706 echo apply_filters( 'bp_last_activity', bp_get_last_activity( $user_id ) ); 1761 echo bp_get_last_activity( $user_id ); 1707 1762 } 1708 1763 /** … … 1758 1813 1759 1814 // Try to get displayed user. 1760 if ( empty( $name ) ) 1815 if ( empty( $name ) ) { 1761 1816 $name = bp_get_displayed_user_fullname(); 1817 } 1762 1818 1763 1819 // Fall back on logged in user. 1764 if ( empty( $name ) ) 1820 if ( empty( $name ) ) { 1765 1821 $name = bp_get_loggedin_user_fullname(); 1822 } 1766 1823 1767 1824 $fullname = (array) explode( ' ', $name ); … … 1837 1894 * @deprecated 1838 1895 */ 1839 function bp_user_link() { bp_displayed_user_domain(); } 1896 function bp_user_link() { 1897 bp_displayed_user_domain(); 1898 } 1840 1899 1841 1900 /** … … 1844 1903 * @since 1.0.0 1845 1904 */ 1846 function bp_current_user_id() { return bp_displayed_user_id(); } 1905 function bp_current_user_id() { 1906 return bp_displayed_user_id(); 1907 } 1847 1908 1848 1909 /** … … 1850 1911 * 1851 1912 * @since 1.0.0 1913 * 1914 * @global BuddyPress $bp The one true BuddyPress instance. 1852 1915 * 1853 1916 * @return string … … 1871 1934 * @since 1.0.0 1872 1935 * 1936 * @global BuddyPress $bp The one true BuddyPress instance. 1937 * 1873 1938 * @return string 1874 1939 */ … … 1899 1964 * @since 1.2.0 1900 1965 * 1966 * @global BuddyPress $bp The one true BuddyPress instance. 1967 * 1901 1968 * @return string 1902 1969 */ … … 1935 2002 * @since 1.0.0 1936 2003 * 2004 * @global BuddyPress $bp The one true BuddyPress instance. 2005 * 1937 2006 * @return string 1938 2007 */ … … 1962 2031 * 1963 2032 * @since 1.2.0 2033 * 2034 * @global BuddyPress $bp The one true BuddyPress instance. 1964 2035 * 1965 2036 * @return string … … 1996 2067 * 1997 2068 * @since 1.2.0 2069 * 2070 * @global BuddyPress $bp The one true BuddyPress instance. 1998 2071 * 1999 2072 * @return string … … 2098 2171 * 2099 2172 * @since 7.0.0 2100 * @see bp_get_member_type_list() For additional information on default arguments. 2173 * 2174 * @see bp_get_member_type_list() For additional information on default arguments. 2101 2175 * 2102 2176 * @param int $user_id User ID. … … 2111 2185 * @since 7.0.0 2112 2186 * 2113 * @param int $user_id User ID. Defaults to displayed user ID if on a member page.2114 * @param array|string $r {2187 * @param int $user_id User ID. Defaults to displayed user ID if on a member page. 2188 * @param array|string $r { 2115 2189 * Array of parameters. All items are optional. 2116 2190 * @type string $parent_element Element to wrap around the list. Defaults to 'p'. … … 2245 2319 static $has_page = false; 2246 2320 2247 if ( empty( $has_page ) ) 2321 if ( empty( $has_page ) ) { 2248 2322 $has_page = bp_get_signup_slug() && bp_locate_template( array( 'registration/register.php', 'members/register.php', 'register.php' ), false ); 2323 } 2249 2324 2250 2325 return (bool) $has_page; … … 2506 2581 * @since 2.1.0 2507 2582 * 2583 * @global WP_Network $current_site 2584 * 2508 2585 * @return string The base URL - eg, 'example.com' for site_url() example.com or www.example.com. 2509 2586 */ … … 2602 2679 * @since 1.1.0 2603 2680 * 2681 * @global BuddyPress $bp The one true BuddyPress instance. 2682 * 2604 2683 * @return string 2605 2684 */ … … 2669 2748 * @since 1.1.0 2670 2749 * 2750 * @global BuddyPress $bp The one true BuddyPress instance. 2751 * 2671 2752 * @return string 2672 2753 */ … … 2691 2772 * 2692 2773 * @since 1.1.0 2774 * 2775 * @global BuddyPress $bp The one true BuddyPress instance. 2693 2776 * 2694 2777 * @see bp_core_fetch_avatar() for description of arguments. … … 2707 2790 2708 2791 $defaults = array( 2709 'size' => bp_core_avatar_full_width(),2792 'size' => bp_core_avatar_full_width(), 2710 2793 'class' => 'avatar', 2711 'alt' => __( 'Your Profile Photo', 'buddypress' )2794 'alt' => __( 'Your Profile Photo', 'buddypress' ), 2712 2795 ); 2713 2796 … … 2715 2798 extract( $r, EXTR_SKIP ); 2716 2799 2800 $signup_avatar_dir = bp_get_signup_avatar_dir_value(); 2801 2717 2802 // Avatar DIR is found. 2718 if ( $signup_avatar_dir = bp_get_signup_avatar_dir_value()) {2803 if ( $signup_avatar_dir ) { 2719 2804 $gravatar_img = bp_core_fetch_avatar( array( 2720 2805 'item_id' => $signup_avatar_dir, … … 2725 2810 'height' => $size, 2726 2811 'alt' => $alt, 2727 'class' => $class 2812 'class' => $class, 2728 2813 ) ); 2729 2814 … … 2732 2817 2733 2818 // Set default gravatar type. 2734 if ( empty( $bp->grav_default->user ) ) 2819 if ( empty( $bp->grav_default->user ) ) { 2735 2820 $default_grav = 'wavatar'; 2736 elseif ( 'mystery' == $bp->grav_default->user )2821 } elseif ( 'mystery' === $bp->grav_default->user ) { 2737 2822 $default_grav = $bp->plugin_url . 'bp-core/images/mystery-man.jpg'; 2738 else2823 } else { 2739 2824 $default_grav = $bp->grav_default->user; 2825 } 2740 2826 2741 2827 /** … … 2780 2866 */ 2781 2867 function bp_get_signup_allowed() { 2868 2782 2869 /** 2783 2870 * Filters whether or not new signups are allowed. … … 2902 2989 echo bp_get_avatar_delete_link(); 2903 2990 } 2904 2905 2991 /** 2906 2992 * Return an avatar delete link. … … 2934 3020 * 2935 3021 * @since 8.0.0 3022 * 3023 * @global BuddyPress $bp The one true BuddyPress instance. 2936 3024 * 2937 3025 * @param array|string $args { … … 3008 3096 * @since 8.0.0 3009 3097 * 3098 * @global BuddyPress $bp The one true BuddyPress instance. 3099 * 3010 3100 * @return array List of network invitations. 3011 3101 */ … … 3019 3109 * @since 8.0.0 3020 3110 * 3111 * @global BuddyPress $bp The one true BuddyPress instance. 3112 * 3021 3113 * @return object The current network invitation within the loop. 3022 3114 */ … … 3038 3130 * @since 8.0.0 3039 3131 * 3132 * @global BuddyPress $bp The one true BuddyPress instance. 3133 * 3040 3134 * @return string HTML for the pagination count. 3041 3135 */ 3042 3136 function bp_get_members_invitations_pagination_count() { 3043 $query_loop = buddypress()->members->invitations->query_loop; 3137 $bp = buddypress(); 3138 $query_loop = $bp->members->invitations->query_loop; 3044 3139 $start_num = intval( ( $query_loop->pag_page - 1 ) * $query_loop->pag_num ) + 1; 3045 3140 $from_num = bp_core_number_format( $start_num ); … … 3077 3172 * @since 8.0.0 3078 3173 * 3174 * @global BuddyPress $bp The one true BuddyPress instance. 3175 * 3079 3176 * @return string HTML for the pagination links. 3080 3177 */ 3081 3178 function bp_get_members_invitations_pagination_links() { 3179 $bp = buddypress(); 3082 3180 3083 3181 /** … … 3088 3186 * @param string $pag_links HTML for the pagination links. 3089 3187 */ 3090 return apply_filters( 'bp_get_members_invitations_pagination_links', buddypress()->members->invitations->query_loop->pag_links );3188 return apply_filters( 'bp_get_members_invitations_pagination_links', $bp->members->invitations->query_loop->pag_links ); 3091 3189 } 3092 3190
Note: See TracChangeset
for help on using the changeset viewer.