Changeset 10096 for trunk/src/bpforums/bpforumstemplate.php
 Timestamp:
 09/12/2015 05:51:55 AM (9 years ago)
 File:

 1 edited
Legend:
 Unmodified
 Added
 Removed

trunk/src/bpforums/bpforumstemplate.php
r9848 r10096 4 4 * 5 5 * @package BuddyPress 6 * @subpackage Forums 7 */ 8 9 // Exit if accessed directly 6 * @subpackage ForumsTemplate 7 */ 8 9 // Exit if accessed directly. 10 10 defined( 'ABSPATH' )  exit; 11 11 … … 13 13 * Output the forums component slug. 14 14 * 15 * @since BuddyPress (1.5.0)15 * @since 1.5.0 16 16 * 17 17 * @uses bp_get_forums_slug() … … 23 23 * Return the forums component slug. 24 24 * 25 * @since BuddyPress (1.5.0)25 * @since 1.5.0 26 26 * 27 27 * @return string Slug for the forums component. … … 31 31 * Filters the forums component slug. 32 32 * 33 * @since BuddyPress (1.5.0)33 * @since 1.5.0 34 34 * 35 35 * @param string $slug Forums component slug. … … 41 41 * Output the forums component root slug. 42 42 * 43 * @since BuddyPress (1.5.0)43 * @since 1.5.0 44 44 * 45 45 * @uses bp_get_forums_root_slug() … … 51 51 * Return the forums component root slug. 52 52 * 53 * @since BuddyPress (1.5.0)53 * @since 1.5.0 54 54 * 55 55 * @return string Root slug for the forums component. … … 59 59 * Filters the forums component root slug. 60 60 * 61 * @since BuddyPress (1.5.0)61 * @since 1.5.0 62 62 * 63 63 * @param string $root_slug Forums component root slug. … … 69 69 * Output permalink for the forum directory. 70 70 * 71 * @since BuddyPress (1.5.0)71 * @since 1.5.0 72 72 * 73 73 * @uses bp_get_forums_directory_permalink() … … 79 79 * Return permalink for the forum directory. 80 80 * 81 * @since BuddyPress (1.5.0)81 * @since 1.5.0 82 82 * 83 83 * @uses apply_filters() … … 93 93 * Filters the permalink for the forum directory. 94 94 * 95 * @since BuddyPress (1.5.0)95 * @since 1.5.0 96 96 * 97 97 * @param string $value Permalink for the forum directory. … … 258 258 * Filters the forums template topics. 259 259 * 260 * @since BuddyPress (1.1.0)260 * @since 1.1.0 261 261 * 262 262 * @param array $topics Array of topics being set for display. … … 318 318 * Filters the topic count for the forum being displayed. 319 319 * 320 * @since BuddyPress (1.1.0)320 * @since 1.1.0 321 321 * 322 322 * @param int $topic_count Topic count to be displayed. … … 334 334 * Filters the total topic count for the forum being displayed. 335 335 * 336 * @since BuddyPress (1.1.0)336 * @since 1.1.0 337 337 * 338 338 * @param int $total_topic_count Total topic count found. … … 420 420 * Fires right before the rewinding of user topics. 421 421 * 422 * @since BuddyPress (1.5.0)422 * @since 1.5.0 423 423 */ 424 424 do_action('forum_loop_end'); … … 448 448 * Fires if the current topic item is the first in the topic loop. 449 449 * 450 * @since BuddyPress (1.5.0)450 * @since 1.5.0 451 451 */ 452 452 do_action( 'forum_loop_start' ); … … 663 663 * Filters whether or not there are topics to display. 664 664 * 665 * @since BuddyPress (1.1.0)665 * @since 1.1.0 666 666 * 667 667 * @param bool $value Whether or not there are topics to display. … … 712 712 * Filters the ID of the current topic in the loop. 713 713 * 714 * @since BuddyPress (1.0.0)714 * @since 1.0.0 715 715 * 716 716 * @param int $topic_id ID for the current topic. … … 736 736 * Filters the title of the current topic in the loop. 737 737 * 738 * @since BuddyPress (1.0.0)738 * @since 1.0.0 739 739 * 740 740 * @param string $topic_title Title for the current topic. … … 760 760 * Filters the slug of the current topic in the loop. 761 761 * 762 * @since BuddyPress (1.0.0)762 * @since 1.0.0 763 763 * 764 764 * @param string $topic_slug Slug for the current topic. … … 786 786 * Filters the text of the first post in the current topic in the loop. 787 787 * 788 * @since BuddyPress (1.1.0)788 * @since 1.1.0 789 789 * 790 790 * @param string $post_text Text for the first post in the current topic. … … 810 810 * Filters the ID of the user who posted the current topic in the loop. 811 811 * 812 * @since BuddyPress (1.0.0)812 * @since 1.0.0 813 813 * 814 814 * @param int $topic_poster ID for the user. … … 861 861 * Filters the avatar for the user who posted the current topic in the loop. 862 862 * 863 * @since BuddyPress (1.0.0)863 * @since 1.0.0 864 864 * 865 865 * @param string $value HTML for the display of the user's avatar. … … 890 890 * Filters the name of the user who posted the current topic in the loop. 891 891 * 892 * @since BuddyPress (1.0.0)892 * @since 1.0.0 893 893 * 894 894 * @param string $name Name for the user who posted the current topic. … … 918 918 * Objects are things like associated groups. 919 919 * 920 * @since BuddyPress (1.1.0)920 * @since 1.1.0 921 921 * 922 922 * @param int $object_id ID for the object associated with the current topic. … … 953 953 * name of the group associated with the forum topic, if it exists. 954 954 * 955 * @since BuddyPress (1.1.0)955 * @since 1.1.0 956 956 * 957 957 * @param string $retval Name for the object associated with the current topic. … … 983 983 * slug of the group associated with the forum topic, if it exists. 984 984 * 985 * @since BuddyPress (1.1.0)985 * @since 1.1.0 986 986 * 987 987 * @param string $object_slug Slug for the object associated with the current topic. … … 1019 1019 * slug of the group associated with the forum topic, if it exists. 1020 1020 * 1021 * @since BuddyPress (1.1.0)1021 * @since 1.1.0 1022 1022 * 1023 1023 * @param string $permalink Permalink for the object associated with the current topic. … … 1052 1052 * Filters the linked name of the user who last posted to the current topic in the loop. 1053 1053 * 1054 * @since BuddyPress (1.0.0)1054 * @since 1.0.0 1055 1055 * 1056 1056 * @param string $value HTML link to the profile of the user who last posted. … … 1109 1109 * Filters the avatar of the object associated with the current topic in the loop. 1110 1110 * 1111 * @since BuddyPress (1.1.0)1111 * @since 1.1.0 1112 1112 * 1113 1113 * @param string $value HTML output for the object associated with the current topic. … … 1160 1160 * Filters the avatar for the user who last posted to the current topic in the loop. 1161 1161 * 1162 * @since BuddyPress (1.0.0)1162 * @since 1.0.0 1163 1163 * 1164 1164 * @param string $value HTML output for the avatar for the user who last posted. … … 1184 1184 * Filters the start time of the current topic in the loop. 1185 1185 * 1186 * @since BuddyPress (1.0.0)1186 * @since 1.0.0 1187 1187 * 1188 1188 * @param string $topic_start_time Start time for the current topic. … … 1208 1208 * Filters the topic time of the current topic in the loop. 1209 1209 * 1210 * @since BuddyPress (1.0.0)1210 * @since 1.0.0 1211 1211 * 1212 1212 * @param string $topic_time Topic time for the current topic. … … 1232 1232 * Filters the ID of the forum associated with the current topic in the loop. 1233 1233 * 1234 * @since BuddyPress (1.0.0)1234 * @since 1.0.0 1235 1235 * 1236 1236 * @param int $forum_id ID of the forum associated with the current topic. … … 1256 1256 * Filters the status of the current topic in the loop. 1257 1257 * 1258 * @since BuddyPress (1.0.0)1258 * @since 1.0.0 1259 1259 * 1260 1260 * @param string $topic_status Status of the current topic. … … 1280 1280 * Filters whether or not the current topic in the loop is open. 1281 1281 * 1282 * @since BuddyPress (1.0.0)1282 * @since 1.0.0 1283 1283 * 1284 1284 * @param string $topic_open Whether or not the current topic is open. … … 1304 1304 * Filters the ID of the last post in the current topic in the loop. 1305 1305 * 1306 * @since BuddyPress (1.0.0)1306 * @since 1.0.0 1307 1307 * 1308 1308 * @param int $topic_last_post_id ID for the last post in the current topic. … … 1328 1328 * Filters whether or not the current topic in the loop is sticky. 1329 1329 * 1330 * @since BuddyPress (1.0.0)1330 * @since 1.0.0 1331 1331 * 1332 1332 * @param bool $topic_sticky Whether or not the current topic is sticky. … … 1354 1354 * Filters a 'x posts' string with the number of posts in the current topic. 1355 1355 * 1356 * @since BuddyPress (1.0.0)1356 * @since 1.0.0 1357 1357 * 1358 1358 * @param string $value 'X posts' string value for the current topic. … … 1383 1383 * Filters the total number of posts in the current topic in the loop. 1384 1384 * 1385 * @since BuddyPress (1.2.4)1385 * @since 1.2.4 1386 1386 * 1387 1387 * @param int $topic_posts Total number of posts in the current topic. … … 1407 1407 * Filters the tag count for the current topic in the loop. 1408 1408 * 1409 * @since BuddyPress (1.0.0)1409 * @since 1.0.0 1410 1410 * 1411 1411 * @param int $tag_count Tag count for the current topic. … … 1448 1448 * Filters the permalink for the current topic in the loop. 1449 1449 * 1450 * @since BuddyPress (1.0.0)1450 * @since 1.0.0 1451 1451 * 1452 1452 * @param string $value Permalink for the current topic in the loop. … … 1474 1474 * Filters a 'time since' string describing when the current topic was created. 1475 1475 * 1476 * @since BuddyPress (1.0.0)1476 * @since 1.0.0 1477 1477 * 1478 1478 * @param string $value 'Time since' value for the current topic. … … 1511 1511 * Filters an excerpt from the latest post of the current topic in the loop. 1512 1512 * 1513 * @since BuddyPress (1.0.0)1513 * @since 1.0.0 1514 1514 * 1515 1515 * @param string $post Post exceprt for the current topic. … … 1538 1538 * Filters a 'time since' string describing when the last post in the current topic was created. 1539 1539 * 1540 * @since BuddyPress (1.0.0)1540 * @since 1.0.0 1541 1541 * 1542 1542 * @param string $value The 'time since' string for the last post in the current topic. … … 1645 1645 * based on context. 1646 1646 * 1647 * @since BuddyPress (1.2.4)1647 * @since 1.2.4 1648 1648 * 1649 1649 * @param string $value Concatenated classes for the current topic in the loop. … … 1667 1667 * Filters the permalink to the 'personal' topics tab. 1668 1668 * 1669 * @since BuddyPress (1.1.0)1669 * @since 1.1.0 1670 1670 * 1671 1671 * @param string $value Permalink to the 'personal' topics tab. … … 1689 1689 * Filters the permalink to the 'unreplied' topics tab. 1690 1690 * 1691 * @since BuddyPress (1.1.0)1691 * @since 1.1.0 1692 1692 * 1693 1693 * @param string $value Permalink to the 'unreplied' topics tab. … … 1711 1711 * Filters the permalink to the 'popular' topics tab. 1712 1712 * 1713 * @since BuddyPress (1.1.0)1713 * @since 1.1.0 1714 1714 * 1715 1715 * @param string $value Permalink to the 'popular' topics tab. … … 1733 1733 * Filters the link to the forums directory. 1734 1734 * 1735 * @since BuddyPress (1.1.0)1735 * @since 1.1.0 1736 1736 * 1737 1737 * @param string $value Link to the forums directory. … … 1763 1763 * Eg, 'newest', 'popular', etc. 1764 1764 * 1765 * @since BuddyPress (1.1.0)1765 * @since 1.1.0 1766 1766 * 1767 1767 * @param string $value Currently viewed topic list type. … … 1773 1773 * Output the value of bp_get_forum_topic_new_reply_link(). 1774 1774 * 1775 * @since BuddyPress (1.5.0)1775 * @since 1.5.0 1776 1776 */ 1777 1777 function bp_forum_topic_new_reply_link() { … … 1781 1781 * Return the permalink for the New Reply button at the top of forum topics. 1782 1782 * 1783 * @since BuddyPress (1.5.0)1783 * @since 1.5.0 1784 1784 * 1785 1785 * @uses apply_filters() Filter bp_get_forum_topic_new_reply_link to … … 1804 1804 * Filters the permalink for the New Reply button at the top of forum topics. 1805 1805 * 1806 * @since BuddyPress (1.5.0)1806 * @since 1.5.0 1807 1807 * 1808 1808 * @param string $value Permalink for the New Reply button. … … 1847 1847 * Filters the pagination links for the current topic list. 1848 1848 * 1849 * @since BuddyPress (1.0.0)1849 * @since 1.0.0 1850 1850 * 1851 1851 * @param string $pag_links HTML pagination links. … … 1888 1888 * Filters the pagination count for the current topic list. 1889 1889 * 1890 * @since BuddyPress (1.5.0)1890 * @since 1.5.0 1891 1891 * 1892 1892 * @param string $message Pagination count for the current topic list. … … 1985 1985 * this loop. 1986 1986 * 1987 * @since BuddyPress (1.2.0)1987 * @since 1.2.0 1988 1988 * @var stdClass 1989 1989 */ … … 2170 2170 * Fires right before the rewinding of user posts. 2171 2171 * 2172 * @since BuddyPress (1.5.0)2172 * @since 1.5.0 2173 2173 */ 2174 2174 do_action('topic_loop_end'); … … 2197 2197 * Fires if the current post item is the first in the topic loop. 2198 2198 * 2199 * @since BuddyPress (1.5.0)2199 * @since 1.5.0 2200 2200 */ 2201 2201 do_action( 'topic_loop_start' ); … … 2249 2249 * Filters whether or not there are topics to display. 2250 2250 * 2251 * @since BuddyPress (1.1.0)2251 * @since 1.1.0 2252 2252 * 2253 2253 * @param bool $value Whether or not there are topics. … … 2294 2294 * Filters the ID of the current post in the loop. 2295 2295 * 2296 * @since BuddyPress (1.0.0)2296 * @since 1.0.0 2297 2297 * 2298 2298 * @param int $post_id ID of the current post. … … 2318 2318 * Filters the content of the current post in the loop. 2319 2319 * 2320 * @since BuddyPress (1.0.0)2320 * @since 1.0.0 2321 2321 * 2322 2322 * @param string $post_text The content of the current post. … … 2360 2360 * based on context. 2361 2361 * 2362 * @since BuddyPress (1.2.4)2362 * @since 1.2.4 2363 2363 * 2364 2364 * @param string $value Concatenated classes for the current post in the loop. … … 2411 2411 * Filters the avatar of the user who posted the current post in the loop. 2412 2412 * 2413 * @since BuddyPress (1.0.0)2413 * @since 1.0.0 2414 2414 * 2415 2415 * @param string $value Avatar of the user who posted the current post. … … 2438 2438 * Filters the name of the user who posted the current post in the loop. 2439 2439 * 2440 * @since BuddyPress (1.0.0)2440 * @since 1.0.0 2441 2441 * 2442 2442 * @param string $value HTML link for the poster's name. … … 2463 2463 * Filters a link to the profile of the user who posted the current post. 2464 2464 * 2465 * @since BuddyPress (1.2.1)2465 * @since 1.2.1 2466 2466 * 2467 2467 * @param string $value Link for the current poster's profile. … … 2489 2489 * Filters the 'since' string describing when the current post in the loop was posted. 2490 2490 * 2491 * @since BuddyPress (1.0.0)2491 * @since 1.0.0 2492 2492 * 2493 2493 * @param string $value The 'since' string. … … 2558 2558 * Filters the admin links for the current post in the loop. 2559 2559 * 2560 * @since BuddyPress (1.2.7)2560 * @since 1.2.7 2561 2561 * 2562 2562 * @param string $value HTML string containing the admin links for the current post. … … 2582 2582 * Filters the text to edit when editing a post. 2583 2583 * 2584 * @since BuddyPress (1.2.4)2584 * @since 1.2.4 2585 2585 * 2586 2586 * @param string $value The text to edit when editing a post. … … 2607 2607 * Filters the pagination links for the current topic page. 2608 2608 * 2609 * @since BuddyPress (1.0.0)2609 * @since 1.0.0 2610 2610 * 2611 2611 * @param string $pag_links HTML pagination links. … … 2638 2638 * Filters the pagination count for the current topic page. 2639 2639 * 2640 * @since BuddyPress (1.0.0)2640 * @since 1.0.0 2641 2641 * 2642 2642 * @param string $message Pagination count for the current topic page. … … 2666 2666 * Filters whether or not a user is on the last page in the current topic. 2667 2667 * 2668 * @since BuddyPress (1.2.0)2668 * @since 1.2.0 2669 2669 * 2670 2670 * @param bool $value Whether or not user is on last page. … … 2688 2688 * Filters the forums directory search form. 2689 2689 * 2690 * @since BuddyPress (1.9.0)2690 * @since 1.9.0 2691 2691 * 2692 2692 * @param string HTML search form for the forums directory. … … 2732 2732 * Filters the permalink to a given forum. 2733 2733 * 2734 * @since BuddyPress (1.0.0)2734 * @since 1.0.0 2735 2735 * 2736 2736 * @param string $value Peramlink to the given forum. … … 2769 2769 * Filters the name of a given forum. 2770 2770 * 2771 * @since BuddyPress (1.5.0)2771 * @since 1.5.0 2772 2772 * 2773 2773 * @param string $forum_name Name of the given forum. … … 2811 2811 * Output the current topic's tag list, commaseparated 2812 2812 * 2813 * @since BuddyPress (1.5.0)2813 * @since 1.5.0 2814 2814 */ 2815 2815 function bp_forum_topic_tag_list() { … … 2819 2819 * Get the current topic's tag list. 2820 2820 * 2821 * @since BuddyPress (1.5.0)2821 * @since 1.5.0 2822 2822 * 2823 2823 * @param string $format 'string' returns commaseparated string; … … 2844 2844 * Filters the current topic's tag list. 2845 2845 * 2846 * @since BuddyPress (1.5.0)2846 * @since 1.5.0 2847 2847 * 2848 2848 * @param stringarray $tags List or array of tags for the current topic. … … 2855 2855 * Does the current topic have any tags? 2856 2856 * 2857 * @since BuddyPress (1.5.0)2857 * @since 1.5.0 2858 2858 * 2859 2859 * @return bool True if the current topic has tags, otherwise false. … … 2870 2870 * Filters whether or not a forum topic has any tags. 2871 2871 * 2872 * @since BuddyPress (1.5.0)2872 * @since 1.5.0 2873 2873 * 2874 2874 * @param bool $has_tags Whether or not there are any tags. … … 2894 2894 * Filters the url to use in a forum form 'action'. 2895 2895 * 2896 * @since BuddyPress (1.0.0)2896 * @since 1.0.0 2897 2897 * 2898 2898 * @param string $value URL to use in the forum form 'action'. … … 2917 2917 * Filters the url to use in a forum topic form 'action'. 2918 2918 * 2919 * @since BuddyPress (1.0.0)2919 * @since 1.0.0 2920 2920 * 2921 2921 * @param string $value URL to use in the forum topic form 'action'. … … 2946 2946 * Filters the total topic count for a given user. 2947 2947 * 2948 * @since BuddyPress (1.2.0)2948 * @since 1.2.0 2949 2949 * 2950 2950 * @param int $value Total topic count for the given user. … … 2975 2975 * Filters the total topic count for a given user. 2976 2976 * 2977 * @since BuddyPress (1.2.0)2977 * @since 1.2.0 2978 2978 * 2979 2979 * @param int $value Total topic count for the given user.
Note: See TracChangeset
for help on using the changeset viewer.