Changeset 10108 for trunk/src/bp-core/bp-core-template.php
- Timestamp:
- 09/13/2015 02:02:56 AM (11 years ago)
- File:
-
- 1 edited
-
trunk/src/bp-core/bp-core-template.php (modified) (91 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/src/bp-core/bp-core-template.php
r10039 r10108 7 7 */ 8 8 9 // Exit if accessed directly 9 // Exit if accessed directly. 10 10 defined( 'ABSPATH' ) || exit; 11 11 … … 81 81 * This is a dynamic filter that is dependent on the provided css_id value. 82 82 * 83 * @since BuddyPress (1.1.0)83 * @since 1.1.0 84 84 * 85 85 * @param string $value HTML list item for the submenu item. … … 113 113 * page. 114 114 * 115 * @since BuddyPress (2.0.0)115 * @since 2.0.0 116 116 * 117 117 * @param string $component … … 134 134 * Filters the directory title for a component. 135 135 * 136 * @since BuddyPress (2.0.0)136 * @since 2.0.0 137 137 * 138 138 * @param string $title Text to be used in <title> tag. … … 228 228 * Filters the current avatar upload step. 229 229 * 230 * @since BuddyPress (1.1.0)230 * @since 1.1.0 231 231 * 232 232 * @param string $step The current avatar upload step. … … 255 255 * Filters the URL of the avatar to crop. 256 256 * 257 * @since BuddyPress (1.1.0)257 * @since 1.1.0 258 258 * 259 259 * @param string $url URL for the avatar. … … 282 282 * Filters the relative file path to the avatar to crop. 283 283 * 284 * @since BuddyPress (1.1.0)284 * @since 1.1.0 285 285 * 286 286 * @param string $src Relative file path for the avatar. … … 311 311 * Returns the name of the BP site. Used in RSS headers. 312 312 * 313 * @since BuddyPress (1.6.0)313 * @since 1.6.0 314 314 */ 315 315 function bp_get_site_name() { … … 318 318 * Filters the name of the BP site. Used in RSS headers. 319 319 * 320 * @since BuddyPress (1.0.0)320 * @since 1.0.0 321 321 * 322 322 * @param string $value Current BP site name. … … 339 339 * and times together with timezone offsets and i18n. 340 340 * 341 * @since BuddyPress (1.1.0)341 * @since 1.1.0 342 342 * 343 343 * @param int|string $time The UNIX timestamp to be formatted. … … 399 399 * Filters the date based on a UNIX timestamp. 400 400 * 401 * @since BuddyPress (1.0.0)401 * @since 1.0.0 402 402 * 403 403 * @param string $formatted_date Formatted date from the timestamp. … … 437 437 * Filters the text used based on context of own profile or someone else's profile. 438 438 * 439 * @since BuddyPress (1.0.0)439 * @since 1.0.0 440 440 * 441 441 * @param string $youtext Context-determined string to display. … … 487 487 * Filters the "action" attribute for search forms. 488 488 * 489 * @since BuddyPress (1.0.0)489 * @since 1.0.0 490 490 * 491 491 * @param string $value Search form action url. … … 497 497 * Generate the basic search form as used in BP-Default's header. 498 498 * 499 * @since BuddyPress (1.0.0)499 * @since 1.0.0 500 500 * 501 501 * @return string HTML <select> element. … … 530 530 * Filters all of the component options available for search scope. 531 531 * 532 * @since BuddyPress (1.5.0)532 * @since 1.5.0 533 533 * 534 534 * @param array $options Array of options to add to select field. … … 544 544 * Filters the complete <select> input used for search scope. 545 545 * 546 * @since BuddyPress (1.0.0)546 * @since 1.0.0 547 547 * 548 548 * @param string $selection_box <select> input for selecting search scope. … … 554 554 * Output the default text for the search box for a given component. 555 555 * 556 * @since BuddyPress (1.5.0)556 * @since 1.5.0 557 557 * 558 558 * @see bp_get_search_default_text() … … 566 566 * Return the default text for the search box for a given component. 567 567 * 568 * @since BuddyPress (1.5.0)568 * @since 1.5.0 569 569 * 570 570 * @param string $component Component name. Default: current component. … … 601 601 * Filters the default text for the search box for a given component. 602 602 * 603 * @since BuddyPress (1.5.0)603 * @since 1.5.0 604 604 * 605 605 * @param string $default_text Default text for search box. … … 634 634 * Output the attributes for a form field. 635 635 * 636 * @since BuddyPress (2.2.0)636 * @since 2.2.0 637 637 * 638 638 * @param string $name The field name to output attributes for. … … 649 649 * manipulation. 650 650 * 651 * @since BuddyPress (2.2.0)651 * @since 2.2.0 652 652 * 653 653 * @param string $name The field name to get attributes for. … … 691 691 * Filter the attributes for a field before rendering output. 692 692 * 693 * @since BuddyPress (2.2.0)693 * @since 2.2.0 694 694 * 695 695 * @param array $attributes The field attributes. … … 729 729 * Filters the requested button output. 730 730 * 731 * @since BuddyPress (1.2.6)731 * @since 1.2.6 732 732 * 733 733 * @param string $contents Button context to be used. … … 788 788 * Filters the excerpt length to trim text to. 789 789 * 790 * @since BuddyPress (1.5.0)790 * @since 1.5.0 791 791 * 792 792 * @param int $length Length of returned string, including ellipsis. … … 797 797 * Filters the excerpt appended text value. 798 798 * 799 * @since BuddyPress (1.5.0)799 * @since 1.5.0 800 800 * 801 801 * @param string $value Text to append to the end of the excerpt. … … 950 950 * Filters the final generated excerpt. 951 951 * 952 * @since BuddyPress (1.1.0)952 * @since 1.1.0 953 953 * 954 954 * @param string $truncate Generated excerpt. … … 987 987 * Filters the total member count in your BP instance. 988 988 * 989 * @since BuddyPress (1.2.0)989 * @since 1.2.0 990 990 * 991 991 * @param int $value Member count. … … 1054 1054 * Filters whether registrations require activation on this installation. 1055 1055 * 1056 * @since BuddyPress (1.2.0)1056 * @since 1.2.0 1057 1057 * 1058 1058 * @param bool $value Whether registrations require activation. Default true. … … 1067 1067 * sanitize_option, we want to reverse this for the plain text arena of emails. 1068 1068 * 1069 * @since BuddyPress (1.7.0)1069 * @since 1.7.0 1070 1070 * 1071 1071 * @see https://buddypress.trac.wordpress.org/ticket/4401 … … 1098 1098 * Filters a client friendly version of the root blog name. 1099 1099 * 1100 * @since BuddyPress (1.7.0)1100 * @since 1.7.0 1101 1101 * 1102 1102 * @param string $subject Client friendy version of the root blog name. … … 1132 1132 * Allows templates to pass parameters into the template loops via AJAX. 1133 1133 * 1134 * @since BuddyPress (1.2.0)1134 * @since 1.2.0 1135 1135 * 1136 1136 * @param string $ajax_querystring Current query string. … … 1156 1156 * Filters the name of the current component. 1157 1157 * 1158 * @since BuddyPress (1.0.0)1158 * @since 1.0.0 1159 1159 * 1160 1160 * @param string|bool $current_component Current component if available or false. … … 1177 1177 * Filters the name of the current action. 1178 1178 * 1179 * @since BuddyPress (1.0.0)1179 * @since 1.0.0 1180 1180 * 1181 1181 * @param string $current_action Current action. … … 1198 1198 * Filters the name of the current item. 1199 1199 * 1200 * @since BuddyPress (1.1.0)1200 * @since 1.1.0 1201 1201 * 1202 1202 * @param string|bool $current_item Current item if available or false. … … 1220 1220 * Filters the value of $bp->action_variables. 1221 1221 * 1222 * @since BuddyPress (1.0.0)1222 * @since 1.0.0 1223 1223 * 1224 1224 * @param array|bool $action_variables Available action variables. … … 1230 1230 * Return the value of a given action variable. 1231 1231 * 1232 * @since BuddyPress (1.5.0)1232 * @since 1.5.0 1233 1233 * 1234 1234 * @param int $position The key of the action_variables array that you want. … … 1246 1246 * Filters the value of a given action variable. 1247 1247 * 1248 * @since BuddyPress (1.5.0)1248 * @since 1.5.0 1249 1249 * 1250 1250 * @param string|bool $action_variable Requested action variable based on position. … … 1278 1278 * Filters the "root domain", the URL of the BP root blog. 1279 1279 * 1280 * @since BuddyPress (1.2.4)1280 * @since 1.2.4 1281 1281 * 1282 1282 * @param string $domain URL of the BP root blog. … … 1288 1288 * Output the root slug for a given component. 1289 1289 * 1290 * @since BuddyPress (1.5.0)1290 * @since 1.5.0 1291 1291 * 1292 1292 * @param string $component The component name. … … 1320 1320 * from $bp->groups->root_slug. 1321 1321 * 1322 * @since BuddyPress (1.5.0)1322 * @since 1.5.0 1323 1323 * 1324 1324 * @param string $component Optional. Defaults to the current component. … … 1358 1358 * Filters the root slug for given component. 1359 1359 * 1360 * @since BuddyPress (1.5.0)1360 * @since 1.5.0 1361 1361 * 1362 1362 * @param string $root_slug Root slug for given component. … … 1369 1369 * Return the component name based on a root slug. 1370 1370 * 1371 * @since BuddyPress (1.5.0)1371 * @since 1.5.0 1372 1372 * 1373 1373 * @param string $root_slug Needle to our active component haystack. … … 1404 1404 * Filters whether or not a user has access. 1405 1405 * 1406 * @since BuddyPress (1.2.4)1406 * @since 1.2.4 1407 1407 * 1408 1408 * @param bool $has_access Whether or not user has access. … … 1414 1414 * Output the search slug. 1415 1415 * 1416 * @since BuddyPress (1.5.0)1416 * @since 1.5.0 1417 1417 * 1418 1418 * @uses bp_get_search_slug() … … 1424 1424 * Return the search slug. 1425 1425 * 1426 * @since BuddyPress (1.5.0)1426 * @since 1.5.0 1427 1427 * 1428 1428 * @return string The search slug. Default: 'search'. … … 1433 1433 * Filters the search slug. 1434 1434 * 1435 * @since BuddyPress (1.5.0)1435 * @since 1.5.0 1436 1436 * 1437 1437 * @const string BP_SEARCH_SLUG The search slug. Default "search". … … 1456 1456 * Filters the ID of the currently displayed user. 1457 1457 * 1458 * @since BuddyPress (1.0.0)1458 * @since 1.0.0 1459 1459 * 1460 1460 * @param int $id ID of the currently displayed user. … … 1479 1479 * Filters the ID of the currently logged-in user. 1480 1480 * 1481 * @since BuddyPress (1.0.0)1481 * @since 1.0.0 1482 1482 * 1483 1483 * @param int $id ID of the currently logged-in user. … … 1497 1497 * - the component's id, or 'canonical' name. 1498 1498 * 1499 * @since BuddyPress (1.5.0)1499 * @since 1.5.0 1500 1500 * 1501 1501 * @param string $component Name of the component being checked. … … 1566 1566 * Filters whether the current page belongs to the specified component. 1567 1567 * 1568 * @since BuddyPress (1.5.0)1568 * @since 1.5.0 1569 1569 * 1570 1570 * @param bool $is_current_component Whether or not the current page belongs to specified component. … … 1586 1586 * the current_action is 'members'. 1587 1587 * 1588 * @since BuddyPress (1.5.0)1588 * @since 1.5.0 1589 1589 * 1590 1590 * @param string $action The action being tested against. … … 1608 1608 * $action_variables[0] is 'group-settings'. 1609 1609 * 1610 * @since BuddyPress (1.5.0)1610 * @since 1.5.0 1611 1611 * 1612 1612 * @param string $action_variable The action_variable being tested against. … … 1637 1637 * Filters whether the current page matches a given action_variable. 1638 1638 * 1639 * @since BuddyPress (1.5.0)1639 * @since 1.5.0 1640 1640 * 1641 1641 * @param bool $is_action_variable Whether the current page matches a given action_variable. … … 1659 1659 * Filters whether or not an item is the current item. 1660 1660 * 1661 * @since BuddyPress (2.1.0)1661 * @since 2.1.0 1662 1662 * 1663 1663 * @param bool $retval Whether or not an item is the current item. … … 1683 1683 * Filters whether or not an item is the a single item. (group, user, etc) 1684 1684 * 1685 * @since BuddyPress (2.1.0)1685 * @since 2.1.0 1686 1686 * 1687 1687 * @param bool $retval Whether or not an item is a single item. … … 1707 1707 * Filters whether or not the logged-in user is an admin for the current item. 1708 1708 * 1709 * @since BuddyPress (2.1.0)1709 * @since 2.1.0 1710 1710 * 1711 1711 * @param bool $retval Whether or not the logged-in user is an admin. … … 1731 1731 * Filters whether or not the logged-in user is a mod for the current item. 1732 1732 * 1733 * @since BuddyPress (2.1.0)1733 * @since 2.1.0 1734 1734 * 1735 1735 * @param bool $retval Whether or not the logged-in user is a mod. … … 1754 1754 * Filters whether or not user is on a component directory page. 1755 1755 * 1756 * @since BuddyPress (2.1.0)1756 * @since 2.1.0 1757 1757 * 1758 1758 * @param bool $retval Whether or not user is on a component directory page. … … 1796 1796 * Filters whether or not a component's URL should be in the root, not under a member page. 1797 1797 * 1798 * @since BuddyPress (2.1.0)1798 * @since 2.1.0 1799 1799 * 1800 1800 * @param bool $retval Whether or not URL should be in the root. … … 1808 1808 * Corresponds to the setting in wp-admin's Settings > Reading screen. 1809 1809 * 1810 * @since BuddyPress (1.5.0)1810 * @since 1.5.0 1811 1811 * 1812 1812 * @global int $current_blog WordPress global for the current blog. … … 1844 1844 * Filters whether or not the specified BuddyPress component directory is set to be the front page. 1845 1845 * 1846 * @since BuddyPress (1.5.0)1846 * @since 1.5.0 1847 1847 * 1848 1848 * @param bool $value Whether or not the specified component directory is set as front page. … … 1874 1874 * Filters whether or not current page is a blog page or not. 1875 1875 * 1876 * @since BuddyPress (1.5.0)1876 * @since 1.5.0 1877 1877 * 1878 1878 * @param bool $is_blog_page Whether or not current page is a blog page. … … 1891 1891 * is unset. Thus the addition of the bp_is_user() check. 1892 1892 * 1893 * @since BuddyPress (1.7.0)1893 * @since 1.7.0 1894 1894 * 1895 1895 * @return bool True if it's a BuddyPress page, false otherwise. … … 1901 1901 * Filters whether or not this is a BuddyPress component. 1902 1902 * 1903 * @since BuddyPress (1.7.0)1903 * @since 1.7.0 1904 1904 * 1905 1905 * @param bool $retval Whether or not this is a BuddyPress component. … … 1913 1913 * Check whether a given component (or feature of a component) is active. 1914 1914 * 1915 * @since BuddyPress (1.2.0)See r2539.1916 * @since BuddyPress (2.3.0)Added $feature as a parameter.1915 * @since 1.2.0 See r2539. 1916 * @since 2.3.0 Added $feature as a parameter. 1917 1917 * 1918 1918 * @param string $component The component name. … … 1945 1945 * that you are checking of active status of. 1946 1946 * 1947 * @since BuddyPress (2.3.0)1947 * @since 2.3.0 1948 1948 * 1949 1949 * @param bool $retval … … 1956 1956 * Filters whether or not a given component has been activated by the admin. 1957 1957 * 1958 * @since BuddyPress (2.1.0)1958 * @since 2.1.0 1959 1959 * 1960 1960 * @param bool $retval Whether or not a given component has been activated by the admin. … … 2039 2039 * Check whether the current page is part of the Notifications component. 2040 2040 * 2041 * @since BuddyPress (1.9.0)2041 * @since 1.9.0 2042 2042 * 2043 2043 * @return bool True if the current page is part of the Notifications component. … … 2086 2086 * Is the current page the activity directory? 2087 2087 * 2088 * @since BuddyPress (2.0.0)2088 * @since 2.0.0 2089 2089 * 2090 2090 * @return True if the current page is the activity directory. … … 2112 2112 * Is the current page the members directory? 2113 2113 * 2114 * @since BuddyPress (2.0.0)2114 * @since 2.0.0 2115 2115 * 2116 2116 * @return True if the current page is the members directory. … … 2142 2142 * Filters whether or not current page is part of the profile for the logged-in user. 2143 2143 * 2144 * @since BuddyPress (1.2.4)2144 * @since 1.2.4 2145 2145 * 2146 2146 * @param bool $my_profile Whether or not current page is part of the profile for the logged-in user. … … 2272 2272 * Eg http://example.com/members/joe/forums/topics/. 2273 2273 * 2274 * @since BuddyPress (1.5.0)2274 * @since 1.5.0 2275 2275 * 2276 2276 * @return bool True if the current page is a user's Topics Started page. … … 2285 2285 * Eg http://example.com/members/joe/forums/replies/. 2286 2286 * 2287 * @since BuddyPress (1.5.0)2287 * @since 1.5.0 2288 2288 * 2289 2289 * @return bool True if the current page is a user's Replied To forums page. … … 2364 2364 * Eg http://example.com/members/joe/notifications/ (or a subpage thereof). 2365 2365 * 2366 * @since BuddyPress (1.9.0)2366 * @since 1.9.0 2367 2367 * 2368 2368 * @return bool True if the current page is a user's Notifications page. … … 2388 2388 * Eg http://example.com/members/joe/settings/general/. 2389 2389 * 2390 * @since BuddyPress (1.5.0)2390 * @since 1.5.0 2391 2391 * 2392 2392 * @return bool True if the current page is a user's General Settings page. … … 2401 2401 * Eg http://example.com/members/joe/settings/notifications/. 2402 2402 * 2403 * @since BuddyPress (1.5.0)2403 * @since 1.5.0 2404 2404 * 2405 2405 * @return bool True if the current page is a user's Notification Settings page. … … 2414 2414 * Eg http://example.com/members/joe/settings/delete-account/. 2415 2415 * 2416 * @since BuddyPress (1.5.0)2416 * @since 1.5.0 2417 2417 * 2418 2418 * @return bool True if the current page is a user's Delete Account page. … … 2427 2427 * Eg http://example.com/members/joe/settings/profile/. 2428 2428 * 2429 * @since BuddyPress (2.0.0)2429 * @since 2.0.0 2430 2430 * 2431 2431 * @return bool True if the current page is a user's Profile Settings page. … … 2440 2440 * Is the current page the groups directory ? 2441 2441 * 2442 * @since BuddyPress (2.0.0)2442 * @since 2.0.0 2443 2443 * 2444 2444 * @return True if the current page is the groups directory. … … 2629 2629 * Is the current page the blogs directory ? 2630 2630 * 2631 * @since BuddyPress (2.0.0)2631 * @since 2.0.0 2632 2632 * 2633 2633 * @return True if the current page is the blogs directory. … … 2977 2977 * Filters the BuddyPress classes to be added to body_class() 2978 2978 * 2979 * @since BuddyPress (1.1.0)2979 * @since 1.1.0 2980 2980 * 2981 2981 * @param array $classes Array of body classes to add. … … 2993 2993 * Hooked to the 'post_class' filter. 2994 2994 * 2995 * @since BuddyPress (2.1.0)2995 * @since 2.1.0 2996 2996 * 2997 2997 * @param array $wp_classes The post classes coming from WordPress. … … 3057 3057 * 3058 3058 * @access private 3059 * @since BuddyPress (1.7.0)3059 * @since 1.7.0 3060 3060 * 3061 3061 * @param array $a First item. … … 3079 3079 * Get the items registered in the primary and secondary BuddyPress navigation menus. 3080 3080 * 3081 * @since BuddyPress (1.7.0)3081 * @since 1.7.0 3082 3082 * 3083 3083 * @return array A multidimensional array of all navigation items. … … 3158 3158 * Filters the items registered in the primary and secondary BuddyPress navigation menus. 3159 3159 * 3160 * @since BuddyPress (1.7.0)3160 * @since 1.7.0 3161 3161 * 3162 3162 * @param array $menus Array of items registered in the primary and secondary BuddyPress navigation. … … 3168 3168 * Display a navigation menu. 3169 3169 * 3170 * @since BuddyPress (1.7.0)3170 * @since 1.7.0 3171 3171 * 3172 3172 * @param string|array $args { … … 3227 3227 * Filters the parsed bp_nav_menu arguments. 3228 3228 * 3229 * @since BuddyPress (1.7.0)3229 * @since 1.7.0 3230 3230 * 3231 3231 * @param array $args Array of parsed arguments. … … 3252 3252 * Filters the allowed tags for the wp_nav_menu_container. 3253 3253 * 3254 * @since BuddyPress (1.7.0)3254 * @since 1.7.0 3255 3255 * 3256 3256 * @param array $value Array of allowed tags. Default 'div' and 'nav'. … … 3270 3270 * Filters the BuddyPress menu objects. 3271 3271 * 3272 * @since BuddyPress (1.7.0)3272 * @since 1.7.0 3273 3273 * 3274 3274 * @param array $value Array of nav menu objects. … … 3302 3302 * Allow plugins to hook into the menu to add their own <li>'s 3303 3303 * 3304 * @since BuddyPress (1.7.0)3304 * @since 1.7.0 3305 3305 * 3306 3306 * @param array $items Array of nav menu items. … … 3322 3322 * Filters the final BuddyPress menu output. 3323 3323 * 3324 * @since BuddyPress (1.7.0)3324 * @since 1.7.0 3325 3325 * 3326 3326 * @param string $nav_menu Final nav menu output.
Note: See TracChangeset
for help on using the changeset viewer.