Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
08/31/2015 06:51:35 AM (9 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-functions.php

    r9853 r10077  
    11<?php
    2 
    32/**
    43 * BuddyPress Activity Functions.
     
    1615 * Check whether the $bp global lists an activity directory page.
    1716 *
    18  * @since BuddyPress (1.5.0)
     17 * @since 1.5.0
    1918 *
    2019 * @return bool True if activity directory page is found, otherwise false.
     
    3938 *   add_filter( 'bp_activity_do_mentions', '__return_false' );
    4039 *
    41  * @since BuddyPress (1.8.0)
     40 * @since 1.8.0
    4241 *
    4342 * @uses apply_filters() To call 'bp_activity_do_mentions' hook.
     
    5049     * Filters whether or not mentions are enabled.
    5150     *
    52      * @since BuddyPress (1.8.0)
     51     * @since 1.8.0
    5352     *
    5453     * @param bool $enabled True to enable mentions, false to disable.
     
    6160 * mentions suggestions?
    6261 *
    63  * @since BuddyPress (2.1.0)
     62 * @since 2.1.0
    6463 *
    6564 * @return bool True if mentions scripts should be loaded.
     
    7271     * Filters whether or not BuddyPress should load mentions scripts and assets.
    7372     *
    74      * @since BuddyPress (2.1.0)
     73     * @since 2.1.0
    7574     *
    7675     * @param bool $load_mentions    True to load mentions assets, false otherwise.
     
    8382 * Locate usernames in an activity content string, as designated by an @ sign.
    8483 *
    85  * @since BuddyPress (1.5.0)
     84 * @since 1.5.0
    8685 *
    8786 * @param string $content The content of the activity, usually found in
     
    126125 * Reset a user's unread mentions list and count.
    127126 *
    128  * @since BuddyPress (1.5.0)
     127 * @since 1.5.0
    129128 *
    130129 * @uses bp_delete_user_meta()
     
    145144 * Currently, only used in {@link bp_activity_delete()}.
    146145 *
    147  * @since BuddyPress (1.5.0)
     146 * @since 1.5.0
    148147 *
    149148 * @uses bp_activity_find_mentions()
     
    185184 * for @mentions.
    186185 *
    187  * @since BuddyPress (1.7.0)
     186 * @since 1.7.0
    188187 *
    189188 * @uses bp_get_user_meta()
     
    243242 * Determine a user's "mentionname", the name used for that user in @-mentions.
    244243 *
    245  * @since BuddyPress (1.9.0)
     244 * @since 1.9.0
    246245 *
    247246 * @param int|string $user_id ID of the user to get @-mention name for.
     
    268267 * Get a user ID from a "mentionname", the name used for a user in @-mentions.
    269268 *
    270  * @since BuddyPress (1.9.0)
     269 * @since 1.9.0
    271270 *
    272271 * @param string $mentionname Username of user in @-mentions.
     
    323322 * sites, etc) will not work.
    324323 *
    325  * @since BuddyPress (1.1.0)
     324 * @since 1.1.0
    326325 *
    327326 * @param  string        $component_id    The unique string ID of the component.
     
    361360     * Filters the action type being set for the current activity item.
    362361     *
    363      * @since BuddyPress (1.1.0)
     362     * @since 1.1.0
    364363     *
    365364     * @param array    $array           Array of arguments for action type being set.
     
    387386 * Set tracking arguments for a given post type.
    388387 *
    389  * @since BuddyPress (2.2.0)
     388 * @since 2.2.0
    390389 *
    391390 * @global $wp_post_types
     
    443442 * Get tracking arguments for a specific post type.
    444443 *
    445  * @since BuddyPress (2.2.0)
     444 * @since 2.2.0
    446445 *
    447446 * @param  string $post_type Name of the post type.
     
    500499     * Filters tracking arguments for a specific post type.
    501500     *
    502      * @since BuddyPress (2.2.0)
     501     * @since 2.2.0
    503502     *
    504503     * @param object $post_type_activity The tracking arguments of the post type.
     
    511510 * Get tracking arguments for all post types.
    512511 *
    513  * @since BuddyPress (2.2.0)
     512 * @since 2.2.0
    514513 *
    515514 * @return array List of post types with their tracking arguments.
     
    533532     * Filters tracking arguments for all post types.
    534533     *
    535      * @since BuddyPress (2.2.0)
     534     * @since 2.2.0
    536535     *
    537536     * @param array $post_types_tracking_args Array of post types with
     
    544543 * Get all components' activity actions, sorted by their position attribute.
    545544 *
    546  * @since BuddyPress (2.2.0)
     545 * @since 2.2.0
    547546 *
    548547 * @return object Actions ordered by their position.
     
    590589 * Retrieve the current action from a component and key.
    591590 *
    592  * @since BuddyPress (1.1.0)
     591 * @since 1.1.0
    593592 *
    594593 * @uses apply_filters() To call the 'bp_activity_get_action' hook.
     
    616615     * Filters the current action by component and key.
    617616     *
    618      * @since BuddyPress (1.1.0)
     617     * @since 1.1.0
    619618     *
    620619     * @param string|bool $retval       The action key.
     
    628627 * Fetch details of all registered activity types.
    629628 *
    630  * @since BuddyPress (1.7.0)
     629 * @since 1.7.0
    631630 *
    632631 * @return array array( type => description ), ...
     
    650649     * Filters the available activity types.
    651650     *
    652      * @since BuddyPress (1.7.0)
     651     * @since 1.7.0
    653652     *
    654653     * @param array $actions Array of registered activity types.
     
    662661 * Get a users favorite activity stream items.
    663662 *
    664  * @since BuddyPress (1.2.0)
     663 * @since 1.2.0
    665664 *
    666665 * @uses bp_get_user_meta()
     
    684683     * Filters the favorited activity items for a specified user.
    685684     *
    686      * @since BuddyPress (1.2.0)
     685     * @since 1.2.0
    687686     *
    688687     * @param array $favs Array of user's favorited activity items.
     
    694693 * Add an activity stream item as a favorite for a user.
    695694 *
    696  * @since BuddyPress (1.2.0)
     695 * @since 1.2.0
    697696 *
    698697 * @uses is_user_logged_in()
     
    747746         * Fires if bp_activity_update_meta() for favorite_count is successful and before returning a true value for success.
    748747         *
    749          * @since BuddyPress (1.2.1)
     748         * @since 1.2.1
    750749         *
    751750         * @param int $activity_id ID of the activity item being favorited.
     
    763762         * Fires if bp_activity_update_meta() for favorite_count is unsuccessful and before returning a false value for failure.
    764763         *
    765          * @since BuddyPress (1.5.0)
     764         * @since 1.5.0
    766765         *
    767766         * @param int $activity_id ID of the activity item being favorited.
     
    777776 * Remove an activity stream item as a favorite for a user.
    778777 *
    779  * @since BuddyPress (1.2.0)
     778 * @since 1.2.0
    780779 *
    781780 * @uses is_user_logged_in()
     
    828827                 * Fires if bp_update_user_meta() is successful and before returning a true value for success.
    829828                 *
    830                  * @since BuddyPress (1.2.1)
     829                 * @since 1.2.1
    831830                 *
    832831                 * @param int $activity_id ID of the activity item being unfavorited.
     
    857856 * Check whether an activity item exists with a given content string.
    858857 *
    859  * @since BuddyPress (1.1.0)
     858 * @since 1.1.0
    860859 *
    861860 * @uses BP_Activity_Activity::check_exists_by_content() {@link BP_Activity_Activity}
     
    871870     * Filters the results of the check for whether an activity item exists by specified content.
    872871     *
    873      * @since BuddyPress (1.1.0)
     872     * @since 1.1.0
    874873     *
    875874     * @param BP_Activity_Activity $content_exists ID of the activity if found, else null.
     
    881880 * Retrieve the last time activity was updated.
    882881 *
    883  * @since BuddyPress (1.0.0)
     882 * @since 1.0.0
    884883 *
    885884 * @uses BP_Activity_Activity::get_last_updated() {@link BP_Activity_Activity}
     
    893892     * Filters the value for the last updated time for an activity item.
    894893     *
    895      * @since BuddyPress (1.1.0)
     894     * @since 1.1.0
    896895     *
    897896     * @param BP_Activity_Activity $last_updated Date last updated.
     
    903902 * Retrieve the number of favorite activity stream items a user has.
    904903 *
    905  * @since BuddyPress (1.2.0)
     904 * @since 1.2.0
    906905 *
    907906 * @uses BP_Activity_Activity::total_favorite_count() {@link BP_Activity_Activity}
     
    926925 * Delete a meta entry from the DB for an activity stream item.
    927926 *
    928  * @since BuddyPress (1.2.0)
     927 * @since 1.2.0
    929928 *
    930929 * @global object $wpdb WordPress database access object.
     
    970969 * Get metadata for a given activity item.
    971970 *
    972  * @since BuddyPress (1.2.0)
     971 * @since 1.2.0
    973972 *
    974973 * @uses apply_filters() To call the 'bp_activity_get_meta' hook.
     
    992991     * Filters the metadata for a specified activity item.
    993992     *
    994      * @since BuddyPress (1.5.0)
     993     * @since 1.5.0
    995994     *
    996995     * @param mixed  $retval      The meta values for the activity item.
     
    10051004 * Update a piece of activity meta.
    10061005 *
    1007  * @since BuddyPress (1.2.0)
     1006 * @since 1.2.0
    10081007 *
    10091008 * @param int    $activity_id ID of the activity item whose metadata is being updated.
     
    10281027 * Add a piece of activity metadata.
    10291028 *
    1030  * @since BuddyPress (2.0.0)
     1029 * @since 2.0.0
    10311030 *
    10321031 * @param int    $activity_id ID of the activity item.
     
    10521051 * Completely remove a user's activity data.
    10531052 *
    1054  * @since BuddyPress (1.5.0)
     1053 * @since 1.5.0
    10551054 *
    10561055 * @uses is_user_logged_in()
     
    10841083     * Fires after the removal of all of a user's activity data.
    10851084     *
    1086      * @since BuddyPress (1.5.0)
     1085     * @since 1.5.0
    10871086     *
    10881087     * @param int $user_id ID of the user being deleted.
     
    10961095 * Mark all of the user's activity as spam.
    10971096 *
    1098  * @since BuddyPress (1.6.0)
     1097 * @since 1.6.0
    10991098 *
    11001099 * @global object $wpdb WordPress database access object.
     
    11541153     * Fires after all activity data from a user has been marked as spam.
    11551154     *
    1156      * @since BuddyPress (1.6.0)
     1155     * @since 1.6.0
    11571156     *
    11581157     * @param int   $user_id    ID of the user whose activity is being marked as spam.
     
    11661165 * Mark all of the user's activity as ham (not spam).
    11671166 *
    1168  * @since BuddyPress (1.6.0)
     1167 * @since 1.6.0
    11691168 *
    11701169 * @global object $wpdb WordPress database access object.
     
    12251224     * Fires after all activity data from a user has been marked as ham.
    12261225     *
    1227      * @since BuddyPress (1.6.0)
     1226     * @since 1.6.0
    12281227     *
    12291228     * @param int   $user_id    ID of the user whose activity is being marked as ham.
     
    12371236 * Register the activity stream actions for updates.
    12381237 *
    1239  * @since BuddyPress (1.6.0)
     1238 * @since 1.6.0
    12401239 */
    12411240function bp_activity_register_activity_actions() {
     
    12641263     * Allows plugin authors to add their own activity actions alongside the core actions.
    12651264     *
    1266      * @since BuddyPress (1.6.0)
     1265     * @since 1.6.0
    12671266     */
    12681267    do_action( 'bp_activity_register_activity_actions' );
     
    13001299     * Filters the string for the activity action being returned.
    13011300     *
    1302      * @since BuddyPress (2.0.0)
     1301     * @since 2.0.0
    13031302     *
    13041303     * @param BP_Activity_Activity $action   Action string being requested.
     
    13161315 * Format 'activity_update' activity actions.
    13171316 *
    1318  * @since BuddyPress (2.0.0)
     1317 * @since 2.0.0
    13191318 *
    13201319 * @param string $action   Static activity action.
     
    13291328     * Filters the formatted activity action update string.
    13301329     *
    1331      * @since BuddyPress (1.2.0)
     1330     * @since 1.2.0
    13321331     *
    13331332     * @param string               $action   Activity action string value.
     
    13401339 * Format 'activity_comment' activity actions.
    13411340 *
    1342  * @since BuddyPress (2.0.0)
     1341 * @since 2.0.0
    13431342 *
    13441343 * @param string $action   Static activity action.
     
    13531352     * Filters the formatted activity action comment string.
    13541353     *
    1355      * @since BuddyPress (1.2.0)
     1354     * @since 1.2.0
    13561355     *
    13571356     * @param string               $action   Activity action string value.
     
    13641363 * Format activity action strings for custom post types.
    13651364 *
    1366  * @since BuddyPress (2.2.0)
     1365 * @since 2.2.0
    13671366 *
    13681367 * @param string $action   Static activity action.
     
    14111410     * Filters the formatted custom post type activity post action string.
    14121411     *
    1413      * @since BuddyPress (2.2.0)
     1412     * @since 2.2.0
    14141413     *
    14151414     * @param string               $action   Activity action string value.
     
    14351434 *   - 'per_page' (false)
    14361435 *
    1437  * @since BuddyPress (1.2.0)
     1436 * @since 1.2.0
    14381437 *
    14391438 * @see BP_Activity_Activity::get() For more information on accepted arguments
     
    15341533     * Filters the requested activity item(s).
    15351534     *
    1536      * @since BuddyPress (1.2.0)
     1535     * @since 1.2.0
    15371536     *
    15381537     * @param BP_Activity_Activity $activity Requested activity object.
     
    15451544 * Fetch specific activity items.
    15461545 *
    1547  * @since BuddyPress (1.2.0)
     1546 * @since 1.2.0
    15481547 *
    15491548 * @see BP_Activity_Activity::get() For more information on accepted arguments.
     
    15891588     * Filters the requested specific activity item.
    15901589     *
    1591      * @since BuddyPress (1.2.0)
     1590     * @since 1.2.0
    15921591     *
    15931592     * @param BP_Activity_Activity $activity Requested activity object.
     
    16011600 * Add an activity item.
    16021601 *
    1603  * @since BuddyPress (1.1.0)
     1602 * @since 1.1.0
    16041603 *
    16051604 * @uses wp_parse_args()
     
    17011700     * Fires at the end of the execution of adding a new activity item, before returning the new activity item ID.
    17021701     *
    1703      * @since BuddyPress (1.1.0)
     1702     * @since 1.1.0
    17041703     *
    17051704     * @param array $r Array of parsed arguments for the activity item being added.
     
    17131712 * Post an activity update.
    17141713 *
    1715  * @since BuddyPress (1.2.0)
     1714 * @since 1.2.0
    17161715 *
    17171716 * @uses wp_parse_args()
     
    17541753     * Filters the new activity content for current activity item.
    17551754     *
    1756      * @since BuddyPress (1.2.0)
     1755     * @since 1.2.0
    17571756     *
    17581757     * @param string $activity_content Activity content posted by user.
     
    17631762     * Filters the activity primary link for current activity item.
    17641763     *
    1765      * @since BuddyPress (1.2.0)
     1764     * @since 1.2.0
    17661765     *
    17671766     * @param string $primary_link Link to the profile for the user who posted the activity.
     
    17811780     * Filters the latest update content for the activity item.
    17821781     *
    1783      * @since BuddyPress (1.6.0)
     1782     * @since 1.6.0
    17841783     *
    17851784     * @param string $r                Content of the activity update.
     
    17971796     * Fires at the end of an activity post update, before returning the updated activity item ID.
    17981797     *
    1799      * @since BuddyPress (1.2.0)
     1798     * @since 1.2.0
    18001799     *
    18011800     * @param string $content     Content of the activity post update.
     
    18111810 * Create an activity item for a newly published post type post.
    18121811 *
    1813  * @since BuddyPress (2.2.0)
     1812 * @since 2.2.0
    18141813 *
    18151814 * @param  int      $post_id ID of the new post.
     
    18611860     * that lets components or plugins bail early if needed.
    18621861     *
    1863      * @since BuddyPress (2.2.0)
     1862     * @since 2.2.0
    18641863     *
    18651864     * @param bool $value   Whether or not to continue.
     
    19351934     * Fires after the publishing of an activity item for a newly published post type post.
    19361935     *
    1937      * @since BuddyPress (2.2.0)
     1936     * @since 2.2.0
    19381937     *
    19391938     * @param int     $activity_id   ID of the newly published activity item.
     
    19491948 * Update the activity item for a custom post type entry.
    19501949 *
    1951  * @since BuddyPress (2.2.0)
     1950 * @since 2.2.0
    19521951 *
    19531952 * @param  WP_Post $post Post item.
     
    20052004     * Fires after the updating of an activity item for a custom post type entry.
    20062005     *
    2007      * @since BuddyPress (2.2.0)
     2006     * @since 2.2.0
    20082007     *
    20092008     * @param WP_Post              $post     Post object.
     
    20182017 * Unpublish an activity for the custom post type.
    20192018 *
    2020  * @since BuddyPress (2.2.0)
     2019 * @since 2.2.0
    20212020 *
    20222021 * @param  int     $post_id ID of the post being unpublished.
     
    20552054     * Fires after the unpublishing for the custom post type.
    20562055     *
    2057      * @since BuddyPress (2.2.0)
     2056     * @since 2.2.0
    20582057     *
    20592058     * @param array   $delete_activity_args Array of arguments for activity deletion.
     
    20692068 * Add an activity comment.
    20702069 *
    2071  * @since BuddyPress (1.2.0)
     2070 * @since 1.2.0
    20722071 *
    20732072 * @uses wp_parse_args()
     
    21402139     * Filters the content of a new comment.
    21412140     *
    2142      * @since BuddyPress (1.2.0)
     2141     * @since 1.2.0
    21432142     *
    21442143     * @param string $r Content for the newly posted comment.
     
    21732172     * Fires near the end of an activity comment posting, before the returning of the comment ID.
    21742173     *
    2175      * @since BuddyPress (1.2.0)
     2174     * @since 1.2.0
    21762175     *
    21772176     * @param int   $comment_id ID of the newly posted activity comment.
     
    21922191 * Fetch the activity_id for an existing activity entry in the DB.
    21932192 *
    2194  * @since BuddyPress (1.2.0)
     2193 * @since 1.2.0
    21952194 *
    21962195 * @see BP_Activity_Activity::get() For more information on accepted arguments.
     
    22192218     * Filters the activity ID being requested.
    22202219     *
    2221      * @since BuddyPress (1.2.0)
     2220     * @since 1.2.0
    22222221     *
    22232222     * @param BP_Activity_Activity $value ID returned by BP_Activity_Activity get_id() method with provided arguments.
     
    22482247 * If you are deleting an activity comment please use bp_activity_delete_comment();
    22492248 *
    2250  * @since BuddyPress (1.0.0)
     2249 * @since 1.0.0
    22512250 *
    22522251 * @see BP_Activity_Activity::get() For more information on accepted arguments.
     
    22892288     * Fires before an activity item proceeds to be deleted.
    22902289     *
    2291      * @since BuddyPress (1.5.0)
     2290     * @since 1.5.0
    22922291     *
    22932292     * @param array $args Array of arguments to be used with the activity deletion.
     
    23182317     * Fires after the activity item has been deleted.
    23192318     *
    2320      * @since BuddyPress (1.0.0)
     2319     * @since 1.0.0
    23212320     *
    23222321     * @param array $args Array of arguments used with the activity deletion.
     
    23272326     * Fires after the activity item has been deleted.
    23282327     *
    2329      * @since BuddyPress (1.2.0)
     2328     * @since 1.2.0
    23302329     *
    23312330     * @param array $activity_ids_deleted Array of affected activity item IDs.
     
    23432342     * You should use bp_activity_delete() instead.
    23442343     *
    2345      * @since BuddyPress (1.1.0)
    2346      * @deprecated BuddyPress (1.2.0)
     2344     * @since 1.1.0
     2345     * @deprecated 1.2.0
    23472346     *
    23482347     * @uses wp_parse_args()
     
    23702369     * Delete an activity item by activity id.
    23712370     *
    2372      * @since BuddyPress (1.1.0)
     2371     * @since 1.1.0
    23732372     *
    23742373     * @uses bp_activity_delete()
     
    23872386     * You should use bp_activity_delete() instead.
    23882387     *
    2389      * @since BuddyPress (1.1.0)
    2390      * @deprecated BuddyPress (1.2.0)
     2388     * @since 1.1.0
     2389     * @deprecated 1.2.0
    23912390     *
    23922391     * @uses bp_activity_delete()
     
    24132412     * You should use bp_activity_delete() instead.
    24142413     *
    2415      * @since BuddyPress (1.1.0)
    2416      * @deprecated BuddyPress (1.2.0)
     2414     * @since 1.1.0
     2415     * @deprecated 1.2.0
    24172416     *
    24182417     * @uses bp_activity_delete()
     
    24332432 * Delete an activity comment.
    24342433 *
    2435  * @since BuddyPress (1.2.0)
     2434 * @since 1.2.0
    24362435 *
    24372436 * @uses apply_filters() To call the 'bp_activity_delete_comment_pre' hook.
     
    24592458     * handle the deletion of child comments differently. Make sure you return false.
    24602459     *
    2461      * @since BuddyPress (1.2.0)
     2460     * @since 1.2.0
    24622461     *
    24632462     * @param bool $value       Whether BuddyPress should continue or not.
     
    24862485     * Fires at the end of the deletion of an activity comment, before returning success.
    24872486     *
    2488      * @since BuddyPress (1.2.0)
     2487     * @since 1.2.0
    24892488     *
    24902489     * @param int $activity_id ID of the activity that has had a comment deleted from.
     
    24992498     * Delete an activity comment's children.
    25002499     *
    2501      * @since BuddyPress (1.2.0)
     2500     * @since 1.2.0
    25022501     *
    25032502     * @uses BP_Activity_Activity::get_child_comments() {@link BP_Activity_Activity}
     
    25372536 * have it available.
    25382537 *
    2539  * @since BuddyPress (1.2.0)
     2538 * @since 1.2.0
    25402539 *
    25412540 * @uses bp_get_root_domain()
     
    25832582     * Filters the activity permalink for the specified activity item.
    25842583     *
    2585      * @since BuddyPress (1.2.0)
     2584     * @since 1.2.0
    25862585     *
    25872586     * @param array $array Array holding activity permalink and activity item object.
     
    25932592 * Hide a user's activity.
    25942593 *
    2595  * @since BuddyPress (1.2.0)
     2594 * @since 1.2.0
    25962595 *
    25972596 * @uses BP_Activity_Activity::hide_all_for_user() {@link BP_Activity_Activity}
     
    26172616 * As of BuddyPress 2.3, this function is no longer in use.
    26182617 *
    2619  * @since BuddyPress (1.2.0)
     2618 * @since 1.2.0
    26202619 *
    26212620 * @uses esc_attr()
     
    26792678     * Filters the activity content that had a thumbnail replace images.
    26802679     *
    2681      * @since BuddyPress (1.2.0)
     2680     * @since 1.2.0
    26822681     *
    26832682     * @param string $content Activity content that had images replaced in.
     
    26952694 * activity in the future.
    26962695 *
    2697  * @since BuddyPress (2.3.0)
     2696 * @since 2.3.0
    26982697 *
    26992698 * @param string $content  The content of the activity item.
     
    27182717     * Use this filter to change the media extractor used to extract media info for the activity item.
    27192718     *
    2720      * @since BuddyPress (2.3.0)
     2719     * @since 2.3.0
    27212720     *
    27222721     * @param string $extractor Class name.
     
    27302729     * Filter the arguments passed to the media extractor when creating an Activity summary.
    27312730     *
    2732      * @since BuddyPress (2.3.0)
     2731     * @since 2.3.0
    27332732     *
    27342733     * @param array              $args      Array of bespoke data for the media extractor.
     
    28032802         * Filter the results of the media extractor when creating an Activity summary.
    28042803         *
    2805          * @since BuddyPress (2.3.0)
     2804         * @since 2.3.0
    28062805         *
    28072806         * @param array  $extracted_media Extracted media item. See {@link BP_Media_Extractor::extract()} for format.
     
    28402839     * Filters the newly-generated summary for the activity item.
    28412840     *
    2842      * @since BuddyPress (2.3.0)
     2841     * @since 2.3.0
    28432842     *
    28442843     * @param string $summary         Activity summary HTML.
     
    28532852 * Fetch whether the current user is allowed to mark items as spam.
    28542853 *
    2855  * @since BuddyPress (1.6.0)
     2854 * @since 1.6.0
    28562855 *
    28572856 * @return bool True if user is allowed to mark activity items as spam.
     
    28622861     * Filters whether the current user should be able to mark items as spam.
    28632862     *
    2864      * @since BuddyPress (1.6.0)
     2863     * @since 1.6.0
    28652864     *
    28662865     * @param bool $moderate Whether or not the current user has bp_moderate capability.
     
    28722871 * Mark an activity item as spam.
    28732872 *
    2874  * @since BuddyPress (1.6.0)
     2873 * @since 1.6.0
    28752874 *
    28762875 * @param BP_Activity_Activity $activity The activity item to be spammed.
     
    29072906     * Fires at the end of the process to mark an activity item as spam.
    29082907     *
    2909      * @since BuddyPress (1.6.0)
     2908     * @since 1.6.0
    29102909     *
    29112910     * @param BP_Activity_Activity $activity Activity item being marked as spam.
     
    29192918 * Mark an activity item as ham.
    29202919 *
    2921  * @since BuddyPress (1.6.0)
     2920 * @since 1.6.0
    29222921 *
    29232922 * @param BP_Activity_Activity $activity The activity item to be hammed. Passed by reference.
     
    29542953     * Fires at the end of the process to mark an activity item as ham.
    29552954     *
    2956      * @since BuddyPress (1.6.0)
     2955     * @since 1.6.0
    29572956     *
    29582957     * @param BP_Activity_Activity $activity Activity item being marked as ham.
     
    29762975 * For that, see {@link bp_activity_comment_embed()}.
    29772976 *
    2978  * @since BuddyPress (1.5.0)
     2977 * @since 1.5.0
    29792978 *
    29802979 * @see BP_Embed
     
    30013000 * the cache if they are not there yet.
    30023001 *
    3003  * @since BuddyPress (1.5.0)
     3002 * @since 1.5.0
    30043003 *
    30053004 * @see BP_Embed
     
    30213020 * When a user clicks on a "Read More" item, make sure embeds are correctly parsed and shown for the expanded content.
    30223021 *
    3023  * @since BuddyPress (1.5.0)
     3022 * @since 1.5.0
    30243023 *
    30253024 * @see BP_Embed
     
    30463045 * once the comments are done being processed.
    30473046 *
    3048  * @since BuddyPress (1.5.0)
     3047 * @since 1.5.0
    30493048 *
    30503049 * @see bp_activity_comment_embed()
     
    30613060 * Used during {@link BP_Embed::parse_oembed()} via {@link bp_activity_embed()}.
    30623061 *
    3063  * @since BuddyPress (1.5.0)
     3062 * @since 1.5.0
    30643063 *
    30653064 * @see BP_Embed::parse_oembed()
     
    30823081 * Used during {@link BP_Embed::parse_oembed()} via {@link bp_activity_embed()}.
    30833082 *
    3084  * @since BuddyPress (1.5.0)
     3083 * @since 1.5.0
    30853084 *
    30863085 * @see BP_Embed::parse_oembed()
     
    31013100 * Should we use Heartbeat to refresh activities?
    31023101 *
    3103  * @since BuddyPress (2.0.0)
     3102 * @since 2.0.0
    31043103 *
    31053104 * @uses bp_is_activity_heartbeat_active() to check if heartbeat setting is on.
Note: See TracChangeset for help on using the changeset viewer.