Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
09/12/2015 06:03:18 AM (9 years ago)
Author:
tw2113
Message:

Standardizing our @since tags for the Blogs component.

See #6576

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-blogs/bp-blogs-activity.php

    r10011 r10100  
    11<?php
    2 
    32/**
    43 * BuddyPress Blogs Activity.
     
    87 */
    98
    10 // Exit if accessed directly
     9// Exit if accessed directly.
    1110defined( 'ABSPATH' ) || exit;
    1211
     
    1413 * Register activity actions for the blogs component.
    1514 *
    16  * @since BuddyPress (1.0.0)
     15 * @since 1.0.0
    1716 *
    1817 * @return bool|null Returns false if activity component is not active.
     
    5453     * Fires after the registry of the default blog component activity actions.
    5554     *
    56      * @since BuddyPress (1.1.0)
     55     * @since 1.1.0
    5756     */
    5857    do_action( 'bp_blogs_register_activity_actions' );
     
    6362 * Format 'new_blog' activity actions.
    6463 *
    65  * @since BuddyPress (2.0.0)
     64 * @since 2.0.0
    6665 *
    6766 * @param string $action   Static activity action.
     
    9190     * Filters the new blog activity action for the new blog.
    9291     *
    93      * @since BuddyPress (2.0.0)
     92     * @since 2.0.0
    9493     *
    9594     * @param string $action   Constructed activity action.
     
    102101 * Format 'new_blog_post' activity actions.
    103102 *
    104  * @since BuddyPress (2.0.0)
     103 * @since 2.0.0
    105104 *
    106105 * @param string $action   Static activity action.
     
    203202     * Filters the new blog post action for the new blog.
    204203     *
    205      * @since BuddyPress (2.0.0)
     204     * @since 2.0.0
    206205     *
    207206     * @param string $action   Constructed activity action.
     
    214213 * Format 'new_blog_comment' activity actions.
    215214 *
    216  * @since BuddyPress (2.0.0)
     215 * @since 2.0.0
    217216 *
    218217 * @param string $action   Static activity action.
     
    280279     * Filters the new blog comment action for the new blog.
    281280     *
    282      * @since BuddyPress (2.0.0)
     281     * @since 2.0.0
    283282     *
    284283     * @param string $action   Constructed activity action.
     
    293292 * This reduces database overhead during the activity loop.
    294293 *
    295  * @since BuddyPress (2.0.0)
     294 * @since 2.0.0
    296295 *
    297296 * @param array $activities Array of activity items.
     
    325324 * Record blog-related activity to the activity stream.
    326325 *
    327  * @since BuddyPress (1.0.0)
     326 * @since 1.0.0
    328327 *
    329328 * @see bp_activity_add() for description of parameters.
     
    366365         * Filters the action associated with activity for activity stream.
    367366         *
    368          * @since BuddyPress (1.2.0)
     367         * @since 1.2.0
    369368         *
    370369         * @param string $value Action for the activity stream.
     
    378377         * Filters the content associated with activity for activity stream.
    379378         *
    380          * @since BuddyPress (1.2.0)
     379         * @since 1.2.0
    381380         *
    382381         * @param string $value Generated summary from content for the activity stream.
     
    402401 * Delete a blog-related activity stream item.
    403402 *
    404  * @since BuddyPress (1.0.0)
     403 * @since 1.0.0
    405404 *
    406405 * @see bp_activity_delete() for description of parameters.
     
    443442 * multiple {@link switch_to_blog()} calls in the activity stream.
    444443 *
    445  * @since BuddyPress (2.0.0)
     444 * @since 2.0.0
    446445 *
    447446 * @param object $activity The BP_Activity_Activity object
     
    529528 * For blog post -> activity comment, see {@link bp_blogs_record_comment()}.
    530529 *
    531  * @since BuddyPress (2.0.0)
     530 * @since 2.0.0
    532531 *
    533532 * @param int    $comment_id      The activity ID for the posted activity comment.
     
    617616     * Fires after activity comments have been synced and posted as blog comments.
    618617     *
    619      * @since BuddyPress (2.0.0)
     618     * @since 2.0.0
    620619     *
    621620     * @param int    $comment_id      The activity ID for the posted activity comment.
     
    635634 * activity comment children before they are deleted.
    636635 *
    637  * @since BuddyPress (2.0.0)
     636 * @since 2.0.0
    638637 *
    639638 * @param bool $retval
     
    683682 * Updates the blog comment when the associated activity comment is edited.
    684683 *
    685  * @since BuddyPress (2.0.0)
     684 * @since 2.0.0
    686685 *
    687686 * @param BP_Activity_Activity $activity The activity object.
     
    740739 * activity comment IDs from each comment's meta when a post is trashed.
    741740 *
    742  * @since BuddyPress (2.0.0)
     741 * @since 2.0.0
    743742 *
    744743 * @param int   $post_id  The post ID.
     
    771770 * API.
    772771 *
    773  * @since BuddyPress (2.1.0)
     772 * @since 2.1.0
    774773 *
    775774 * @param array $args Arguments passed from bp_parse_args() in bp_has_activities().
     
    843842 * This is to prevent having to requery these items later on.
    844843 *
    845  * @since BuddyPress (2.0.0)
     844 * @since 2.0.0
    846845 *
    847846 * @see bp_blogs_disable_activity_commenting()
     
    895894 * Set up some globals used in the activity comment loop when AJAX is used.
    896895 *
    897  * @since BuddyPress (2.0.0)
     896 * @since 2.0.0
    898897 *
    899898 * @see bp_blogs_setup_activity_loop_globals()
     
    927926 *  - the activity entry is a 'new_blog_comment' type
    928927 *
    929  * @since BuddyPress (2.0.0)
     928 * @since 2.0.0
    930929 *
    931930 * @param bool $retval Is activity commenting enabled for this activity entry?
     
    979978 * via {@link bp_blogs_setup_activity_loop_globals()}.
    980979 *
    981  * @since BuddyPress (2.0.0)
     980 * @since 2.0.0
    982981 *
    983982 * @param bool   $retval  Are replies allowed for this activity reply?
     
    10181017 * activity item is a 'new_blog_post' entry.
    10191018 *
    1020  * @since BuddyPress (2.0.0)
     1019 * @since 2.0.0
    10211020 *
    10221021 * @param string $retval The activity comment permalink.
     
    10461045 * This is only done if the activity comment is associated with a blog comment.
    10471046 *
    1048  * @since BuddyPress (2.0.1)
     1047 * @since 2.0.1
    10491048 *
    10501049 * @param string               $retval   The activity permalink.
     
    10731072 * This is only done if the activity comment is associated with a blog comment.
    10741073 *
    1075  * @since BuddyPress (2.0.1)
     1074 * @since 2.0.1
    10761075 *
    10771076 * @param string               $retval   The activity action.
Note: See TracChangeset for help on using the changeset viewer.