Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
09/27/2015 05:25:02 AM (9 years ago)
Author:
tw2113
Message:

Standardizing our @since tags for the Groups Component.

See #6576.

File:
1 edited

Legend:

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

    r9906 r10148  
    11<?php
    2 
    32/**
    43 * BuddyPress Groups Forums.
     
    1514 */
    1615
    17 // Exit if accessed directly
     16// Exit if accessed directly.
    1817defined( 'ABSPATH' ) || exit;
    1918
     
    2322 * Uses the bundled version of bbPress packaged with BuddyPress.
    2423 *
    25  * @since BuddyPress (1.0.0)
     24 * @since 1.0.0
    2625 *
    2726 * @param int    $group_id   The group ID that the new forum should be attached to.
     
    5352     * Fires after the creation of a new forum inside a specific BuddyPress group.
    5453     *
    55      * @since BuddyPress (1.0.0)
     54     * @since 1.0.0
    5655     *
    5756     * @param int $forum_id ID of the newly created forum.
     
    6463 * Update group forum metadata (title, description, slug) when the group's details are edited.
    6564 *
    66  * @since BuddyPress (1.1.0)
     65 * @since 1.1.0
    6766 *
    6867 * @param int $group_id Group id, passed from groups_details_updated.
     
    8887     * Filters the group forum metadata value argument.
    8988     *
    90      * @since BuddyPress (1.2.5)
     89     * @since 1.2.5
    9190     *
    9291     * @param array $value Array of metadata values to update the group forum with.
     
    106105 * Uses the bundled version of bbPress packaged with BuddyPress.
    107106 *
    108  * @since BuddyPress (1.0.0)
     107 * @since 1.0.0
    109108 *
    110109 * @param string $post_text The text for the forum post.
     
    124123     * Filters the text for the forum post before save.
    125124     *
    126      * @since BuddyPress (1.2.0)
     125     * @since 1.2.0
    127126     *
    128127     * @param string $post_text Text for the forum post.
     
    133132     * Filters the ID for the forum post before save.
    134133     *
    135      * @since BuddyPress (1.2.0)
     134     * @since 1.2.0
    136135     *
    137136     * @param int $topic_id ID of the topic the post will be associated with.
     
    159158     * Filters the new groups activity forum post action.
    160159     *
    161      * @since BuddyPress (1.2.0)
     160     * @since 1.2.0
    162161     *
    163162     * @param string $activity_action Formatted action related to group activity posting.
     
    171170     * Filters the new groups activity forum post content.
    172171     *
    173      * @since BuddyPress (1.2.0)
     172     * @since 1.2.0
    174173     *
    175174     * @param string $activity_content Excerpt-length activity content to be posted.
     
    183182     * Filters the new groups activity forum post primary link.
    184183     *
    185      * @since BuddyPress (1.1.0)
     184     * @since 1.1.0
    186185     *
    187186     * @param string $value URL to the newly posted forum post.
     
    201200     * Fires after the creation of a new group forum topic post.
    202201     *
    203      * @since BuddyPress (1.0.0)
     202     * @since 1.0.0
    204203     *
    205204     * @param int $value   ID of the current group.
     
    216215 * Uses the bundled version of bbPress packaged with BuddyPress.
    217216 *
    218  * @since BuddyPress (1.0.0)
     217 * @since 1.0.0
    219218 *
    220219 * @param string $topic_title The title for the forum topic.
     
    232231     * Filters the new groups forum topic title before saving.
    233232     *
    234      * @since BuddyPress (1.2.0)
     233     * @since 1.2.0
    235234     *
    236235     * @param string $topic_title The title for the forum topic.
     
    241240     * Filters the new groups forum topic text before saving.
    242241     *
    243      * @since BuddyPress (1.2.0)
     242     * @since 1.2.0
    244243     *
    245244     * @param string $topic_text The text for the forum topic.
     
    250249     * Filters the new groups forum topic tags before saving.
    251250     *
    252      * @since BuddyPress (1.2.0)
     251     * @since 1.2.0
    253252     *
    254253     * @param string $topic_tags A comma-delimited string of topic tags.
     
    259258     * Filters the forum ID this forum topic resides in.
    260259     *
    261      * @since BuddyPress (1.2.0)
     260     * @since 1.2.0
    262261     *
    263262     * @param string $forum_id The forum ID this forum topic resides in.
     
    282281     * Filters the new groups activity forum topic action.
    283282     *
    284      * @since BuddyPress (1.2.0)
     283     * @since 1.2.0
    285284     *
    286285     * @param string $activity_action Formatted action related to forum topic.
     
    293292     * Filters the new groups activity forum topic content.
    294293     *
    295      * @since BuddyPress (1.2.0)
     294     * @since 1.2.0
    296295     *
    297296     * @param string $activity_content Excerpt-length activity content to be posted.
     
    304303     * Filters the new groups activity forum topic primary link.
    305304     *
    306      * @since BuddyPress (1.1.0)
     305     * @since 1.1.0
    307306     *
    308307     * @param string $value Concatenated primary link.
     
    322321     * Fires after the creation of a new group forum topic.
    323322     *
    324      * @since BuddyPress (1.0.0)
     323     * @since 1.0.0
    325324     *
    326325     * @param int    $value ID of the current group.
     
    337336 * Uses the bundled version of bbPress packaged with BuddyPress.
    338337 *
    339  * @since BuddyPress (1.1.0)
     338 * @since 1.1.0
    340339 *
    341340 * @param int    $topic_id    The topic ID of the existing forum topic.
     
    402401     * Fires after the update of a group forum topic.
    403402     *
    404      * @since BuddyPress (1.1.0)
     403     * @since 1.1.0
    405404     *
    406405     * @param object $topic Object holding current topic being updated. Passed by reference.
     
    416415 * Uses the bundled version of bbPress packaged with BuddyPress.
    417416 *
    418  * @since BuddyPress (1.1.0)
     417 * @since 1.1.0
    419418 *
    420419 * @param int    $post_id   The post ID of the existing forum post.
     
    490489     * Fires after the update of a group forum post.
    491490     *
    492      * @since BuddyPress (1.1.0)
     491     * @since 1.1.0
    493492     *
    494493     * @param object $post  Object holding current post being updated.
     
    505504 * Uses the bundled version of bbPress packaged with BuddyPress.
    506505 *
    507  * @since BuddyPress (1.1.0)
     506 * @since 1.1.0
    508507 *
    509508 * @param int $topic_id The ID of the topic to be deleted.
     
    523522         * Fires before the deletion of a group forum topic.
    524523         *
    525          * @since BuddyPress (1.2.9)
     524         * @since 1.2.9
    526525         *
    527526         * @param int $topic_id ID of the topic to be deleted.
     
    554553         * Fires after the deletion of a group forum topic.
    555554         *
    556          * @since BuddyPress (1.1.0)
     555         * @since 1.1.0
    557556         *
    558557         * @param int $topic_id ID of the topic that was deleted.
     
    569568 * Uses the bundled version of bbPress packaged with BuddyPress.
    570569 *
    571  * @since BuddyPress (1.1.0)
     570 * @since 1.1.0
    572571 *
    573572 * @param int      $post_id  The ID of the post you want to delete.
     
    587586         * Fires before the deletion of a group forum post.
    588587         *
    589          * @since BuddyPress (1.5.0)
     588         * @since 1.5.0
    590589         *
    591590         * @param int $post_id  ID of the post to be deleted.
     
    607606         * Fires after the deletion of a group forum post.
    608607         *
    609          * @since BuddyPress (1.1.0)
     608         * @since 1.1.0
    610609         *
    611610         * @param int $post_id  ID of the post that was deleted.
     
    621620 * Get a total count of all public topics of a given type, across groups/forums.
    622621 *
    623  * @since BuddyPress (1.5.0)
     622 * @since 1.5.0
    624623 *
    625624 * @param string $type Either 'newest', 'popular', 'unreplied', 'tags'.
     
    633632     * Filters the total count of all public topics of a given type, across groups/forums.
    634633     *
    635      * @since BuddyPress (1.1.0)
     634     * @since 1.1.0
    636635     *
    637636     * @param int $value Total count of all public topics.
     
    643642 * Get a total count of all topics of a given status, across groups/forums.
    644643 *
    645  * @since BuddyPress (1.5.0)
     644 * @since 1.5.0
    646645 *
    647646 * @param string      $status       Which groups to count. 'public', 'private', 'hidden',
     
    656655     * Filters the total count of all topics of a given status, across groups/forums.
    657656     *
    658      * @since BuddyPress (1.5.0)
     657     * @since 1.5.0
    659658     *
    660659     * @param int $value Total count of all topics.
Note: See TracChangeset for help on using the changeset viewer.