Changeset 5951 for trunk/src/includes/common/template.php
- Timestamp:
- 10/28/2015 04:07:50 AM (10 years ago)
- File:
-
- 1 edited
-
trunk/src/includes/common/template.php (modified) (79 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/src/includes/common/template.php
r5908 r5951 19 19 * Ouput the forum URL 20 20 * 21 * @since bbPress (r3979)21 * @since 2.1.0 bbPress (r3979) 22 22 * 23 23 * @uses bbp_get_forums_url() To get the forums URL … … 30 30 * Return the forum URL 31 31 * 32 * @since bbPress (r3979)32 * @since 2.1.0 bbPress (r3979) 33 33 * 34 34 * @uses home_url() To get the home URL … … 43 43 * Ouput the forum URL 44 44 * 45 * @since bbPress (r3979)45 * @since 2.1.0 bbPress (r3979) 46 46 * 47 47 * @uses bbp_get_topics_url() To get the topics URL … … 54 54 * Return the forum URL 55 55 * 56 * @since bbPress (r3979)56 * @since 2.1.0 bbPress (r3979) 57 57 * 58 58 * @uses home_url() To get the home URL … … 70 70 * Add our custom head action to wp_head 71 71 * 72 * @since bbPress (r2464)72 * @since 2.0.0 bbPress (r2464) 73 73 * 74 74 * @uses do_action() Calls 'bbp_head' … … 81 81 * Add our custom head action to wp_head 82 82 * 83 * @since bbPress (r2464)83 * @since 2.0.0 bbPress (r2464) 84 84 * 85 85 * @uses do_action() Calls 'bbp_footer' … … 94 94 * Check if current site is public 95 95 * 96 * @since bbPress (r3398)96 * @since 2.0.0 bbPress (r3398) 97 97 * 98 98 * @param int $site_id … … 118 118 * Check if current page is a bbPress forum 119 119 * 120 * @since bbPress (r2549)120 * @since 2.0.0 bbPress (r2549) 121 121 * 122 122 * @param int $post_id Possible post_id to check … … 140 140 * Check if we are viewing a forum archive. 141 141 * 142 * @since bbPress (r3251)142 * @since 2.0.0 bbPress (r3251) 143 143 * 144 144 * @uses is_post_type_archive() To check if we are looking at the forum archive … … 164 164 * Viewing a single forum 165 165 * 166 * @since bbPress (r3338)166 * @since 2.0.0 bbPress (r3338) 167 167 * 168 168 * @uses is_single() … … 194 194 * Check if current page is a forum edit page 195 195 * 196 * @since bbPress (r3553)196 * @since 2.1.0 bbPress (r3553) 197 197 * 198 198 * @uses WP_Query Checks if WP_Query::bbp_is_forum_edit is true … … 220 220 * Check if current page is a bbPress topic 221 221 * 222 * @since bbPress (r2549)222 * @since 2.0.0 bbPress (r2549) 223 223 * 224 224 * @param int $post_id Possible post_id to check … … 243 243 * Viewing a single topic 244 244 * 245 * @since bbPress (r3338)245 * @since 2.0.0 bbPress (r3338) 246 246 * 247 247 * @uses is_single() … … 273 273 * Check if we are viewing a topic archive. 274 274 * 275 * @since bbPress (r3251)275 * @since 2.0.0 bbPress (r3251) 276 276 * 277 277 * @uses is_post_type_archive() To check if we are looking at the topic archive … … 296 296 * Check if current page is a topic edit page 297 297 * 298 * @since bbPress (r2753)298 * @since 2.0.0 bbPress (r2753) 299 299 * 300 300 * @uses WP_Query Checks if WP_Query::bbp_is_topic_edit is true … … 322 322 * Check if current page is a topic merge page 323 323 * 324 * @since bbPress (r2756)324 * @since 2.0.0 bbPress (r2756) 325 325 * 326 326 * @uses bbp_is_topic_edit() To check if it's a topic edit page … … 343 343 * Check if current page is a topic split page 344 344 * 345 * @since bbPress (r2756)345 * @since 2.0.0 bbPress (r2756) 346 346 * 347 347 * @uses bbp_is_topic_edit() To check if it's a topic edit page … … 364 364 * Check if the current page is a topic tag 365 365 * 366 * @since bbPress (r3311)366 * @since 2.0.0 bbPress (r3311) 367 367 * 368 368 * @return bool True if it's a topic tag, false if not … … 394 394 * Check if the current page is editing a topic tag 395 395 * 396 * @since bbPress (r3346)396 * @since 2.0.0 bbPress (r3346) 397 397 * 398 398 * @uses WP_Query Checks if WP_Query::bbp_is_topic_tag_edit is true … … 425 425 * Check if the current post type is one of bbPress's 426 426 * 427 * @since bbPress (r3311)427 * @since 2.0.0 bbPress (r3311) 428 428 * 429 429 * @param mixed $the_post Optional. Post object or post ID. … … 455 455 * Check if current page is a bbPress reply 456 456 * 457 * @since bbPress (r2549)457 * @since 2.0.0 bbPress (r2549) 458 458 * 459 459 * @param int $post_id Possible post_id to check … … 478 478 * Check if current page is a reply edit page 479 479 * 480 * @since bbPress (r2753)480 * @since 2.0.0 bbPress (r2753) 481 481 * 482 482 * @uses WP_Query Checks if WP_Query::bbp_is_reply_edit is true … … 523 523 * Viewing a single reply 524 524 * 525 * @since bbPress (r3344)525 * @since 2.0.0 bbPress (r3344) 526 526 * 527 527 * @uses is_single() … … 553 553 * Check if current page is a bbPress user's favorites page (profile page) 554 554 * 555 * @since bbPress (r2652)555 * @since 2.0.0 bbPress (r2652) 556 556 * 557 557 * @return bool True if it's the favorites page, false if not … … 574 574 * Check if current page is a bbPress user's subscriptions page (profile page) 575 575 * 576 * @since bbPress (r2652)576 * @since 2.0.0 bbPress (r2652) 577 577 * 578 578 * @return bool True if it's the subscriptions page, false if not … … 596 596 * page) 597 597 * 598 * @since bbPress (r2688)598 * @since 2.0.0 bbPress (r2688) 599 599 * 600 600 * @return bool True if it's the topics created page, false if not … … 618 618 * page) 619 619 * 620 * @since bbPress (r4225)620 * @since 2.2.0 bbPress (r4225) 621 621 * 622 622 * @return bool True if it's the topics created page, false if not … … 639 639 * Check if current page is the currently logged in users author page 640 640 * 641 * @since bbPress (r2688) 641 * @since 2.0.0 bbPress (r2688) 642 * 642 643 * @uses bbp_is_single_user() Check query variable 643 644 * @uses is_user_logged_in() Must be logged in to be home … … 663 664 * Check if current page is the currently logged in users author edit page 664 665 * 665 * @since bbPress (r3918) 666 * @since 2.1.0 bbPress (r3918) 667 * 666 668 * @uses bbp_is_single_user_edit() Check query variable 667 669 * @uses is_user_logged_in() Must be logged in to be home … … 685 687 * Check if current page is a user profile page 686 688 * 687 * @since bbPress (r2688)689 * @since 2.0.0 bbPress (r2688) 688 690 * 689 691 * @uses WP_Query Checks if WP_Query::bbp_is_single_user is set to true … … 707 709 * Check if current page is a user profile edit page 708 710 * 709 * @since bbPress (r2688)711 * @since 2.0.0 bbPress (r2688) 710 712 * 711 713 * @uses WP_Query Checks if WP_Query::bbp_is_single_user_edit is set to true … … 729 731 * Check if current page is a user profile page 730 732 * 731 * @since bbPress (r4225)733 * @since 2.2.0 bbPress (r4225) 732 734 * 733 735 * @uses WP_Query Checks if WP_Query::bbp_is_single_user_profile is set to true … … 751 753 * Check if current page is a user topics created page 752 754 * 753 * @since bbPress (r4225)755 * @since 2.2.0 bbPress (r4225) 754 756 * 755 757 * @uses WP_Query Checks if WP_Query::bbp_is_single_user_topics is set to true … … 773 775 * Check if current page is a user replies created page 774 776 * 775 * @since bbPress (r4225)777 * @since 2.2.0 bbPress (r4225) 776 778 * 777 779 * @uses WP_Query Checks if WP_Query::bbp_is_single_user_replies is set to true … … 795 797 * Check if current page is a view page 796 798 * 797 * @since bbPress (r2789)799 * @since 2.0.0 bbPress (r2789) 798 800 * 799 801 * @global WP_Query $wp_query To check if WP_Query::bbp_is_view is true … … 823 825 * Check if current page is a search page 824 826 * 825 * @since bbPress (r4579)827 * @since 2.3.0 bbPress (r4579) 826 828 * 827 829 * @global WP_Query $wp_query To check if WP_Query::bbp_is_search is true … … 861 863 * Check if current page is a search results page 862 864 * 863 * @since bbPress (r4919)865 * @since 2.4.0 bbPress (r4919) 864 866 * 865 867 * @global WP_Query $wp_query To check if WP_Query::bbp_is_search is true … … 899 901 * Check if current page is an edit page 900 902 * 901 * @since bbPress (r3585)903 * @since 2.1.0 bbPress (r3585) 902 904 * 903 905 * @uses WP_Query Checks if WP_Query::bbp_is_edit is true … … 921 923 * Use the above is_() functions to output a body class for each scenario 922 924 * 923 * @since bbPress (r2926)925 * @since 2.0.0 bbPress (r2926) 924 926 * 925 927 * @param array $wp_classes … … 1074 1076 * Use the above is_() functions to return if in any bbPress page 1075 1077 * 1076 * @since bbPress (r3344)1078 * @since 2.0.0 bbPress (r3344) 1077 1079 * 1078 1080 * @uses bbp_is_single_forum() … … 1189 1191 * Output the login form action url 1190 1192 * 1191 * @since bbPress (r2815)1193 * @since 2.0.0 bbPress (r2815) 1192 1194 * 1193 1195 * @param array $args This function supports these arguments: … … 1205 1207 * Return the login form action url 1206 1208 * 1207 * @since bbPress (r5684)1209 * @since 2.6.0 bbPress (r5684) 1208 1210 * 1209 1211 * @param array $args This function supports these arguments: … … 1243 1245 * check the field manually, use bbp_get_redirect_to(). 1244 1246 * 1245 * @since bbPress (r2815)1247 * @since 2.0.0 bbPress (r2815) 1246 1248 * 1247 1249 * @param string $redirect_to Pass a URL to redirect to … … 1275 1277 * ensures correct sanitization of the value for the receiving input. 1276 1278 * 1277 * @since bbPress (r2815)1279 * @since 2.0.0 bbPress (r2815) 1278 1280 * 1279 1281 * @param string $request Name of $_REQUEST to look for … … 1291 1293 * ensures correct sanitization of the value for the receiving input. 1292 1294 * 1293 * @since bbPress (r2815)1295 * @since 2.0.0 bbPress (r2815) 1294 1296 * 1295 1297 * @param string $request Name of $_REQUEST to look for … … 1337 1339 * tab index by default. 1338 1340 * 1339 * @since bbPress (r2810) 1340 * @deprecated since version 2.6 1341 * @since 2.0.0 bbPress (r2810) 1342 * 1343 * @deprecated 2.6.0 bbPress (r5561) 1344 * 1341 1345 * @link https://bbpress.trac.wordpress.org/attachment/ticket/2714 Trac Ticket 1342 1346 * @param int $auto_increment Optional. Default true. Set to false to prevent … … 1354 1358 * increment the global tab index by default. 1355 1359 * 1356 * @since bbPress (r2810) 1357 * @deprecated bbPress (r5560) 1360 * @since 2.0.0 bbPress (r2810) 1361 * 1362 * @deprecated 2.6.0 bbPress (r5561) 1363 * 1358 1364 * @link https://bbpress.trac.wordpress.org/attachment/ticket/2714 Trac Ticket 1359 1365 * @uses apply_filters Allows return value to be filtered … … 1378 1384 * Can be used for any post type, but is mostly used for topics and forums. 1379 1385 * 1380 * @since bbPress (r2746)1386 * @since 2.0.0 bbPress (r2746) 1381 1387 * 1382 1388 * @param array $args See {@link bbp_get_dropdown()} for arguments … … 1389 1395 * topic/reply belongs in. 1390 1396 * 1391 * @since bbPress (r2746)1397 * @since 2.0.0 bbPress (r2746) 1392 1398 * 1393 1399 * @param array $args The function supports these args: … … 1562 1568 * Output the required hidden fields when creating/editing a forum 1563 1569 * 1564 * @since bbPress (r3553)1570 * @since 2.1.0 bbPress (r3553) 1565 1571 * 1566 1572 * @uses bbp_is_forum_edit() To check if it's the forum edit page … … 1605 1611 * Output the required hidden fields when creating/editing a topic 1606 1612 * 1607 * @since bbPress (r2753)1613 * @since 2.0.0 bbPress (r2753) 1608 1614 * 1609 1615 * @uses bbp_is_topic_edit() To check if it's the topic edit page … … 1648 1654 * Output the required hidden fields when creating/editing a reply 1649 1655 * 1650 * @since bbPress (r2753)1656 * @since 2.0.0 bbPress (r2753) 1651 1657 * 1652 1658 * @uses bbp_is_reply_edit() To check if it's the reply edit page … … 1691 1697 * Output the required hidden fields when editing a user 1692 1698 * 1693 * @since bbPress (r2690)1699 * @since 2.0.0 bbPress (r2690) 1694 1700 * 1695 1701 * @uses bbp_displayed_user_id() To output the displayed user id … … 1710 1716 * Output the required hidden fields when merging a topic 1711 1717 * 1712 * @since bbPress (r2756)1718 * @since 2.0.0 bbPress (r2756) 1713 1719 * 1714 1720 * @uses wp_nonce_field() To generate a hidden nonce field … … 1729 1735 * Output the required hidden fields when splitting a topic 1730 1736 * 1731 * @since bbPress (r2756)1737 * @since 2.0.0 bbPress (r2756) 1732 1738 * 1733 1739 * @uses wp_nonce_field() To generate a hidden nonce field … … 1761 1767 * Output a textarea or TinyMCE if enabled 1762 1768 * 1763 * @since bbPress (r3586)1769 * @since 2.1.0 bbPress (r3586) 1764 1770 * 1765 1771 * @param array $args … … 1772 1778 * Return a textarea or TinyMCE if enabled 1773 1779 * 1774 * @since bbPress (r3586)1780 * @since 2.1.0 bbPress (r3586) 1775 1781 * 1776 1782 * @param array $args … … 1879 1885 * Edit TinyMCE plugins to match core behaviour 1880 1886 * 1881 * @since bbPress (r4574)1887 * @since 2.3.0 bbPress (r4574) 1882 1888 * 1883 1889 * @param array $plugins … … 1904 1910 * Edit TeenyMCE buttons to match allowedtags 1905 1911 * 1906 * @since bbPress (r4605)1912 * @since 2.3.0 bbPress (r4605) 1907 1913 * 1908 1914 * @param array $buttons … … 1929 1935 * Edit TinyMCE quicktags buttons to match allowedtags 1930 1936 * 1931 * @since bbPress (r4606)1937 * @since 2.3.0 bbPress (r4606) 1932 1938 * 1933 1939 * @param array $settings … … 1958 1964 * Output the view id 1959 1965 * 1960 * @since bbPress (r2789)1966 * @since 2.0.0 bbPress (r2789) 1961 1967 * 1962 1968 * @param string $view Optional. View id … … 1972 1978 * Use view id if supplied, otherwise bbp_get_view_rewrite_id() query var. 1973 1979 * 1974 * @since bbPress (r2789)1980 * @since 2.0.0 bbPress (r2789) 1975 1981 * 1976 1982 * @param string $view Optional. View id. … … 2001 2007 * Output the view name aka title 2002 2008 * 2003 * @since bbPress (r2789)2009 * @since 2.0.0 bbPress (r2789) 2004 2010 * 2005 2011 * @param string $view Optional. View id … … 2016 2022 * query var is checked for. 2017 2023 * 2018 * @since bbPress (r2789)2024 * @since 2.0.0 bbPress (r2789) 2019 2025 * 2020 2026 * @param string $view Optional. View id … … 2036 2042 * Output the view url 2037 2043 * 2038 * @since bbPress (r2789)2044 * @since 2.0.0 bbPress (r2789) 2039 2045 * 2040 2046 * @param string $view Optional. View id … … 2047 2053 * Return the view url 2048 2054 * 2049 * @since bbPress (r2789)2055 * @since 2.0.0 bbPress (r2789) 2050 2056 * 2051 2057 * @param string $view Optional. View id … … 2085 2091 * Check the passed parameter against the current _bbp_query_name 2086 2092 * 2087 * @since bbPress (r2980)2093 * @since 2.0.0 bbPress (r2980) 2088 2094 * 2089 2095 * @uses bbp_get_query_name() Get the query var '_bbp_query_name' … … 2097 2103 * Get the '_bbp_query_name' setting 2098 2104 * 2099 * @since bbPress (r2695)2105 * @since 2.0.0 bbPress (r2695) 2100 2106 * 2101 2107 * @uses get_query_var() To get the query var '_bbp_query_name' … … 2109 2115 * Set the '_bbp_query_name' setting to $name 2110 2116 * 2111 * @since bbPress (r2692)2117 * @since 2.0.0 bbPress (r2692) 2112 2118 * 2113 2119 * @param string $name What to set the query var to … … 2121 2127 * Used to clear the '_bbp_query_name' setting 2122 2128 * 2123 * @since bbPress (r2692)2129 * @since 2.0.0 bbPress (r2692) 2124 2130 * 2125 2131 * @uses bbp_set_query_name() To set the query var '_bbp_query_name' value to '' … … 2134 2140 * Output the page title as a breadcrumb 2135 2141 * 2136 * @since bbPress (r2589)2142 * @since 2.0.0 bbPress (r2589) 2137 2143 * 2138 2144 * @param string $sep Separator. Defaults to '←' … … 2148 2154 * Output a breadcrumb 2149 2155 * 2150 * @since bbPress (r2589)2156 * @since 2.0.0 bbPress (r2589) 2151 2157 * 2152 2158 * @param string $sep Separator. Defaults to '←' … … 2161 2167 * Return a breadcrumb ( forum -> topic -> reply ) 2162 2168 * 2163 * @since bbPress (r2589)2169 * @since 2.0.0 bbPress (r2589) 2164 2170 * 2165 2171 * @param string $sep Separator. Defaults to '←' … … 2449 2455 * attributes are supported. As well as any plugins which want to display it. 2450 2456 * 2451 * @since bbPress (r2780)2457 * @since 2.0.0 bbPress (r2780) 2452 2458 * 2453 2459 * @uses bbp_get_allowed_tags() … … 2462 2468 * attributes are supported. As well as any plugins which want to display it. 2463 2469 * 2464 * @since bbPress (r2780)2470 * @since 2.0.0 bbPress (r2780) 2465 2471 * 2466 2472 * @uses bbp_kses_allowed_tags() To get the allowed tags … … 2490 2496 * Display possible errors & messages inside a template file 2491 2497 * 2492 * @since bbPress (r2688)2498 * @since 2.0.0 bbPress (r2688) 2493 2499 * 2494 2500 * @uses WP_Error bbPress::errors::get_error_codes() To get the error codes … … 2555 2561 * Output the logout link 2556 2562 * 2557 * @since bbPress (r2827)2563 * @since 2.0.0 bbPress (r2827) 2558 2564 * 2559 2565 * @param string $redirect_to Redirect to url … … 2566 2572 * Return the logout link 2567 2573 * 2568 * @since bbPress (r2827)2574 * @since 2.0.0 bbPress (r2827) 2569 2575 * 2570 2576 * @param string $redirect_to Redirect to url … … 2583 2589 * Custom page title for bbPress pages 2584 2590 * 2585 * @since bbPress (r2788)2591 * @since 2.0.0 bbPress (r2788) 2586 2592 * 2587 2593 * @param string $title Optional. The title (not used).
Note: See TracChangeset
for help on using the changeset viewer.