Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
08/31/2015 06:51:35 AM (11 years ago)
Author:
tw2113
Message:

Standardizing our @since tags for the Activity component.

See #6576.

File:
1 edited

Legend:

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

    r9843 r10077  
    11<?php
    2 
    32/**
    43 * Action functions are exactly the same as screen functions, however they do
    … …  
    1615 * Allow core components and dependent plugins to register activity actions.
    1716 *
    18  * @since BuddyPress (1.2.0)
     17 * @since 1.2.0
    1918 *
    2019 * @uses do_action() To call 'bp_register_activity_actions' hook.
    … …  
    2524         * Fires on bp_init to allow core components and dependent plugins to register activity actions.
    2625         *
    27          * @since BuddyPress (1.2.0)
     26         * @since 1.2.0
    2827         */
    2928        do_action( 'bp_register_activity_actions' );
    … …  
    3433 * Catch and route requests for single activity item permalinks.
    3534 *
    36  * @since BuddyPress (1.2.0)
     35 * @since 1.2.0
    3736 *
    3837 * @uses bp_is_activity_component()
    … …  
    105104         * Filter the intended redirect url before the redirect occurs for the single activity item.
    106105         *
    107          * @since BuddyPress (1.2.2)
     106         * @since 1.2.2
    108107         *
    109108         * @param array Array with url to redirect to and activity related to the redirect.
    … …  
    121120 * Delete specific activity item and redirect to previous page.
    122121 *
    123  * @since BuddyPress (1.1.0)
     122 * @since 1.1.0
    124123 *
    125124 * @param int $activity_id Activity id to be deleted. Defaults to 0.
    … …  
    164163         * Fires before the deletion so plugins can still fetch information about it.
    165164         *
    166          * @since BuddyPress (1.5.0)
     165         * @since 1.5.0
    167166         *
    168167         * @param int $activity_id The activity ID.
    … …  
    180179         * Fires after the deletion so plugins can act afterwards based on the activity.
    181180         *
    182          * @since BuddyPress (1.1.0)
     181         * @since 1.1.0
    183182         *
    184183         * @param int $activity_id The activity ID.
    … …  
    198197 * Mark specific activity item as spam and redirect to previous page.
    199198 *
    200  * @since BuddyPress (1.6.0)
     199 * @since 1.6.0
    201200 *
    202201 * @param int $activity_id Activity id to be deleted. Defaults to 0.
    … …  
    233232         * Fires before the marking activity as spam so plugins can modify things if they want to.
    234233         *
    235          * @since BuddyPress (1.6.0)
     234         * @since 1.6.0
    236235         *
    237236         * @param int    $activity_id Activity ID to be marked as spam.
    … …  
    250249         * Fires after the marking activity as spam so plugins can act afterwards based on the activity.
    251250         *
    252          * @since BuddyPress (1.6.0)
     251         * @since 1.6.0
    253252         *
    254253         * @param int $activity_id Activity ID that was marked as spam.
    … …  
    268267 * Post user/group activity update.
    269268 *
    270  * @since BuddyPress (1.2.0)
     269 * @since 1.2.0
    271270 *
    272271 * @uses is_user_logged_in()
    … …  
    298297         * Filters the content provided in the activity input field.
    299298         *
    300          * @since BuddyPress (1.2.0)
     299         * @since 1.2.0
    301300         *
    302301         * @param string $value Activity message being posted.
    … …  
    309308                 * Filters the item type that the activity update should be associated with.
    310309                 *
    311                  * @since BuddyPress (1.2.0)
     310                 * @since 1.2.0
    312311                 *
    313312                 * @param string $value Item type to associate with.
    … …  
    321320                 * Filters what component the activity is being to.
    322321                 *
    323                  * @since BuddyPress (1.2.0)
     322                 * @since 1.2.0
    324323                 *
    325324                 * @param string $value Chosen component to post activity to.
    … …  
    349348                 * Filters activity object for BuddyPress core and plugin authors before posting activity update.
    350349                 *
    351                  * @since BuddyPress (1.2.0)
     350                 * @since 1.2.0
    352351                 *
    353352                 * @param string $object  Activity item being associated to.
    … …  
    372371 * Post new activity comment.
    373372 *
    374  * @since BuddyPress (1.2.0)
     373 * @since 1.2.0
    375374 *
    376375 * @uses is_user_logged_in()
    … …  
    398397         * Filters the activity ID a comment will be in reply to.
    399398         *
    400          * @since BuddyPress (1.2.0)
     399         * @since 1.2.0
    401400         *
    402401         * @param string $value ID of the activity being replied to.
    … …  
    407406         * Filters the comment content for a comment reply.
    408407         *
    409          * @since BuddyPress (1.2.0)
     408         * @since 1.2.0
    410409         *
    411410         * @param string $value Comment content being posted.
    … …  
    436435 * Mark activity as favorite.
    437436 *
    438  * @since BuddyPress (1.2.0)
     437 * @since 1.2.0
    439438 *
    440439 * @uses is_user_logged_in()
    … …  
    470469 * Remove activity from favorites.
    471470 *
    472  * @since BuddyPress (1.2.0)
     471 * @since 1.2.0
    473472 *
    474473 * @uses is_user_logged_in()
    … …  
    504503 * Load the sitewide activity feed.
    505504 *
    506  * @since BuddyPress (1.0.0)
     505 * @since 1.0.0
    507506 *
    508507 * @uses bp_is_activity_component()
    … …  
    536535 * Load a user's personal activity feed.
    537536 *
    538  * @since BuddyPress (1.0.0)
     537 * @since 1.0.0
    539538 *
    540539 * @uses bp_is_user_activity()
    … …  
    566565 * Load a user's friends' activity feed.
    567566 *
    568  * @since BuddyPress (1.0.0)
     567 * @since 1.0.0
    569568 *
    570569 * @uses bp_is_active()
    … …  
    599598 * Load the activity feed for a user's groups.
    600599 *
    601  * @since BuddyPress (1.2.0)
     600 * @since 1.2.0
    602601 *
    603602 * @uses bp_is_active()
    … …  
    640639 * Load a user's @mentions feed.
    641640 *
    642  * @since BuddyPress (1.2.0)
     641 * @since 1.2.0
    643642 *
    644643 * @uses bp_is_user_activity()
    … …  
    677676 * Load a user's favorites feed.
    678677 *
    679  * @since BuddyPress (1.2.0)
     678 * @since 1.2.0
    680679 *
    681680 * @uses bp_is_user_activity()
    … …  
    712711 * Loads Akismet filtering for activity.
    713712 *
    714  * @since BuddyPress (1.6.0)
    715  * @since BuddyPress (2.3.0) We only support Akismet 3+.
     713 * @since 1.6.0
     714 * @since 2.3.0 We only support Akismet 3+.
    716715 */
    717716function bp_activity_setup_akismet() {
    … …  
    736735         * Filters if BuddyPress Activity Akismet support has been disabled by another plugin.
    737736         *
    738          * @since BuddyPress (1.6.0)
     737         * @since 1.6.0
    739738         *
    740739         * @param bool $value Return value of bp_is_akismet_active boolean function.
    … …  
    751750 * AJAX endpoint for Suggestions API lookups.
    752751 *
    753  * @since BuddyPress (2.1.0)
     752 * @since 2.1.0
    754753 */
    755754function bp_ajax_get_suggestions() {
    … …  
    783782 * Detect a change in post type status, and initiate an activity update if necessary.
    784783 *
    785  * @since BuddyPress (2.2.0)
     784 * @since 2.2.0
    786785 *
    787786 * @todo Support untrashing better.
    … …  
    817816                         * being untrashed.
    818817                         *
    819                          * @since BuddyPress (2.2.0)
     818                         * @since 2.2.0
    820819                         *
    821820                         * @param WP_Post $post Post data.
Note: See TracChangeset for help on using the changeset viewer.