Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
09/12/2015 05:51:55 AM (9 years ago)
Author:
tw2113
Message:

Standardizing our @since tags for the Forums component.

See #6576

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-forums/bp-forums-template.php

    r9848 r10096  
    44 *
    55 * @package BuddyPress
    6  * @subpackage Forums
    7  */
    8 
    9 // Exit if accessed directly
     6 * @subpackage ForumsTemplate
     7 */
     8
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
     
    1313 * Output the forums component slug.
    1414 *
    15  * @since BuddyPress (1.5.0)
     15 * @since 1.5.0
    1616 *
    1717 * @uses bp_get_forums_slug()
     
    2323     * Return the forums component slug.
    2424     *
    25      * @since BuddyPress (1.5.0)
     25     * @since 1.5.0
    2626     *
    2727     * @return string Slug for the forums component.
     
    3131         * Filters the forums component slug.
    3232         *
    33          * @since BuddyPress (1.5.0)
     33         * @since 1.5.0
    3434         *
    3535         * @param string $slug Forums component slug.
     
    4141 * Output the forums component root slug.
    4242 *
    43  * @since BuddyPress (1.5.0)
     43 * @since 1.5.0
    4444 *
    4545 * @uses bp_get_forums_root_slug()
     
    5151     * Return the forums component root slug.
    5252     *
    53      * @since BuddyPress (1.5.0)
     53     * @since 1.5.0
    5454     *
    5555     * @return string Root slug for the forums component.
     
    5959         * Filters the forums component root slug.
    6060         *
    61          * @since BuddyPress (1.5.0)
     61         * @since 1.5.0
    6262         *
    6363         * @param string $root_slug Forums component root slug.
     
    6969 * Output permalink for the forum directory.
    7070 *
    71  * @since BuddyPress (1.5.0)
     71 * @since 1.5.0
    7272 *
    7373 * @uses bp_get_forums_directory_permalink()
     
    7979     * Return permalink for the forum directory.
    8080     *
    81      * @since BuddyPress (1.5.0)
     81     * @since 1.5.0
    8282     *
    8383     * @uses apply_filters()
     
    9393         * Filters the permalink for the forum directory.
    9494         *
    95          * @since BuddyPress (1.5.0)
     95         * @since 1.5.0
    9696         *
    9797         * @param string $value Permalink for the forum directory.
     
    258258         * Filters the forums template topics.
    259259         *
    260          * @since BuddyPress (1.1.0)
     260         * @since 1.1.0
    261261         *
    262262         * @param array  $topics      Array of topics being set for display.
     
    318318         * Filters the topic count for the forum being displayed.
    319319         *
    320          * @since BuddyPress (1.1.0)
     320         * @since 1.1.0
    321321         *
    322322         * @param int    $topic_count Topic count to be displayed.
     
    334334         * Filters the total topic count for the forum being displayed.
    335335         *
    336          * @since BuddyPress (1.1.0)
     336         * @since 1.1.0
    337337         *
    338338         * @param int    $total_topic_count Total topic count found.
     
    420420             * Fires right before the rewinding of user topics.
    421421             *
    422              * @since BuddyPress (1.5.0)
     422             * @since 1.5.0
    423423             */
    424424            do_action('forum_loop_end');
     
    448448             * Fires if the current topic item is the first in the topic loop.
    449449             *
    450              * @since BuddyPress (1.5.0)
     450             * @since 1.5.0
    451451             */
    452452            do_action( 'forum_loop_start' );
     
    663663     * Filters whether or not there are topics to display.
    664664     *
    665      * @since BuddyPress (1.1.0)
     665     * @since 1.1.0
    666666     *
    667667     * @param bool   $value          Whether or not there are topics to display.
     
    712712         * Filters the ID of the current topic in the loop.
    713713         *
    714          * @since BuddyPress (1.0.0)
     714         * @since 1.0.0
    715715         *
    716716         * @param int $topic_id ID for the current topic.
     
    736736         * Filters the title of the current topic in the loop.
    737737         *
    738          * @since BuddyPress (1.0.0)
     738         * @since 1.0.0
    739739         *
    740740         * @param string $topic_title Title for the current topic.
     
    760760         * Filters the slug of the current topic in the loop.
    761761         *
    762          * @since BuddyPress (1.0.0)
     762         * @since 1.0.0
    763763         *
    764764         * @param string $topic_slug Slug for the current topic.
     
    786786         * Filters the text of the first post in the current topic in the loop.
    787787         *
    788          * @since BuddyPress (1.1.0)
     788         * @since 1.1.0
    789789         *
    790790         * @param string $post_text Text for the first post in the current topic.
     
    810810         * Filters the ID of the user who posted the current topic in the loop.
    811811         *
    812          * @since BuddyPress (1.0.0)
     812         * @since 1.0.0
    813813         *
    814814         * @param int $topic_poster ID for the user.
     
    861861         * Filters the avatar for the user who posted the current topic in the loop.
    862862         *
    863          * @since BuddyPress (1.0.0)
     863         * @since 1.0.0
    864864         *
    865865         * @param string $value HTML for the display of the user's avatar.
     
    890890         * Filters the name of the user who posted the current topic in the loop.
    891891         *
    892          * @since BuddyPress (1.0.0)
     892         * @since 1.0.0
    893893         *
    894894         * @param string $name Name for the user who posted the current topic.
     
    918918         * Objects are things like associated groups.
    919919         *
    920          * @since BuddyPress (1.1.0)
     920         * @since 1.1.0
    921921         *
    922922         * @param int $object_id ID for the object associated with the current topic.
     
    953953         * name of the group associated with the forum topic, if it exists.
    954954         *
    955          * @since BuddyPress (1.1.0)
     955         * @since 1.1.0
    956956         *
    957957         * @param string $retval Name for the object associated with the current topic.
     
    983983         * slug of the group associated with the forum topic, if it exists.
    984984         *
    985          * @since BuddyPress (1.1.0)
     985         * @since 1.1.0
    986986         *
    987987         * @param string $object_slug Slug for the object associated with the current topic.
     
    10191019         * slug of the group associated with the forum topic, if it exists.
    10201020         *
    1021          * @since BuddyPress (1.1.0)
     1021         * @since 1.1.0
    10221022         *
    10231023         * @param string $permalink Permalink for the object associated with the current topic.
     
    10521052         * Filters the linked name of the user who last posted to the current topic in the loop.
    10531053         *
    1054          * @since BuddyPress (1.0.0)
     1054         * @since 1.0.0
    10551055         *
    10561056         * @param string $value HTML link to the profile of the user who last posted.
     
    11091109         * Filters the avatar of the object associated with the current topic in the loop.
    11101110         *
    1111          * @since BuddyPress (1.1.0)
     1111         * @since 1.1.0
    11121112         *
    11131113         * @param string $value HTML output for the object associated with the current topic.
     
    11601160         * Filters the avatar for the user who last posted to the current topic in the loop.
    11611161         *
    1162          * @since BuddyPress (1.0.0)
     1162         * @since 1.0.0
    11631163         *
    11641164         * @param string $value HTML output for the avatar for the user who last posted.
     
    11841184         * Filters the start time of the current topic in the loop.
    11851185         *
    1186          * @since BuddyPress (1.0.0)
     1186         * @since 1.0.0
    11871187         *
    11881188         * @param string $topic_start_time Start time for the current topic.
     
    12081208         * Filters the topic time of the current topic in the loop.
    12091209         *
    1210          * @since BuddyPress (1.0.0)
     1210         * @since 1.0.0
    12111211         *
    12121212         * @param string $topic_time Topic time for the current topic.
     
    12321232         * Filters the ID of the forum associated with the current topic in the loop.
    12331233         *
    1234          * @since BuddyPress (1.0.0)
     1234         * @since 1.0.0
    12351235         *
    12361236         * @param int $forum_id ID of the forum associated with the current topic.
     
    12561256         * Filters the status of the current topic in the loop.
    12571257         *
    1258          * @since BuddyPress (1.0.0)
     1258         * @since 1.0.0
    12591259         *
    12601260         * @param string $topic_status Status of the current topic.
     
    12801280         * Filters whether or not the current topic in the loop is open.
    12811281         *
    1282          * @since BuddyPress (1.0.0)
     1282         * @since 1.0.0
    12831283         *
    12841284         * @param string $topic_open Whether or not the current topic is open.
     
    13041304         * Filters the ID of the last post in the current topic in the loop.
    13051305         *
    1306          * @since BuddyPress (1.0.0)
     1306         * @since 1.0.0
    13071307         *
    13081308         * @param int $topic_last_post_id ID for the last post in the current topic.
     
    13281328         * Filters whether or not the current topic in the loop is sticky.
    13291329         *
    1330          * @since BuddyPress (1.0.0)
     1330         * @since 1.0.0
    13311331         *
    13321332         * @param bool $topic_sticky Whether or not the current topic is sticky.
     
    13541354             * Filters a 'x posts' string with the number of posts in the current topic.
    13551355             *
    1356              * @since BuddyPress (1.0.0)
     1356             * @since 1.0.0
    13571357             *
    13581358             * @param string $value 'X posts' string value for the current topic.
     
    13831383         * Filters the total number of posts in the current topic in the loop.
    13841384         *
    1385          * @since BuddyPress (1.2.4)
     1385         * @since 1.2.4
    13861386         *
    13871387         * @param int $topic_posts Total number of posts in the current topic.
     
    14071407         * Filters the tag count for the current topic in the loop.
    14081408         *
    1409          * @since BuddyPress (1.0.0)
     1409         * @since 1.0.0
    14101410         *
    14111411         * @param int $tag_count Tag count for the current topic.
     
    14481448         * Filters the permalink for the current topic in the loop.
    14491449         *
    1450          * @since BuddyPress (1.0.0)
     1450         * @since 1.0.0
    14511451         *
    14521452         * @param string $value Permalink for the current topic in the loop.
     
    14741474         * Filters a 'time since' string describing when the current topic was created.
    14751475         *
    1476          * @since BuddyPress (1.0.0)
     1476         * @since 1.0.0
    14771477         *
    14781478         * @param string $value 'Time since' value for the current topic.
     
    15111511         * Filters an excerpt from the latest post of the current topic in the loop.
    15121512         *
    1513          * @since BuddyPress (1.0.0)
     1513         * @since 1.0.0
    15141514         *
    15151515         * @param string $post   Post exceprt for the current topic.
     
    15381538         * Filters a 'time since' string describing when the last post in the current topic was created.
    15391539         *
    1540          * @since BuddyPress (1.0.0)
     1540         * @since 1.0.0
    15411541         *
    15421542         * @param string $value The 'time since' string for the last post in the current topic.
     
    16451645         * based on context.
    16461646         *
    1647          * @since BuddyPress (1.2.4)
     1647         * @since 1.2.4
    16481648         *
    16491649         * @param string $value Concatenated classes for the current topic in the loop.
     
    16671667         * Filters the permalink to the 'personal' topics tab.
    16681668         *
    1669          * @since BuddyPress (1.1.0)
     1669         * @since 1.1.0
    16701670         *
    16711671         * @param string $value Permalink to the 'personal' topics tab.
     
    16891689         * Filters the permalink to the 'unreplied' topics tab.
    16901690         *
    1691          * @since BuddyPress (1.1.0)
     1691         * @since 1.1.0
    16921692         *
    16931693         * @param string $value Permalink to the 'unreplied' topics tab.
     
    17111711         * Filters the permalink to the 'popular' topics tab.
    17121712         *
    1713          * @since BuddyPress (1.1.0)
     1713         * @since 1.1.0
    17141714         *
    17151715         * @param string $value Permalink to the 'popular' topics tab.
     
    17331733         * Filters the link to the forums directory.
    17341734         *
    1735          * @since BuddyPress (1.1.0)
     1735         * @since 1.1.0
    17361736         *
    17371737         * @param string $value Link to the forums directory.
     
    17631763         * Eg, 'newest', 'popular', etc.
    17641764         *
    1765          * @since BuddyPress (1.1.0)
     1765         * @since 1.1.0
    17661766         *
    17671767         * @param string $value Currently viewed topic list type.
     
    17731773 * Output the value of bp_get_forum_topic_new_reply_link().
    17741774 *
    1775  * @since BuddyPress (1.5.0)
     1775 * @since 1.5.0
    17761776 */
    17771777function bp_forum_topic_new_reply_link() {
     
    17811781     * Return the permalink for the New Reply button at the top of forum topics.
    17821782     *
    1783      * @since BuddyPress (1.5.0)
     1783     * @since 1.5.0
    17841784     *
    17851785     * @uses apply_filters() Filter bp_get_forum_topic_new_reply_link to
     
    18041804         * Filters the permalink for the New Reply button at the top of forum topics.
    18051805         *
    1806          * @since BuddyPress (1.5.0)
     1806         * @since 1.5.0
    18071807         *
    18081808         * @param string $value Permalink for the New Reply button.
     
    18471847         * Filters the pagination links for the current topic list.
    18481848         *
    1849          * @since BuddyPress (1.0.0)
     1849         * @since 1.0.0
    18501850         *
    18511851         * @param string $pag_links HTML pagination links.
     
    18881888         * Filters the pagination count for the current topic list.
    18891889         *
    1890          * @since BuddyPress (1.5.0)
     1890         * @since 1.5.0
    18911891         *
    18921892         * @param string $message  Pagination count for the current topic list.
     
    19851985     * this loop.
    19861986     *
    1987      * @since BuddyPress (1.2.0)
     1987     * @since 1.2.0
    19881988     * @var stdClass
    19891989     */
     
    21702170             * Fires right before the rewinding of user posts.
    21712171             *
    2172              * @since BuddyPress (1.5.0)
     2172             * @since 1.5.0
    21732173             */
    21742174            do_action('topic_loop_end');
     
    21972197             * Fires if the current post item is the first in the topic loop.
    21982198             *
    2199              * @since BuddyPress (1.5.0)
     2199             * @since 1.5.0
    22002200             */
    22012201            do_action( 'topic_loop_start' );
     
    22492249     * Filters whether or not there are topics to display.
    22502250     *
    2251      * @since BuddyPress (1.1.0)
     2251     * @since 1.1.0
    22522252     *
    22532253     * @param bool                     $value          Whether or not there are topics.
     
    22942294         * Filters the ID of the current post in the loop.
    22952295         *
    2296          * @since BuddyPress (1.0.0)
     2296         * @since 1.0.0
    22972297         *
    22982298         * @param int $post_id ID of the current post.
     
    23182318         * Filters the content of the current post in the loop.
    23192319         *
    2320          * @since BuddyPress (1.0.0)
     2320         * @since 1.0.0
    23212321         *
    23222322         * @param string $post_text The content of the current post.
     
    23602360         * based on context.
    23612361         *
    2362          * @since BuddyPress (1.2.4)
     2362         * @since 1.2.4
    23632363         *
    23642364         * @param string $value Concatenated classes for the current post in the loop.
     
    24112411         * Filters the avatar of the user who posted the current post in the loop.
    24122412         *
    2413          * @since BuddyPress (1.0.0)
     2413         * @since 1.0.0
    24142414         *
    24152415         * @param string $value Avatar of the user who posted the current post.
     
    24382438         * Filters the name of the user who posted the current post in the loop.
    24392439         *
    2440          * @since BuddyPress (1.0.0)
     2440         * @since 1.0.0
    24412441         *
    24422442         * @param string $value HTML link for the poster's name.
     
    24632463         * Filters a link to the profile of the user who posted the current post.
    24642464         *
    2465          * @since BuddyPress (1.2.1)
     2465         * @since 1.2.1
    24662466         *
    24672467         * @param string $value Link for the current poster's profile.
     
    24892489         * Filters the 'since' string describing when the current post in the loop was posted.
    24902490         *
    2491          * @since BuddyPress (1.0.0)
     2491         * @since 1.0.0
    24922492         *
    24932493         * @param string $value The 'since' string.
     
    25582558         * Filters the admin links for the current post in the loop.
    25592559         *
    2560          * @since BuddyPress (1.2.7)
     2560         * @since 1.2.7
    25612561         *
    25622562         * @param string $value HTML string containing the admin links for the current post.
     
    25822582         * Filters the text to edit when editing a post.
    25832583         *
    2584          * @since BuddyPress (1.2.4)
     2584         * @since 1.2.4
    25852585         *
    25862586         * @param string $value The text to edit when editing a post.
     
    26072607         * Filters the pagination links for the current topic page.
    26082608         *
    2609          * @since BuddyPress (1.0.0)
     2609         * @since 1.0.0
    26102610         *
    26112611         * @param string $pag_links HTML pagination links.
     
    26382638     * Filters the pagination count for the current topic page.
    26392639     *
    2640      * @since BuddyPress (1.0.0)
     2640     * @since 1.0.0
    26412641     *
    26422642     * @param string $message  Pagination count for the current topic page.
     
    26662666         * Filters whether or not a user is on the last page in the current topic.
    26672667         *
    2668          * @since BuddyPress (1.2.0)
     2668         * @since 1.2.0
    26692669         *
    26702670         * @param bool $value Whether or not user is on last page.
     
    26882688     * Filters the forums directory search form.
    26892689     *
    2690      * @since BuddyPress (1.9.0)
     2690     * @since 1.9.0
    26912691     *
    26922692     * @param string HTML search form for the forums directory.
     
    27322732         * Filters the permalink to a given forum.
    27332733         *
    2734          * @since BuddyPress (1.0.0)
     2734         * @since 1.0.0
    27352735         *
    27362736         * @param string $value Peramlink to the given forum.
     
    27692769             * Filters the name of a given forum.
    27702770             *
    2771              * @since BuddyPress (1.5.0)
     2771             * @since 1.5.0
    27722772             *
    27732773             * @param string $forum_name Name of the given forum.
     
    28112811 * Output the current topic's tag list, comma-separated
    28122812 *
    2813  * @since BuddyPress (1.5.0)
     2813 * @since 1.5.0
    28142814 */
    28152815function bp_forum_topic_tag_list() {
     
    28192819     * Get the current topic's tag list.
    28202820     *
    2821      * @since BuddyPress (1.5.0)
     2821     * @since 1.5.0
    28222822     *
    28232823     * @param string $format 'string' returns comma-separated string;
     
    28442844         * Filters the current topic's tag list.
    28452845         *
    2846          * @since BuddyPress (1.5.0)
     2846         * @since 1.5.0
    28472847         *
    28482848         * @param string|array $tags   List or array of tags for the current topic.
     
    28552855 * Does the current topic have any tags?
    28562856 *
    2857  * @since BuddyPress (1.5.0)
     2857 * @since 1.5.0
    28582858 *
    28592859 * @return bool True if the current topic has tags, otherwise false.
     
    28702870     * Filters whether or not a forum topic has any tags.
    28712871     *
    2872      * @since BuddyPress (1.5.0)
     2872     * @since 1.5.0
    28732873     *
    28742874     * @param bool $has_tags Whether or not there are any tags.
     
    28942894         * Filters the url to use in a forum form 'action'.
    28952895         *
    2896          * @since BuddyPress (1.0.0)
     2896         * @since 1.0.0
    28972897         *
    28982898         * @param string $value URL to use in the forum form 'action'.
     
    29172917         * Filters the url to use in a forum topic form 'action'.
    29182918         *
    2919          * @since BuddyPress (1.0.0)
     2919         * @since 1.0.0
    29202920         *
    29212921         * @param string $value URL to use in the forum topic form 'action'.
     
    29462946         * Filters the total topic count for a given user.
    29472947         *
    2948          * @since BuddyPress (1.2.0)
     2948         * @since 1.2.0
    29492949         *
    29502950         * @param int $value Total topic count for the given user.
     
    29752975         * Filters the total topic count for a given user.
    29762976         *
    2977          * @since BuddyPress (1.2.0)
     2977         * @since 1.2.0
    29782978         *
    29792979         * @param int $value Total topic count for the given user.
Note: See TracChangeset for help on using the changeset viewer.