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-functions.php

    r9819 r10096  
    44 *
    55 * @package BuddyPress
    6  * @subpackage Forums
    7  */
    8 
    9 // Exit if accessed directly
     6 * @subpackage ForumsFunctions
     7 */
     8
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
     
    1515 * Is see bbPress 2.x is installed and active?
    1616 *
    17  * @since BuddyPress (1.6.0)
     17 * @since 1.6.0
    1818 *
    1919 * @return boolean True if bbPress 2.x is active, false if not.
     
    4141 * the referenced file exists.
    4242 *
    43  * @since BuddyPress (1.2.0)
     43 * @since 1.2.0
    4444 *
    4545 * @return boolean True if option exists, false if not.
     
    5959 * Checks $bp pages global and looks for directory page
    6060 *
    61  * @since BuddyPress (1.5.0)
     61 * @since 1.5.0
    6262 *
    6363 * @global BuddyPress $bp The one true BuddyPress instance.
     
    244244     * Filters the found forum topics for provided arguments.
    245245     *
    246      * @since BuddyPress (1.1.0)
     246     * @since 1.1.0
    247247     *
    248248     * @param array $topics Array of found topics. Passed by reference.
     
    361361     * Fires after a new forum topic has been created.
    362362     *
    363      * @since BuddyPress (1.0.0)
     363     * @since 1.0.0
    364364     *
    365365     * @param int $topic_id ID of the newly created topic post.
     
    514514     * Filters the total topic count for the site.
    515515     *
    516      * @since BuddyPress (1.5.0)
     516     * @since 1.5.0
    517517     *
    518518     * @param int $count Total topic count.
     
    526526 * Used to prevent dupes.
    527527 *
    528  * @since BuddyPress (1.6.0)
     528 * @since 1.6.0
    529529 *
    530530 * @param string $text The text of the comment.
     
    564564     * Filters whether a user has already left this particular reply on a given post.
    565565     *
    566      * @since BuddyPress (1.6.0)
     566     * @since 1.6.0
    567567     *
    568568     * @param bool   $reply_exists Whether or not a reply exists.
     
    577577     *
    578578     * @access private
    579      * @since BuddyPress (1.7.0)
     579     * @since 1.7.0
    580580     *
    581581     * @global WPDB $wpdb WordPress database access object.
     
    632632 * BB_Query.
    633633 *
    634  * @since BuddyPress (1.5.0)
     634 * @since 1.5.0
    635635 *
    636636 * @param int $user_id ID of the user whose replied topics are being counted.
     
    675675     * Filters the total number of topics replied to by a given user.
    676676     *
    677      * @since BuddyPress (1.5.0)
     677     * @since 1.5.0
    678678     *
    679679     * @param int $count   Total number of topics replied to by a given user.
     
    886886         * Fires if there was a new post created.
    887887         *
    888          * @since BuddyPress (1.0.0)
     888         * @since 1.0.0
    889889         *
    890890         * @param int $post_id ID of the newly created forum post.
     
    946946     * Filters BP-specific details about a set of posts.
    947947     *
    948      * @since BuddyPress (1.5.0)
     948     * @since 1.5.0
    949949     *
    950950     * @param array $posts Array of posts holding BP-specific details.
     
    998998 * Return the parent forum ID for the bbPress abstraction layer.
    999999 *
    1000  * @since BuddyPress (1.5.0)
     1000 * @since 1.5.0
    10011001 *
    10021002 * @return int Forum ID.
     
    10071007     * Filters the parent forum ID for the bbPress abstraction layer.
    10081008     *
    1009      * @since BuddyPress (1.5.0)
     1009     * @since 1.5.0
    10101010     *
    10111011     * @param int BP_FORUMS_PARENT_FORUM_ID The Parent forum ID constant.
     
    10201020 * filter 'bp_forums_enable_global_directory_stickies', to change this behavior.
    10211021 *
    1022  * @since BuddyPress (1.5.0)
     1022 * @since 1.5.0
    10231023 *
    10241024 * @return bool True if stickies should be displayed at the top of the global
     
    10301030     * Filters whether or not sticky topics should be broken out of regular topic order.
    10311031     *
    1032      * @since BuddyPress (1.5.0)
     1032     * @since 1.5.0
    10331033     *
    10341034     * @param bool $value Whether or not to break out of topic order.
     
    10591059 * during the forum topic loop.  If no cache and link is embeddable, cache it.
    10601060 *
    1061  * @since BuddyPress (1.5.0)
     1061 * @since 1.5.0
    10621062 *
    10631063 * @see BP_Embed
     
    10781078 *
    10791079 * @package BuddyPress_Forums
    1080  * @since BuddyPress (1.5.0)
     1080 * @since 1.5.0
    10811081 */
    10821082function bp_embed_forum_cache( $cache, $id, $cachekey ) {
     
    10891089 * Wrapper function for {@link bb_update_postmeta()}.
    10901090 *
    1091  * @since BuddyPress (1.5.0)
     1091 * @since 1.5.0
    10921092 */
    10931093function bp_embed_forum_save_cache( $cache, $cachekey, $id ) {
Note: See TracChangeset for help on using the changeset viewer.