Skip to:
Content

BuddyPress.org

Changeset 10077


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.

Location:
trunk/src/bp-activity
Files:
15 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.
  • trunk/src/bp-activity/bp-activity-admin.php

    r10065 r10077  
    66 * help text, on which this implementation is heavily based.
    77 *
     8 * @since 1.6.0
    89 * @package BuddyPress
    9  * @since BuddyPress (1.6.0)
    10  * @subpackage Activity
     10 * @subpackage ActivityAdmin
    1111 */
    1212
     
    2424 * Register the Activity component admin screen.
    2525 *
    26  * @since BuddyPress (1.6)
     26 * @since 1.6.0
    2727 */
    2828function bp_activity_add_admin_menu() {
     
    5050 * adds the Activity page to the array of these menu items.
    5151 *
    52  * @since BuddyPress (1.7.0)
     52 * @since 1.7.0
    5353 *
    5454 * @param array $custom_menus The list of top-level BP menu items.
     
    6868 * table row.
    6969 *
    70  * @since BuddyPress (1.6.0)
     70 * @since 1.6.0
    7171 */
    7272function bp_activity_admin_reply() {
     
    138138 * Handle save/update of screen options for the Activity component admin screen.
    139139 *
    140  * @since BuddyPress (1.6.0)
     140 * @since 1.6.0
    141141 *
    142142 * @param string $value     Will always be false unless another plugin filters it first.
     
    161161 * Hide the advanced edit meta boxes by default, so we don't clutter the screen.
    162162 *
    163  * @since BuddyPress (1.6.0)
     163 * @since 1.6.0
    164164 *
    165165 * @param array     $hidden Array of items to hide.
     
    178178         * Filters default hidden metaboxes so plugins can alter list.
    179179         *
    180          * @since BuddyPress (1.6.0)
     180         * @since 1.6.0
    181181         *
    182182         * @param array     $hidden Default metaboxes to hide.
     
    195195 *   - Catches POST and GET requests related to Activity.
    196196 *
    197  * @since BuddyPress (1.6.0)
     197 * @since 1.6.0
    198198 *
    199199 * @global object                 $bp                     BuddyPress global settings.
     
    213213         * Fires at top of Activity admin page.
    214214         *
    215          * @since BuddyPress (1.6.0)
     215         * @since 1.6.0
    216216         *
    217217         * @param string $doaction Current $_GET action being performed in admin screen.
     
    321321                 * Filters list of IDs being spammed/un-spammed/deleted.
    322322                 *
    323                  * @since BuddyPress (1.6.0)
     323                 * @since 1.6.0
    324324                 *
    325325                 * @param array $activity_ids Activity IDs to spam/un-spam/delete.
     
    413413                 * Passes an activity array counts how many were spam, not spam, deleted, and IDs that were errors.
    414414                 *
    415                  * @since BuddyPress (1.6.0)
     415                 * @since 1.6.0
    416416                 *
    417417                 * @param array  $value        Array holding spam, not spam, deleted counts, error IDs.
     
    438438                 * Filters redirect URL after activity spamming/un-spamming/deletion occurs.
    439439                 *
    440                  * @since BuddyPress (1.6.0)
     440                 * @since 1.6.0
    441441                 *
    442442                 * @param string $redirect_to URL to redirect to.
     
    555555                 * Fires before redirect so plugins can do something first on save action.
    556556                 *
    557                  * @since BuddyPress (1.6.0)
     557                 * @since 1.6.0
    558558                 *
    559559                 * @param array Array holding activity object and ID that holds error.
     
    570570                 * Filters URL to redirect to after saving.
    571571                 *
    572                  * @since BuddyPress (1.6.0)
     572                 * @since 1.6.0
    573573                 *
    574574                 * @param string $redirect_to URL to redirect to.
     
    588588 * Output the Activity component admin screens.
    589589 *
    590  * @since BuddyPress (1.6.0)
     590 * @since 1.6.0
    591591 */
    592592function bp_activity_admin() {
     
    606606 * Display the single activity edit screen.
    607607 *
    608  * @since BuddyPress (1.6.0)
     608 * @since 1.6.0
    609609 */
    610610function bp_activity_admin_edit() {
     
    641641         * Fires before activity edit form is displays so plugins can modify the activity.
    642642         *
    643          * @since BuddyPress (1.6.0)
     643         * @since 1.6.0
    644644         *
    645645         * @param array $value Array holding single activity object that was passed by reference.
     
    703703 * Status metabox for the Activity admin edit screen.
    704704 *
    705  * @since BuddyPress (1.6.0)
     705 * @since 1.6.0
    706706 *
    707707 * @param object $item Activity item.
     
    759759 * Primary link metabox for the Activity admin edit screen.
    760760 *
    761  * @since BuddyPress (1.6.0)
     761 * @since 1.6.0
    762762 *
    763763 * @param object $item Activity item.
     
    776776 * User ID metabox for the Activity admin edit screen.
    777777 *
    778  * @since BuddyPress (1.6.0)
     778 * @since 1.6.0
    779779 *
    780780 * @param object $item Activity item.
     
    794794 * Format is [activity_type] => Pretty name for activity type.
    795795 *
    796  * @since BuddyPress (2.0.0)
     796 * @since 2.0.0
    797797 *
    798798 * @return array
     
    822822 * Activity type metabox for the Activity admin edit screen.
    823823 *
    824  * @since BuddyPress (1.6.0)
     824 * @since 1.6.0
    825825 *
    826826 * @param object $item Activity item.
     
    868868 * Primary item ID/Secondary item ID metabox for the Activity admin edit screen.
    869869 *
    870  * @since BuddyPress (1.6.0)
     870 * @since 1.6.0
    871871 *
    872872 * @param object $item Activity item.
     
    890890 * Display the Activity admin index screen, which contains a list of all the activities.
    891891 *
    892  * @since BuddyPress (1.6.0)
     892 * @since 1.6.0
    893893 *
    894894 * @global BP_Activity_List_Table $bp_activity_list_table Activity screen list table.
     
    958958         * Fires before edit form is displayed so plugins can modify the activity messages.
    959959         *
    960          * @since BuddyPress (1.6.0)
     960         * @since 1.6.0
    961961         *
    962962         * @param array $messages Array of messages to display at top of page.
     
    10241024 * List table class for the Activity component admin page.
    10251025 *
    1026  * @since BuddyPress (1.6.0)
     1026 * @since 1.6.0
    10271027 */
    10281028class BP_Activity_List_Table extends WP_List_Table {
     
    10331033         * e.g. "all", "pending", "approved", "spam"...
    10341034         *
    1035          * @since BuddyPress (1.6.0)
     1035         * @since 1.6.0
    10361036         * @var string
    10371037         */
     
    10411041         * How many activity items have been marked as spam.
    10421042         *
    1043          * @since BuddyPress (1.6.0)
     1043         * @since 1.6.0
    10441044         * @var int
    10451045         */
     
    10491049         * Store activity-to-user-ID mappings for use in the In Response To column.
    10501050         *
    1051          * @since BuddyPress (1.6.0)
     1051         * @since 1.6.0
    10521052         * @var array
    10531053         */
     
    10571057         * If users can comment on blog & forum activity items.
    10581058         *
    1059          * @since BuddyPress (2.2.2)
     1059         * @since 2.2.2
    10601060         *
    10611061         * @link https://buddypress.trac.wordpress.org/ticket/6277
     
    10681068         * Constructor.
    10691069         *
    1070          * @since BuddyPress (1.6.0)
     1070         * @since 1.6.0
    10711071         */
    10721072        public function __construct() {
     
    10871087         * Handle filtering of data, sorting, pagination, and any other data manipulation prior to rendering.
    10881088         *
    1089          * @since BuddyPress (1.6.0)
     1089         * @since 1.6.0
    10901090         */
    10911091        function prepare_items() {
     
    11891189         * Get an array of all the columns on the page.
    11901190         *
    1191          * @since BuddyPress (1.6.0)
     1191         * @since 1.6.0
    11921192         *
    11931193         * @return array Column headers.
     
    12071207         * Get name of default primary column
    12081208         *
    1209          * @since BuddyPress (2.3.3)
     1209         * @since 2.3.3
    12101210         * @access protected
    12111211         *
     
    12191219         * Display a message on screen when no items are found (e.g. no search matches).
    12201220         *
    1221          * @since BuddyPress (1.6.0)
     1221         * @since 1.6.0
    12221222         */
    12231223        function no_items() {
     
    12281228         * Output the Activity data table.
    12291229         *
    1230          * @since BuddyPress (1.6.0)
     1230         * @since 1.6.0
    12311231        */
    12321232        function display() {
     
    12581258         * Generate content for a single row of the table.
    12591259         *
    1260          * @since BuddyPress (1.6.0)
     1260         * @since 1.6.0
    12611261         *
    12621262         * @param object $item The current item.
     
    12871287         * Get the list of views available on this table (e.g. "all", "spam").
    12881288         *
    1289          * @since BuddyPress (1.6.0)
     1289         * @since 1.6.0
    12901290         */
    12911291        function get_views() {
     
    13011301                         * Fires inside listing of views so plugins can add their own.
    13021302                         *
    1303                          * @since BuddyPress (1.6.0)
     1303                         * @since 1.6.0
    13041304                         *
    13051305                         * @param string $url_base Current URL base for view.
     
    13141314         * Get bulk actions.
    13151315         *
    1316          * @since BuddyPress (1.6.0)
     1316         * @since 1.6.0
    13171317         *
    13181318         * @return array Key/value pairs for the bulk actions dropdown.
     
    13271327                 * Filters the default bulk actions so plugins can add custom actions.
    13281328                 *
    1329                  * @since BuddyPress (1.6.0)
     1329                 * @since 1.6.0
    13301330                 *
    13311331                 * @param array $actions Default available actions for bulk operations.
     
    13371337         * Get the table column titles.
    13381338         *
    1339          * @since BuddyPress (1.6.0)
     1339         * @since 1.6.0
    13401340         *
    13411341         * @see WP_List_Table::single_row_columns()
     
    13581358         * Currently, returns an empty array (no columns are sortable).
    13591359         *
    1360          * @since BuddyPress (1.6.0)
     1360         * @since 1.6.0
    13611361         * @todo For this to work, BP_Activity_Activity::get() needs updating
    13621362         *       to support ordering by specific fields.
     
    13751375         * Markup for the "filter" part of the form (i.e. which activity type to display).
    13761376         *
    1377          * @since BuddyPress (1.6.0)
     1377         * @since 1.6.0
    13781378         *
    13791379         * @param string $which 'top' or 'bottom'.
     
    14591459         * Checkbox column markup.
    14601460         *
    1461          * @since BuddyPress (1.6.0)
     1461         * @since 1.6.0
    14621462         *
    14631463         * @see WP_List_Table::single_row_columns()
     
    14721472         * Author column markup.
    14731473         *
    1474          * @since BuddyPress (1.6.0)
     1474         * @since 1.6.0
    14751475         *
    14761476         * @see WP_List_Table::single_row_columns()
     
    14851485         * Action column markup.
    14861486         *
    1487          * @since BuddyPress (2.0.0)
     1487         * @since 2.0.0
    14881488         *
    14891489         * @see WP_List_Table::single_row_columns()
     
    15061506         * Called "comment" in the CSS so we can re-use some WP core CSS.
    15071507         *
    1508          * @since BuddyPress (1.6.0)
     1508         * @since 1.6.0
    15091509         *
    15101510         * @see WP_List_Table::single_row_columns()
     
    15651565                 * Filters available actions for plugins to alter.
    15661566                 *
    1567                  * @since BuddyPress (1.6.0)
     1567                 * @since 1.6.0
    15681568                 *
    15691569                 * @param array $actions Array of available actions user could use.
     
    15841584                         * Filters current activity item content.
    15851585                         *
    1586                          * @since BuddyPress (1.2.0)
     1586                         * @since 1.2.0
    15871587                         *
    15881588                         * @param array $item Array index holding current activity item content.
     
    15931593                         * Filters current activity item action.
    15941594                         *
    1595                          * @since BuddyPress (1.2.0)
     1595                         * @since 1.2.0
    15961596                         *
    15971597                         * @var array $item Array index holding current activity item action.
     
    16061606         * "In response to" column markup.
    16071607         *
    1608          * @since BuddyPress (1.6.0)
     1608         * @since 1.6.0
    16091609         *
    16101610         * @see WP_List_Table::single_row_columns()
     
    16181618                 * Filters default list of default root activity types.
    16191619                 *
    1620                  * @since BuddyPress (1.6.0)
     1620                 * @since 1.6.0
    16211621                 *
    16221622                 * @param array $value Array of default activity types.
     
    16491649         * avoiding duplicate queries.
    16501650         *
    1651          * @since BuddyPress (1.6.0)
     1651         * @since 1.6.0
    16521652         *
    16531653         * @param int $activity_id Activity ID to retrieve User ID for.
     
    16901690         * functions from working as intended.
    16911691         *
    1692          * @since BuddyPress (2.0.0)
     1692         * @since 2.0.0
    16931693         *
    16941694         * @param array $item An array version of the BP_Activity_Activity object.
     
    17421742                 * Filters if an activity item can be commented on or not.
    17431743                 *
    1744                  * @since BuddyPress (2.0.0)
     1744                 * @since 2.0.0
    17451745                 *
    17461746                 * @param bool $can_comment Whether an activity item can be commented on or not.
     
    17551755         * items plus their comments. This method converts it to a flat array.
    17561756         *
    1757          * @since BuddyPress (1.6.0)
     1757         * @since 1.6.0
    17581758         *
    17591759         * @param array $tree Source array.
  • trunk/src/bp-activity/bp-activity-akismet.php

    r9843 r10077  
    33 * Akismet support for BuddyPress' Activity Stream.
    44 *
     5 * @since 1.6.0
    56 * @package BuddyPress
    6  * @since BuddyPress (1.6.0)
    7  * @subpackage Activity
     7 * @subpackage ActivityAkismet
    88 */
    99
     
    1414 * Akismet support for the Activity component.
    1515 *
    16  * @since BuddyPress (1.6.0)
    17  * @since BuddyPress (2.3.0) We only support Akismet 3+.
     16 * @since 1.6.0
     17 * @since 2.3.0 We only support Akismet 3+.
    1818 */
    1919class BP_Akismet {
     
    2323         * @access protected
    2424         * @var BP_Activity_Activity
    25          * @since BuddyPress (1.6.0)
     25         * @since 1.6.0
    2626         */
    2727        protected $last_activity = null;
     
    3030         * Constructor.
    3131         *
    32          * @since BuddyPress (1.6.0)
     32         * @since 1.6.0
    3333         */
    3434        public function __construct() {
     
    3939         * Hook Akismet into the activity stream.
    4040         *
    41          * @since BuddyPress (1.6.0)
     41         * @since 1.6.0
    4242         */
    4343        protected function setup_actions() {
     
    7171         * akismet_comment_row_action() function. Thanks!
    7272         *
    73          * @since BuddyPress (1.6.0)
     73         * @since 1.6.0
    7474         *
    7575         * @param array $actions  The hover links.
     
    118118                 * Filters the list of actions for the current activity's row.
    119119                 *
    120                  * @since BuddyPress (1.6.0)
     120                 * @since 1.6.0
    121121                 *
    122122                 * @param array $actions Array of available actions for the current activity item's row.
     
    132132         * by Akismet to help detect spam activity.
    133133         *
    134          * @since BuddyPress (1.6.0)
     134         * @since 1.6.0
    135135         *
    136136         * @see https://plugins.trac.wordpress.org/ticket/1232
     
    161161         * default AJAX implementation; see bp_dtheme_post_update().
    162162         *
    163          * @since BuddyPress (1.6.0)
     163         * @since 1.6.0
    164164         *
    165165         * @see bp_dtheme_post_update()
     
    187187         * This function is intended to be used inside the activity stream loop.
    188188         *
    189          * @since BuddyPress (1.6.0)
     189         * @since 1.6.0
    190190         */
    191191        public function add_activity_spam_button() {
     
    215215         * This function is intended to be used inside the activity stream loop.
    216216         *
    217          * @since BuddyPress (1.6.0)
     217         * @since 1.6.0
    218218         */
    219219        public function add_activity_comment_spam_button() {
     
    242242         * Get a filterable list of activity types that Akismet should automatically check for spam.
    243243         *
    244          * @since BuddyPress (1.6.0)
     244         * @since 1.6.0
    245245         *
    246246         * @static
     
    253253                 * Filters the list of activity types that Akismet should automatically check for spam.
    254254                 *
    255                  * @since BuddyPress (1.6.0)
     255                 * @since 1.6.0
    256256                 *
    257257                 * @param array Array of default activity types for Akismet to check.
     
    263263         * Mark activity item as spam.
    264264         *
    265          * @since BuddyPress (1.6.0)
     265         * @since 1.6.0
    266266         *
    267267         * @param BP_Activity_Activity $activity Activity item being spammed.
     
    277277                 * Fires after marking an activity item has been marked as spam.
    278278                 *
    279                  * @since BuddyPress (1.6.0)
     279                 * @since 1.6.0
    280280                 *
    281281                 * @param BP_Activity_Activity $activity Activity object being marked as spam.
     
    291291         * Mark activity item as ham.
    292292         *
    293          * @since BuddyPress (1.6.0)
     293         * @since 1.6.0
    294294         *
    295295         * @param BP_Activity_Activity $activity Activity item being hammed.
     
    306306                 * Fires after marking an activity item has been marked as ham.
    307307                 *
    308                  * @since BuddyPress (1.6.0)
     308                 * @since 1.6.0
    309309                 *
    310310                 * @param BP_Activity_Activity $activity Activity object being marked as ham.
     
    320320         * Build a data package for the Akismet service to inspect.
    321321         *
    322          * @since BuddyPress (1.6.0)
     322         * @since 1.6.0
    323323         *
    324324         * @see http://akismet.com/development/api/#comment-check
     
    360360                 * Filters activity data before being sent to Akismet to inspect.
    361361                 *
    362                  * @since BuddyPress (1.6.0)
     362                 * @since 1.6.0
    363363                 *
    364364                 * @param array                $activity_data Array of activity data for Akismet to inspect.
     
    371371         * Check if the activity item is spam or ham.
    372372         *
    373          * @since BuddyPress (1.6.0)
     373         * @since 1.6.0
    374374         *
    375375         * @see http://akismet.com/development/api/
     
    404404                         * Fires after an activity item has been proven to be spam, but before officially being marked as spam.
    405405                         *
    406                          * @since BuddyPress (1.6.0)
     406                         * @since 1.6.0
    407407                         *
    408408                         * @param BP_Activity_Activity $activity      The activity item proven to be spam.
     
    423423         * Update activity meta after a manual spam change (user-initiated).
    424424         *
    425          * @since BuddyPress (1.6.0)
     425         * @since 1.6.0
    426426         *
    427427         * @param BP_Activity_Activity $activity The activity to check.
     
    440440         * Update activity meta after a manual ham change (user-initiated).
    441441         *
    442          * @since BuddyPress (1.6.0)
     442         * @since 1.6.0
    443443         *
    444444         * @param BP_Activity_Activity $activity The activity to check.
     
    457457         * Update activity meta after an automatic spam check (not user-initiated).
    458458         *
    459          * @since BuddyPress (1.6.0)
     459         * @since 1.6.0
    460460         *
    461461         * @param BP_Activity_Activity $activity The activity to check.
     
    495495         * Props to WordPress core Akismet plugin for a lot of this.
    496496         *
    497          * @since BuddyPress (1.6.0)
     497         * @since 1.6.0
    498498         *
    499499         * @param array  $activity_data Packet of information to submit to Akismet.
     
    566566         * Filters user agent when sending to Akismet to add BuddyPress info.
    567567         *
    568          * @since BuddyPress (1.6.0)
     568         * @since 1.6.0
    569569         *
    570570         * @param string $user_agent User agent string, as generated by Akismet.
     
    580580         * Adds a "History" meta box to the activity edit screen.
    581581         *
    582          * @since BuddyPress (1.6.0)
     582         * @since 1.6.0
    583583         *
    584584         * @param string $screen_action The type of screen that has been requested.
     
    596596         * History meta box for the Activity admin edit screen.
    597597         *
    598          * @since BuddyPress (1.6.0)
     598         * @since 1.6.0
    599599         *
    600600         * @see https://buddypress.trac.wordpress.org/ticket/3907
     
    617617         * Update an activity item's Akismet history.
    618618         *
    619          * @since BuddyPress (1.6.0)
     619         * @since 1.6.0
    620620         *
    621621         * @param int    $activity_id Activity item ID.
     
    638638         * Get an activity item's Akismet history.
    639639         *
    640          * @since BuddyPress (1.6.0)
     640         * @since 1.6.0
    641641         *
    642642         * @param int $activity_id Activity item ID.
     
    662662 * grow to be quite large.
    663663 *
    664  * @since BuddyPress (1.6.0)
     664 * @since 1.6.0
    665665 *
    666666 * @global wpdb $wpdb WordPress database object.
     
    674674         * Filters the threshold for how many days old Akismet metadata needs to be before being automatically deleted.
    675675         *
    676          * @since BuddyPress (1.6.0)
     676         * @since 1.6.0
    677677         *
    678678         * @param integer 15 How many days old metadata needs to be.
  • trunk/src/bp-activity/bp-activity-cache.php

    r9833 r10077  
    11<?php
    2 
    32/**
    43 * Functions related to the BuddyPress Activity component and the WP Cache.
    54 *
    6  * @since BuddyPress (1.6.0)
     5 * @since 1.6.0
     6 * @package    BuddyPress
     7 * @subpackage ActivityCache
    78 */
    89
     
    3839 * Clear a cached activity item when that item is updated.
    3940 *
    40  * @since BuddyPress (2.0.0)
     41 * @since 2.0.0
    4142 *
    4243 * @param BP_Activity_Activity $activity
     
    5152 * Clear cached data for deleted activity items.
    5253 *
    53  * @since BuddyPress (2.0.0)
     54 * @since 2.0.0
    5455 *
    5556 * @param array $deleted_ids IDs of deleted activity items.
  • trunk/src/bp-activity/bp-activity-classes.php

    r9819 r10077  
    44 *
    55 * @package BuddyPress
    6  * @subpackage Activity
     6 * @subpackage ActivityClasses
    77 */
    88
  • trunk/src/bp-activity/bp-activity-cssjs.php

    r10054 r10077  
    11<?php
    2 
    32/**
    43 * Activity component CSS/JS
     
    1413 * Enqueue @mentions JS.
    1514 *
    16  * @since BuddyPress (2.1.0)
     15 * @since 2.1.0
    1716 */
    1817function bp_activity_mentions_script() {
     
    5150         * friends to the page for quicker @mentions lookups.
    5251         *
    53          * @since BuddyPress (2.1.0)
     52         * @since 2.1.0
    5453         */
    5554        do_action( 'bp_activity_mentions_prime_results' );
     
    6160 * Bind the mentions listener to a wp_editor instance when TinyMCE initializes.
    6261 *
    63  * @since BuddyPress (2.3.3)
     62 * @since 2.3.3
    6463 *
    6564 * @param array  $settings   An array with TinyMCE config.
  • trunk/src/bp-activity/bp-activity-filters.php

    r9834 r10077  
    11<?php
    2 
    32/**
    43 * Filters related to the Activity component.
     
    114113 * Types of activity stream items to moderate.
    115114 *
    116  * @since BuddyPress (1.6.0)
     115 * @since 1.6.0
    117116 *
    118117 * @return array $types List of the activity types to moderate.
     
    127126         * Filters the default activity types that BuddyPress should moderate.
    128127         *
    129          * @since BuddyPress (1.6.0)
     128         * @since 1.6.0
    130129         *
    131130         * @param array $types Default activity types to moderate.
     
    137136 * Moderate the posted activity item, if it contains moderate keywords.
    138137 *
    139  * @since BuddyPress (1.6.0)
     138 * @since 1.6.0
    140139 *
    141140 * @param BP_Activity_Activity $activity The activity object to check.
     
    156155 * Mark the posted activity as spam, if it contains blacklist keywords.
    157156 *
    158  * @since BuddyPress (1.6.0)
     157 * @since 1.6.0
    159158 *
    160159 * @param BP_Activity_Activity $activity The activity object to check.
     
    174173 * Custom kses filtering for activity content.
    175174 *
    176  * @since BuddyPress (1.1.0)
     175 * @since 1.1.0
    177176 *
    178177 * @uses apply_filters() To call the 'bp_activity_allowed_tags' hook.
     
    209208         * Filters the allowed HTML tags for BuddyPress Activity content.
    210209         *
    211          * @since BuddyPress (1.2.0)
     210         * @since 1.2.0
    212211         *
    213212         * @param array $value Array of allowed HTML tags and attributes.
     
    220219 * Find and link @-mentioned users in the contents of a given item.
    221220 *
    222  * @since BuddyPress (1.2.0)
     221 * @since 1.2.0
    223222 *
    224223 * @param string $content     The contents of a given item.
     
    279278 * hook to send mention notifications after the activity item is saved.
    280279 *
    281  * @since BuddyPress (1.5.0)
     280 * @since 1.5.0
    282281 *
    283282 * @uses bp_activity_find_mentions()
     
    316315 * Sends emails and BP notifications for users @-mentioned in an activity item.
    317316 *
    318  * @since BuddyPress (1.7.0)
     317 * @since 1.7.0
    319318 *
    320319 * @uses bp_activity_at_message_notification()
     
    345344                 * Filters BuddyPress' ability to send email notifications for @mentions.
    346345                 *
    347                  * @since BuddyPress (1.6.0)
     346                 * @since 1.6.0
    348347                 *
    349348                 * @param bool  $value     Whether or not BuddyPress should send a notification to the mentioned users.
     
    362361 * Catch links in activity text so rel=nofollow can be added.
    363362 *
    364  * @since BuddyPress (1.2.0)
     363 * @since 1.2.0
    365364 *
    366365 * @param string $text Activity text.
     
    375374         * Add rel=nofollow to a link.
    376375         *
    377          * @since BuddyPress (1.2.0)
     376         * @since 1.2.0
    378377         *
    379378         * @param array $matches Items matched by preg_replace_callback() in bp_activity_make_nofollow_filter().
     
    392391 * This method can only be used inside the Activity loop.
    393392 *
    394  * @since BuddyPress (1.5.0)
     393 * @since 1.5.0
    395394 *
    396395 * @uses bp_is_single_activity()
     
    412411         * Provides a filter that lets you choose whether to skip this filter on a per-activity basis.
    413412         *
    414          * @since BuddyPress (2.3.0)
     413         * @since 2.3.0
    415414         *
    416415         * @param bool $value If true, text should be checked to see if it needs truncating.
     
    429428         * Filters the appended text for the activity excerpt.
    430429         *
    431          * @since BuddyPress (1.5.0)
     430         * @since 1.5.0
    432431         *
    433432         * @param string $value Internationalized "Read more" text.
     
    438437         * Filters the excerpt length for the activity excerpt.
    439438         *
    440          * @since BuddyPress (1.5.0)
     439         * @since 1.5.0
    441440         *
    442441         * @param int $value Number indicating how many words to trim the excerpt down to.
     
    460459         * Filters the composite activity excerpt entry.
    461460         *
    462          * @since BuddyPress (1.5.0)
     461         * @since 1.5.0
    463462         *
    464463         * @param string $excerpt     Excerpt text and markup to be displayed.
     
    472471 * Include extra JavaScript dependencies for activity component.
    473472 *
    474  * @since BuddyPress (2.0.0)
     473 * @since 2.0.0
    475474 *
    476475 * @uses bp_activity_do_heartbeat() to check if heartbeat is required.
     
    495494 * dynamically into the activity stream.
    496495 *
    497  * @since BuddyPress (2.0.0)
     496 * @since 2.0.0
    498497 *
    499498 * @param string $classes
     
    515514 * Check if Activity Heartbeat feature i on to add a timestamp class.
    516515 *
    517  * @since BuddyPress (2.0.0)
     516 * @since 2.0.0
    518517 *
    519518 * @param string $classes
     
    542541 * Use WordPress Heartbeat API to check for latest activity update.
    543542 *
    544  * @since BuddyPress (2.0.0)
     543 * @since 2.0.0
    545544 *
    546545 * @uses bp_activity_get_last_updated() to get the recorded date of the last activity.
     
    607606 * Set the strings for WP HeartBeat API where needed.
    608607 *
    609  * @since BuddyPress (2.0.0)
     608 * @since 2.0.0
    610609 *
    611610 * @param array $strings Localized strings.
     
    624623         * Filter that checks whether the global heartbeat settings already exist.
    625624         *
    626          * @since BuddyPress (2.0.0)
     625         * @since 2.0.0
    627626         *
    628627         * @param array $value Heartbeat settings array.
     
    637636         * Filters the pulse frequency to be used for the BuddyPress Activity heartbeat.
    638637         *
    639          * @since BuddyPress (2.0.0)
     638         * @since 2.0.0
    640639         *
    641640         * @param int $value The frequency in seconds between pulses.
     
    669668 * Set up activity arguments for use with the 'just-me' scope.
    670669 *
    671  * @since BuddyPress (2.2.0)
     670 * @since 2.2.0
    672671 *
    673672 * @param array $retval Empty array by default.
     
    719718 * Set up activity arguments for use with the 'favorites' scope.
    720719 *
    721  * @since BuddyPress (2.2.0)
     720 * @since 2.2.0
    722721 *
    723722 * @param array $retval Empty array by default.
     
    777776 * Set up activity arguments for use with the 'favorites' scope.
    778777 *
    779  * @since BuddyPress (2.2.0)
     778 * @since 2.2.0
    780779 *
    781780 * @param array $retval Empty array by default.
  • 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.
  • trunk/src/bp-activity/bp-activity-loader.php

    r9936 r10077  
    11<?php
    2 
    32/**
    43 * BuddyPress Activity Streams Loader.
     
    1615 * Main Activity Class.
    1716 *
    18  * @since BuddyPress (1.5.0)
     17 * @since 1.5.0
    1918 */
    2019class BP_Activity_Component extends BP_Component {
     
    2322         * Start the activity component setup process.
    2423         *
    25          * @since BuddyPress (1.5.0)
     24         * @since 1.5.0
    2625         */
    2726        public function __construct() {
     
    3938         * Include component files.
    4039         *
    41          * @since BuddyPress (1.5.0)
     40         * @since 1.5.0
    4241         *
    4342         * @see BP_Component::includes() for a description of arguments.
     
    8180         * backwards compatibility.
    8281         *
    83          * @since BuddyPress (1.5.0)
     82         * @since 1.5.0
    8483         *
    8584         * @see BP_Component::setup_globals() for a description of arguments.
     
    125124         * Set up component navigation.
    126125         *
    127          * @since BuddyPress (1.5.0)
     126         * @since 1.5.0
    128127         *
    129128         * @see BP_Component::setup_nav() for a description of arguments.
     
    233232         * Set up the component entries in the WordPress Admin Bar.
    234233         *
    235          * @since BuddyPress (1.5.0)
     234         * @since 1.5.0
    236235         *
    237236         * @see BP_Component::setup_nav() for a description of the $wp_admin_nav
     
    330329         * Set up the title for pages and <title>.
    331330         *
    332          * @since BuddyPress (1.5.0)
     331         * @since 1.5.0
    333332         *
    334333         * @uses bp_is_activity_component()
     
    360359         * Set up actions necessary for the component.
    361360         *
    362          * @since BuddyPress (1.6.0)
     361         * @since 1.6.0
    363362         */
    364363        public function setup_actions() {
     
    373372         * Setup cache groups.
    374373         *
    375          * @since BuddyPress (2.2.0)
     374         * @since 2.2.0
    376375         */
    377376        public function setup_cache_groups() {
  • trunk/src/bp-activity/bp-activity-notifications.php

    r9834 r10077  
    11<?php
    2 
    32/**
    43 * BuddyPress Activity Notifications.
     
    1615 * Send email and BP notifications when a user is mentioned in an update.
    1716 *
    18  * @since BuddyPress (1.2.0)
     17 * @since 1.2.0
    1918 *
    2019 * @uses bp_notifications_add_notification()
     
    103102                 * Filters the user email that the @mention notification will be sent to.
    104103                 *
    105                  * @since BuddyPress (1.2.0)
     104                 * @since 1.2.0
    106105                 *
    107106                 * @param string $to User email the notification is being sent to.
     
    112111                 * Filters the @mention notification subject that will be sent to user.
    113112                 *
    114                  * @since BuddyPress (1.2.0)
     113                 * @since 1.2.0
    115114                 *
    116115                 * @param string $subject     Email notification subject text.
     
    122121                 * Filters the @mention notification message that will be sent to user.
    123122                 *
    124                  * @since BuddyPress (1.2.0)
     123                 * @since 1.2.0
    125124                 *
    126125                 * @param string $message       Email notification message text.
     
    138137         * Fires after the sending of an @mention email notification.
    139138         *
    140          * @since BuddyPress (1.5.0)
     139         * @since 1.5.0
    141140         *
    142141         * @param BP_Activity_Activity $activity         Activity Item object.
     
    152151 * Send email and BP notifications when an activity item receives a comment.
    153152 *
    154  * @since BuddyPress (1.2.0)
     153 * @since 1.2.0
    155154 *
    156155 * @uses bp_get_user_meta()
     
    221220                 * Filters the user email that the new comment notification will be sent to.
    222221                 *
    223                  * @since BuddyPress (1.2.0)
     222                 * @since 1.2.0
    224223                 *
    225224                 * @param string $to User email the notification is being sent to.
     
    230229                 * Filters the new comment notification subject that will be sent to user.
    231230                 *
    232                  * @since BuddyPress (1.2.0)
     231                 * @since 1.2.0
    233232                 *
    234233                 * @param string $subject     Email notification subject text.
     
    240239                 * Filters the new comment notification message that will be sent to user.
    241240                 *
    242                  * @since BuddyPress (1.2.0)
     241                 * @since 1.2.0
    243242                 *
    244243                 * @param string $message       Email notification message text.
     
    255254                 * Fires after the sending of a reply to an update email notification.
    256255                 *
    257                  * @since BuddyPress (1.5.0)
     256                 * @since 1.5.0
    258257                 *
    259258                 * @param int    $user_id      ID of the original activity item author.
     
    309308                 * Filters the user email that the new comment reply notification will be sent to.
    310309                 *
    311                  * @since BuddyPress (1.2.0)
     310                 * @since 1.2.0
    312311                 *
    313312                 * @param string $to User email the notification is being sent to.
     
    318317                 * Filters the new comment reply notification subject that will be sent to user.
    319318                 *
    320                  * @since BuddyPress (1.2.0)
     319                 * @since 1.2.0
    321320                 *
    322321                 * @param string $subject     Email notification subject text.
     
    328327                 * Filters the new comment reply notification message that will be sent to user.
    329328                 *
    330                  * @since BuddyPress (1.2.0)
     329                 * @since 1.2.0
    331330                 *
    332331                 * @param string $message       Email notification message text.
     
    343342                 * Fires after the sending of a reply to a reply email notification.
    344343                 *
    345                  * @since BuddyPress (1.5.0)
     344                 * @since 1.5.0
    346345                 *
    347346                 * @param int    $user_id      ID of the parent activity item author.
     
    359358 * Helper method to map action arguments to function parameters.
    360359 *
    361  * @since BuddyPress (1.9.0)
     360 * @since 1.9.0
    362361 *
    363362 * @param int   $comment_id
     
    374373 * Format notifications related to activity.
    375374 *
    376  * @since BuddyPress (1.5.0)
     375 * @since 1.5.0
    377376 *
    378377 * @uses bp_loggedin_user_domain()
     
    420419                 * or bp_activity_multiple_at_mentions_notification.
    421420                 *
    422                  * @since BuddyPress (1.5.0)
     421                 * @since 1.5.0
    423422                 *
    424423                 * @param string $string          HTML anchor tag for the mention.
     
    438437                 * or bp_activity_multiple_at_mentions_notification.
    439438                 *
    440                  * @since BuddyPress (1.5.0)
     439                 * @since 1.5.0
    441440                 *
    442441                 * @param array  $array           Array holding the content and permalink for the mention notification.
     
    455454         * Fires right before returning the formatted activity notifications.
    456455         *
    457          * @since BuddyPress (1.2.0)
     456         * @since 1.2.0
    458457         *
    459458         * @param string $action            The type of activity item.
     
    475474 * 'bp_activity_at_name_send_emails' equivalent helper function.
    476475 *
    477  * @since BuddyPress (1.9.0)
     476 * @since 1.9.0
    478477 *
    479478 * @param object $activity
     
    501500 * Mark at-mention notifications as read when users visit their Mentions page.
    502501 *
    503  * @since BuddyPress (1.5.0)
     502 * @since 1.5.0
    504503 *
    505504 * @uses bp_notifications_mark_all_notifications_by_type()
     
    522521 * Mark at-mention notification as read when user visits the activity with the mention.
    523522 *
    524  * @since BuddyPress (2.0.0)
     523 * @since 2.0.0
    525524 *
    526525 * @param object BP_Activity_Activity
     
    544543 * Delete at-mention notifications when the corresponding activity item is deleted.
    545544 *
    546  * @since BuddyPress (2.0.0)
     545 * @since 2.0.0
    547546 *
    548547 * @param array $activity_ids_deleted IDs of deleted activity items.
  • trunk/src/bp-activity/bp-activity-screens.php

    r9834 r10077  
    11<?php
    2 
    32/**
    43 * BuddyPress Activity Screens.
     
    1817 * Load the Activity directory.
    1918 *
    20  * @since BuddyPress (1.5.0)
     19 * @since 1.5.0
    2120 *
    2221 * @uses bp_displayed_user_id()
     
    3534                 * Fires right before the loading of the Activity directory screen template file.
    3635                 *
    37                  * @since BuddyPress (1.5.0)
     36                 * @since 1.5.0
    3837                 */
    3938                do_action( 'bp_activity_screen_index' );
     
    4241                 * Filters the template to load for the Activity directory screen.
    4342                 *
    44                  * @since BuddyPress (1.5.0)
     43                 * @since 1.5.0
    4544                 *
    4645                 * @param string $template Path to the activity template to load.
     
    5453 * Load the 'My Activity' page.
    5554 *
    56  * @since BuddyPress (1.0.0)
     55 * @since 1.0.0
    5756 *
    5857 * @uses do_action() To call the 'bp_activity_screen_my_activity' hook.
     
    6564         * Fires right before the loading of the "My Activity" screen template file.
    6665         *
    67          * @since BuddyPress (1.0.0)
     66         * @since 1.0.0
    6867         */
    6968        do_action( 'bp_activity_screen_my_activity' );
     
    7271         * Filters the template to load for the "My Activity" screen.
    7372         *
    74          * @since BuddyPress (1.0.0)
     73         * @since 1.0.0
    7574         *
    7675         * @param string $template Path to the activity template to load.
     
    8281 * Load the 'My Friends' activity page.
    8382 *
    84  * @since BuddyPress (1.0.0)
     83 * @since 1.0.0
    8584 *
    8685 * @uses bp_is_active()
     
    10099         * Fires right before the loading of the "My Friends" screen template file.
    101100         *
    102          * @since BuddyPress (1.2.0)
     101         * @since 1.2.0
    103102         */
    104103        do_action( 'bp_activity_screen_friends' );
     
    107106         * Filters the template to load for the "My Friends" screen.
    108107         *
    109          * @since BuddyPress (1.0.0)
     108         * @since 1.0.0
    110109         *
    111110         * @param string $template Path to the activity template to load.
     
    117116 * Load the 'My Groups' activity page.
    118117 *
    119  * @since BuddyPress (1.2.0)
     118 * @since 1.2.0
    120119 *
    121120 * @uses bp_is_active()
     
    135134         * Fires right before the loading of the "My Groups" screen template file.
    136135         *
    137          * @since BuddyPress (1.2.0)
     136         * @since 1.2.0
    138137         */
    139138        do_action( 'bp_activity_screen_groups' );
     
    142141         * Filters the template to load for the "My Groups" screen.
    143142         *
    144          * @since BuddyPress (1.2.0)
     143         * @since 1.2.0
    145144         *
    146145         * @param string $template Path to the activity template to load.
     
    152151 * Load the 'Favorites' activity page.
    153152 *
    154  * @since BuddyPress (1.2.0)
     153 * @since 1.2.0
    155154 *
    156155 * @uses bp_update_is_item_admin()
     
    166165         * Fires right before the loading of the "Favorites" screen template file.
    167166         *
    168          * @since BuddyPress (1.2.0)
     167         * @since 1.2.0
    169168         */
    170169        do_action( 'bp_activity_screen_favorites' );
     
    173172         * Filters the template to load for the "Favorites" screen.
    174173         *
    175          * @since BuddyPress (1.2.0)
     174         * @since 1.2.0
    176175         *
    177176         * @param string $template Path to the activity template to load.
     
    183182 * Load the 'Mentions' activity page.
    184183 *
    185  * @since BuddyPress (1.2.0)
     184 * @since 1.2.0
    186185 *
    187186 * @uses bp_update_is_item_admin()
     
    197196         * Fires right before the loading of the "Mentions" screen template file.
    198197         *
    199          * @since BuddyPress (1.2.0)
     198         * @since 1.2.0
    200199         */
    201200        do_action( 'bp_activity_screen_mentions' );
     
    204203         * Filters the template to load for the "Mentions" screen.
    205204         *
    206          * @since BuddyPress (1.2.0)
     205         * @since 1.2.0
    207206         *
    208207         * @param string $template Path to the activity template to load.
     
    214213 * Reset the logged-in user's new mentions data when he visits his mentions screen.
    215214 *
    216  * @since BuddyPress (1.5.0)
     215 * @since 1.5.0
    217216 *
    218217 * @uses bp_is_my_profile()
     
    229228 * Load the page for a single activity item.
    230229 *
    231  * @since BuddyPress (1.2.0)
     230 * @since 1.2.0
    232231 *
    233232 * @uses bp_is_activity_component()
     
    303302         * Filters the access permission for a single activity view.
    304303         *
    305          * @since BuddyPress (1.2.0)
     304         * @since 1.2.0
    306305         *
    307306         * @param array $access Array holding the current $has_access value and current activity item instance.
     
    312311         * Fires before the loading of a single activity template file.
    313312         *
    314          * @since BuddyPress (1.2.0)
     313         * @since 1.2.0
    315314         *
    316315         * @param BP_Activity_Activity $activity   Object representing the current activity item being displayed.
     
    342341         * Filters the template to load for a single activity screen.
    343342         *
    344          * @since BuddyPress (1.0.0)
     343         * @since 1.0.0
    345344         *
    346345         * @param string $template Path to the activity template to load.
     
    353352 * Add activity notifications settings to the notifications settings page.
    354353 *
    355  * @since BuddyPress (1.2.0)
     354 * @since 1.2.0
    356355 *
    357356 * @uses bp_get_user_meta()
     
    405404                         * Fires inside the closing </tbody> tag for activity screen notification settings.
    406405                         *
    407                          * @since BuddyPress (1.2.0)
     406                         * @since 1.2.0
    408407                         */
    409408                        do_action( 'bp_activity_screen_notification_settings' ) ?>
     
    423422 * activity template parts to the_title and the_content areas of a theme.
    424423 *
    425  * @since BuddyPress (1.7.0)
     424 * @since 1.7.0
    426425 */
    427426class BP_Activity_Theme_Compat {
     
    430429         * Set up the activity component theme compatibility.
    431430         *
    432          * @since BuddyPress (1.7.0)
     431         * @since 1.7.0
    433432         */
    434433        public function __construct() {
     
    439438         * Set up the theme compatibility hooks, if we're looking at an activity page.
    440439         *
    441          * @since BuddyPress (1.7.0)
     440         * @since 1.7.0
    442441         */
    443442        public function is_activity() {
     
    473472         * This is to mirror how WordPress has {@link https://codex.wordpress.org/Template_Hierarchy template hierarchy}.
    474473         *
    475          * @since BuddyPress (1.8.0)
     474         * @since 1.8.0
    476475         *
    477476         * @param string $templates The templates from bp_get_theme_compat_templates().
     
    484483                 * Filters the template hierarchy for the activity directory page.
    485484                 *
    486                  * @since BuddyPress (1.8.0)
     485                 * @since 1.8.0
    487486                 *
    488487                 * @param array $index-directory Array holding template names to be merged into template list.
     
    502501         * Update the global $post with directory data.
    503502         *
    504          * @since BuddyPress (1.7.0)
     503         * @since 1.7.0
    505504         */
    506505        public function directory_dummy_post() {
     
    521520         * Filter the_content with the groups index template part.
    522521         *
    523          * @since BuddyPress (1.7.0)
     522         * @since 1.7.0
    524523         */
    525524        public function directory_content() {
     
    534533         * This is to mirror how WordPress has {@link https://codex.wordpress.org/Template_Hierarchy template hierarchy}.
    535534         *
    536          * @since BuddyPress (1.8.0)
     535         * @since 1.8.0
    537536         *
    538537         * @param string $templates The templates from bp_get_theme_compat_templates().
     
    545544                 * Filters the template hierarchy for the activity permalink pages.
    546545                 *
    547                  * @since BuddyPress (1.8.0)
     546                 * @since 1.8.0
    548547                 *
    549548                 * @param array $index Array holding template names to be merged into template list.
     
    563562         * Update the global $post with the displayed user's data.
    564563         *
    565          * @since BuddyPress (1.7.0)
     564         * @since 1.7.0
    566565         */
    567566        public function single_dummy_post() {
     
    582581         * Filter the_content with the members' activity permalink template part.
    583582         *
    584          * @since BuddyPress (1.7.0)
     583         * @since 1.7.0
    585584         */
    586585        public function single_dummy_content() {
  • trunk/src/bp-activity/bp-activity-template.php

    r9834 r10077  
    11<?php
    2 
    32/**
    43 * BuddyPress Activity Template Functions.
     
    1413 * Output the activity component slug.
    1514 *
    16  * @since BuddyPress (1.5.0)
     15 * @since 1.5.0
    1716 *
    1817 * @uses bp_get_activity_slug()
     
    2423         * Return the activity component slug.
    2524         *
    26          * @since BuddyPress (1.5.0)
     25         * @since 1.5.0
    2726         *
    2827         * @uses apply_filters() To call the 'bp_get_activity_slug' hook.
     
    3534                 * Filters the activity component slug.
    3635                 *
    37                  * @since BuddyPress (1.5.0)
     36                 * @since 1.5.0
    3837                 *
    3938                 * @param string $slug Activity component slug.
     
    4544 * Output the activity component root slug.
    4645 *
    47  * @since BuddyPress (1.5.0)
     46 * @since 1.5.0
    4847 *
    4948 * @uses bp_get_activity_root_slug()
     
    5554         * Return the activity component root slug.
    5655         *
    57          * @since BuddyPress (1.5.0)
     56         * @since 1.5.0
    5857         *
    5958         * @uses apply_filters() To call the 'bp_get_activity_root_slug' hook.
     
    6665                 * Filters the activity component root slug.
    6766                 *
    68                  * @since BuddyPress (1.5.0)
     67                 * @since 1.5.0
    6968                 *
    7069                 * @param string $root_slug Activity component root slug.
     
    7675 * Output activity directory permalink.
    7776 *
    78  * @since BuddyPress (1.5.0)
     77 * @since 1.5.0
    7978 *
    8079 * @uses bp_get_activity_directory_permalink()
     
    8685         * Return activity directory permalink.
    8786         *
    88          * @since BuddyPress (1.5.0)
     87         * @since 1.5.0
    8988         *
    9089         * @uses trailingslashit()
     
    10099                 * Filters the activity directory permalink.
    101100                 *
    102                  * @since BuddyPress (1.5.0)
     101                 * @since 1.5.0
    103102                 *
    104103                 * @param string $url Permalink url for the activity directory.
     
    112111 * This is responsible for loading a group of activity items and displaying them.
    113112 *
    114  * @since BuddyPress (1.0.0)
     113 * @since 1.0.0
    115114 */
    116115class BP_Activity_Template {
     
    118117         * The loop iterator.
    119118         *
    120          * @since BuddyPress (1.5.0)
     119         * @since 1.5.0
    121120         * @access public
    122121         * @var int
     
    127126         * The activity count.
    128127         *
    129          * @since BuddyPress (1.5.0)
     128         * @since 1.5.0
    130129         * @access public
    131130         * @var int
     
    136135         * The total activity count.
    137136         *
    138          * @since BuddyPress (1.5.0)
     137         * @since 1.5.0
    139138         * @access public
    140139         * @var int
     
    145144         * Array of activities located by the query.
    146145         *
    147          * @since BuddyPress (1.5.0)
     146         * @since 1.5.0
    148147         * @access public
    149148         * @var array
     
    154153         * The activity object currently being iterated on.
    155154         *
    156          * @since BuddyPress (1.5.0)
     155         * @since 1.5.0
    157156         * @access public
    158157         * @var object
     
    163162         * A flag for whether the loop is currently being iterated.
    164163         *
    165          * @since BuddyPress (1.5.0)
     164         * @since 1.5.0
    166165         * @access public
    167166         * @var bool
     
    172171         * URL parameter key for activity pagination. Default: 'acpage'.
    173172         *
    174          * @since BuddyPress (2.1.0)
     173         * @since 2.1.0
    175174         * @var string
    176175         */
     
    180179         * The page number being requested.
    181180         *
    182          * @since BuddyPress (1.5.0)
     181         * @since 1.5.0
    183182         * @access public
    184183         * @var int
     
    189188         * The number of items being requested per page.
    190189         *
    191          * @since BuddyPress (1.5.0)
     190         * @since 1.5.0
    192191         * @access public
    193192         * @var int
     
    198197         * An HTML string containing pagination links.
    199198         *
    200          * @since BuddyPress (1.5.0)
     199         * @since 1.5.0
    201200         * @access public
    202201         * @var string
     
    207206         * The displayed user's full name.
    208207         *
    209          * @since BuddyPress (1.5.0)
     208         * @since 1.5.0
    210209         * @access public
    211210         * @var string
     
    457456                         * Fires right before the rewinding of activity posts.
    458457                         *
    459                          * @since BuddyPress (1.1.0)
     458                         * @since 1.1.0
    460459                         */
    461460                        do_action( 'activity_loop_end' );
     
    494493                         * Fires if the current activity item is the first in the activity loop.
    495494                         *
    496                          * @since BuddyPress (1.1.0)
     495                         * @since 1.1.0
    497496                         */
    498497                        do_action('activity_loop_start');
     
    508507 * template functions to display a list of activity items.
    509508 *
    510  * @since BuddyPress (1.0.0)
     509 * @since 1.0.0
    511510 *
    512511 * @global object $activities_template {@link BP_Activity_Template}
     
    713712         * into bp-custom.php or your theme's functions.php.
    714713         *
    715          * @since BuddyPress (1.6.0)
     714         * @since 1.6.0
    716715         *
    717716         * @param bool $value True if BuddyPress should enable afilter support.
     
    748747         * Filters whether or not there are activity items to display.
    749748         *
    750          * @since BuddyPress (1.1.0)
     749         * @since 1.1.0
    751750         *
    752751         * @param bool   $value               Whether or not there are activity items to display.
     
    760759 * Determine if there are still activities left in the loop.
    761760 *
    762  * @since BuddyPress (1.0.0)
     761 * @since 1.0.0
    763762 *
    764763 * @global object $activities_template {@link BP_Activity_Template}
     
    775774 * Get the current activity object in the loop.
    776775 *
    777  * @since BuddyPress (1.0.0)
     776 * @since 1.0.0
    778777 *
    779778 * @global object $activities_template {@link BP_Activity_Template}
     
    790789 * Output the URL for the Load More link.
    791790 *
    792  * @since BuddyPress (2.1.0)
     791 * @since 2.1.0
    793792 */
    794793function bp_activity_load_more_link() {
     
    798797         * Get the URL for the Load More link.
    799798         *
    800          * @since BuddyPress (2.1.0)
     799         * @since 2.1.0
    801800         */
    802801        function bp_get_activity_load_more_link() {
     
    809808                 * Filters the Load More link URL.
    810809                 *
    811                  * @since BuddyPress (2.1.0)
     810                 * @since 2.1.0
    812811                 *
    813812                 * @param string $link                The "Load More" link URL with appropriate query args.
     
    821820 * Output the activity pagination count.
    822821 *
    823  * @since BuddyPress (1.0.0)
     822 * @since 1.0.0
    824823 *
    825824 * @global object $activities_template {@link BP_Activity_Template}
     
    833832         * Return the activity pagination count.
    834833         *
    835          * @since BuddyPress (1.2.0)
     834         * @since 1.2.0
    836835         *
    837836         * @global object $activities_template {@link BP_Activity_Template}
     
    860859 * Output the activity pagination links.
    861860 *
    862  * @since BuddyPress (1.0.0)
     861 * @since 1.0.0
    863862 *
    864863 * @uses bp_get_activity_pagination_links()
     
    871870         * Return the activity pagination links.
    872871         *
    873          * @since BuddyPress (1.0.0)
     872         * @since 1.0.0
    874873         *
    875874         * @global object $activities_template {@link BP_Activity_Template}
     
    884883                 * Filters the activity pagination link output.
    885884                 *
    886                  * @since BuddyPress (1.0.0)
     885                 * @since 1.0.0
    887886                 *
    888887                 * @param string $pag_links Output for the activity pagination links.
     
    894893 * Return true when there are more activity items to be shown than currently appear.
    895894 *
    896  * @since BuddyPress (1.5.0)
     895 * @since 1.5.0
    897896 *
    898897 * @global object $activities_template {@link BP_Activity_Template}
     
    919918         * Filters whether there are more activity items to display.
    920919         *
    921          * @since BuddyPress (1.5.0)
     920         * @since 1.5.0
    922921         *
    923922         * @param bool $has_more_items Whether or not there are more activity items to display.
     
    929928 * Output the activity count.
    930929 *
    931  * @since BuddyPress (1.2.0)
     930 * @since 1.2.0
    932931 *
    933932 * @uses bp_get_activity_count()
     
    940939         * Return the activity count.
    941940         *
    942          * @since BuddyPress (1.2.0)
     941         * @since 1.2.0
    943942         *
    944943         * @global object $activities_template {@link BP_Activity_Template}
     
    953952                 * Filters the activity count for the activity template.
    954953                 *
    955                  * @since BuddyPress (1.2.0)
     954                 * @since 1.2.0
    956955                 *
    957956                 * @param int $activity_count The count for total activity.
     
    963962 * Output the number of activities per page.
    964963 *
    965  * @since BuddyPress (1.2.0)
     964 * @since 1.2.0
    966965 *
    967966 * @uses bp_get_activity_per_page()
     
    974973         * Return the number of activities per page.
    975974         *
    976          * @since BuddyPress (1.2.0)
     975         * @since 1.2.0
    977976         *
    978977         * @global object $activities_template {@link BP_Activity_Template}
     
    987986                 * Filters the activity posts per page value.
    988987                 *
    989                  * @since BuddyPress (1.2.0)
     988                 * @since 1.2.0
    990989                 *
    991990                 * @param int $pag_num How many post should be displayed for pagination.
     
    997996 * Output the activities title.
    998997 *
    999  * @since BuddyPress (1.0.0)
     998 * @since 1.0.0
    1000999 *
    10011000 * @uses bp_get_activities_title()
     
    10091008         * Return the activities title.
    10101009         *
    1011          * @since BuddyPress (1.0.0)
     1010         * @since 1.0.0
    10121011         *
    10131012         * @global string $bp_activity_title
     
    10231022                 * Filters the activities title for the activity template.
    10241023                 *
    1025                  * @since BuddyPress (1.0.0)
     1024                 * @since 1.0.0
    10261025                 *
    10271026                 * @param string $bp_activity_title The title to be displayed.
     
    10331032 * {@internal Missing Description}
    10341033 *
    1035  * @since BuddyPress (1.0.0)
     1034 * @since 1.0.0
    10361035 *
    10371036 * @uses bp_get_activities_no_activity()
     
    10451044         * {@internal Missing Description}
    10461045         *
    1047          * @since BuddyPress (1.0.0)
     1046         * @since 1.0.0
    10481047         *
    10491048         * @global string $bp_activity_no_activity
     
    10591058                 * Filters the text used when there is no activity to display.
    10601059                 *
    1061                  * @since BuddyPress (1.0.0)
     1060                 * @since 1.0.0
    10621061                 *
    10631062                 * @param string $bp_activity_no_activity Text to display for no activity.
     
    10691068 * Output the activity ID.
    10701069 *
    1071  * @since BuddyPress (1.2.0)
     1070 * @since 1.2.0
    10721071 *
    10731072 * @uses bp_get_activity_id()
     
    10801079         * Return the activity ID.
    10811080         *
    1082          * @since BuddyPress (1.2.0)
     1081         * @since 1.2.0
    10831082         *
    10841083         * @global object $activities_template {@link BP_Activity_Template}
     
    10931092                 * Filters the activity ID being displayed.
    10941093                 *
    1095                  * @since BuddyPress (1.2.0)
     1094                 * @since 1.2.0
    10961095                 *
    10971096                 * @param int $id The activity ID.
     
    11031102 * Output the activity item ID.
    11041103 *
    1105  * @since BuddyPress (1.2.0)
     1104 * @since 1.2.0
    11061105 *
    11071106 * @uses bp_get_activity_item_id()
     
    11141113         * Return the activity item ID.
    11151114         *
    1116          * @since BuddyPress (1.2.0)
     1115         * @since 1.2.0
    11171116         *
    11181117         * @global object $activities_template {@link BP_Activity_Template}
     
    11271126                 * Filters the activity item ID being displayed.
    11281127                 *
    1129                  * @since BuddyPress (1.2.0)
     1128                 * @since 1.2.0
    11301129                 *
    11311130                 * @param int $item_id The activity item ID.
     
    11371136 * Output the activity secondary item ID.
    11381137 *
    1139  * @since BuddyPress (1.2.0)
     1138 * @since 1.2.0
    11401139 *
    11411140 * @uses bp_get_activity_secondary_item_id()
     
    11481147         * Return the activity secondary item ID.
    11491148         *
    1150          * @since BuddyPress (1.2.0)
     1149         * @since 1.2.0
    11511150         *
    11521151         * @global object $activities_template {@link BP_Activity_Template}
     
    11611160                 * Filters the activity secondary item ID being displayed.
    11621161                 *
    1163                  * @since BuddyPress (1.2.0)
     1162                 * @since 1.2.0
    11641163                 *
    11651164                 * @param int $secondary_item_id The activity secondary item ID.
     
    11711170 * Output the date the activity was recorded.
    11721171 *
    1173  * @since BuddyPress (1.2.0)
     1172 * @since 1.2.0
    11741173 *
    11751174 * @uses bp_get_activity_date_recorded()
     
    11821181         * Return the date the activity was recorded.
    11831182         *
    1184          * @since BuddyPress (1.2.0)
     1183         * @since 1.2.0
    11851184         *
    11861185         * @global object $activities_template {@link BP_Activity_Template}
     
    11951194                 * Filters the date the activity was recorded.
    11961195                 *
    1197                  * @since BuddyPress (1.2.0)
     1196                 * @since 1.2.0
    11981197                 *
    11991198                 * @param int $date_recorded The activity's date.
     
    12051204 * Output the display name of the member who posted the activity.
    12061205 *
    1207  * @since BuddyPress (2.1.0)
     1206 * @since 2.1.0
    12081207 *
    12091208 * @uses bp_get_activity_member_display_name()
     
    12161215         * Return the display name of the member who posted the activity.
    12171216         *
    1218          * @since BuddyPress (2.1.0)
     1217         * @since 2.1.0
    12191218         *
    12201219         * @global object $activities_template {@link BP_Activity_Template}
     
    12331232                 * Filters the display name of the member who posted the activity.
    12341233                 *
    1235                  * @since BuddyPress (2.1.0)
     1234                 * @since 2.1.0
    12361235                 *
    12371236                 * @param int $retval Display name for the member who posted.
     
    12431242 * Output the activity object name.
    12441243 *
    1245  * @since BuddyPress (1.2.0)
     1244 * @since 1.2.0
    12461245 *
    12471246 * @uses bp_get_activity_object_name()
     
    12541253         * Return the activity object name.
    12551254         *
    1256          * @since BuddyPress (1.2.0)
     1255         * @since 1.2.0
    12571256         *
    12581257         * @global object $activities_template {@link BP_Activity_Template}
     
    12671266                 * Filters the activity object name.
    12681267                 *
    1269                  * @since BuddyPress (1.2.0)
     1268                 * @since 1.2.0
    12701269                 *
    12711270                 * @param string $activity_component The activity object name.
     
    12771276 * Output the activity type.
    12781277 *
    1279  * @since BuddyPress (1.2.0)
     1278 * @since 1.2.0
    12801279 *
    12811280 * @uses bp_get_activity_type()
     
    12881287         * Return the activity type.
    12891288         *
    1290          * @since BuddyPress (1.2.0)
     1289         * @since 1.2.0
    12911290         *
    12921291         * @global object $activities_template {@link BP_Activity_Template}
     
    13011300                 * Filters the activity type.
    13021301                 *
    1303                  * @since BuddyPress (1.2.0)
     1302                 * @since 1.2.0
    13041303                 *
    13051304                 * @param string $activity_type The activity type.
     
    13131312         * Just a wrapper for bp_activity_type().
    13141313         *
    1315          * @since BuddyPress (1.2.0)
    1316          * @deprecated BuddyPress (1.5.0)
     1314         * @since 1.2.0
     1315         * @deprecated 1.5.0
    13171316         *
    13181317         * @todo Properly deprecate in favor of bp_activity_type() and
     
    13281327         * Just a wrapper for bp_get_activity_type().
    13291328         *
    1330          * @since BuddyPress (1.2.0)
    1331          * @deprecated BuddyPress (1.5.0)
     1329         * @since 1.2.0
     1330         * @deprecated 1.5.0
    13321331         *
    13331332         * @todo Properly deprecate in favor of bp_get_activity_type().
     
    13421341 * Output the activity user ID.
    13431342 *
    1344  * @since BuddyPress (1.1.0)
     1343 * @since 1.1.0
    13451344 *
    13461345 * @uses bp_get_activity_user_id()
     
    13531352         * Return the activity user ID.
    13541353         *
    1355          * @since BuddyPress (1.1.0)
     1354         * @since 1.1.0
    13561355         *
    13571356         * @global object $activities_template {@link BP_Activity_Template}
     
    13661365                 * Filters the activity user ID.
    13671366                 *
    1368                  * @since BuddyPress (1.1.0)
     1367                 * @since 1.1.0
    13691368                 *
    13701369                 * @param int $user_id The activity user ID.
     
    13761375 * Output the activity user link.
    13771376 *
    1378  * @since BuddyPress (1.2.0)
     1377 * @since 1.2.0
    13791378 *
    13801379 * @uses bp_get_activity_user_link()
     
    13871386         * Return the activity user link.
    13881387         *
    1389          * @since BuddyPress (1.2.0)
     1388         * @since 1.2.0
    13901389         *
    13911390         * @global object $activities_template {@link BP_Activity_Template}
     
    14071406                 * Filters the activity user link.
    14081407                 *
    1409                  * @since BuddyPress (1.2.0)
     1408                 * @since 1.2.0
    14101409                 *
    14111410                 * @param string $link The activity user link.
     
    14171416 * Output the avatar of the user that performed the action.
    14181417 *
    1419  * @since BuddyPress (1.1.0)
     1418 * @since 1.1.0
    14201419 *
    14211420 * @see bp_get_activity_avatar() for description of arguments.
     
    14301429         * Return the avatar of the user that performed the action.
    14311430         *
    1432          * @since BuddyPress (1.1.0)
     1431         * @since 1.1.0
    14331432         *
    14341433         * @see bp_core_fetch_avatar() For a description of the arguments.
     
    15091508                 * bp_get_activity_avatar_object_group, and bp_get_activity_avatar_object_user.
    15101509                 *
    1511                  * @since BuddyPress (1.1.0)
     1510                 * @since 1.1.0
    15121511                 *
    15131512                 * @param string $component Component being displayed.
     
    15191518                 * Filters the activity avatar item ID.
    15201519                 *
    1521                  * @since BuddyPress (1.2.10)
     1520                 * @since 1.2.10
    15221521                 *
    15231522                 * @param int $item_id Item ID for the activity avatar.
     
    15331532                 * Filters the value returned by bp_core_fetch_avatar.
    15341533                 *
    1535                  * @since BuddyPress (1.1.3)
     1534                 * @since 1.1.3
    15361535                 *
    15371536                 * @param array $value Array of arguments calculated for use with bp_core_fetch_avatar.
     
    15521551 * Output the avatar of the object that action was performed on.
    15531552 *
    1554  * @since BuddyPress (1.2.0)
     1553 * @since 1.2.0
    15551554 *
    15561555 * @see bp_get_activity_secondary_avatar() for description of arguments.
     
    15661565         * Return the avatar of the object that action was performed on.
    15671566         *
    1568          * @since BuddyPress (1.2.0)
     1567         * @since 1.2.0
    15691568         *
    15701569         * @see bp_core_fetch_avatar() for description of arguments.
     
    16761675                 * and bp_get_activity_secondary_avatar_object_user.
    16771676                 *
    1678                  * @since BuddyPress (1.2.10)
     1677                 * @since 1.2.10
    16791678                 *
    16801679                 * @param string $object Component being displayed.
     
    16851684                 * Filters the activity secondary avatar item ID.
    16861685                 *
    1687                  * @since BuddyPress (1.2.10)
     1686                 * @since 1.2.10
    16881687                 *
    16891688                 * @param int $item_id ID for the secondary avatar item.
     
    17131712                         * Filters the secondary avatar link for current activity.
    17141713                         *
    1715                          * @since BuddyPress (1.7.0)
     1714                         * @since 1.7.0
    17161715                         *
    17171716                         * @param string $link      Link to wrap the avatar image in.
     
    17231722                         * Filters the determined avatar for the secondary activity item.
    17241723                         *
    1725                          * @since BuddyPress (1.2.10)
     1724                         * @since 1.2.10
    17261725                         *
    17271726                         * @param string $avatar Formatted HTML <img> element, or raw avatar URL.
     
    17431742 * Output the activity action.
    17441743 *
    1745  * @since BuddyPress (1.2.0)
     1744 * @since 1.2.0
    17461745 *
    17471746 * @param array $args See bp_get_activity_action()
     
    17551754         * Return the activity action.
    17561755         *
    1757          * @since BuddyPress (1.2.0)
     1756         * @since 1.2.0
    17581757         *
    17591758         * @global object $activities_template {@link BP_Activity_Template}
     
    17791778                 * Filters the activity action before the action is inserted as meta.
    17801779                 *
    1781                  * @since BuddyPress (1.2.10)
     1780                 * @since 1.2.10
    17821781                 *
    17831782                 * @param array $value Array containing the current action, the current activity, and the $args array passed into the function.
     
    17971796                 * Filters the activity action after the action has been inserted as meta.
    17981797                 *
    1799                  * @since BuddyPress (1.2.0)
     1798                 * @since 1.2.0
    18001799                 *
    18011800                 * @param array $value Array containing the current action, the current activity, and the $args array passed into the function.
     
    18111810 * Output the activity content body.
    18121811 *
    1813  * @since BuddyPress (1.2.0)
     1812 * @since 1.2.0
    18141813 *
    18151814 * @uses bp_get_activity_content_body()
     
    18221821         * Return the activity content body.
    18231822         *
    1824          * @since BuddyPress (1.2.0)
     1823         * @since 1.2.0
    18251824         *
    18261825         * @global object $activities_template {@link BP_Activity_Template}
     
    18411840                 * Filters the activity content body.
    18421841                 *
    1843                  * @since BuddyPress (1.2.0)
     1842                 * @since 1.2.0
    18441843                 *
    18451844                 * @param array $value Array containing the current activity content body and the current activity.
     
    18511850 * Does the activity have content?
    18521851 *
    1853  * @since BuddyPress (1.2.0)
     1852 * @since 1.2.0
    18541853 *
    18551854 * @global object $activities_template {@link BP_Activity_Template}
     
    18701869 * Output the activity content.
    18711870 *
    1872  * @since BuddyPress (1.0.0)
    1873  * @deprecated BuddyPress (1.5.0)
     1871 * @since 1.0.0
     1872 * @deprecated 1.5.0
    18741873 *
    18751874 * @todo properly deprecate this function.
     
    18841883         * Return the activity content.
    18851884         *
    1886          * @since BuddyPress (1.0.0)
    1887          * @deprecated BuddyPress (1.5.0)
     1885         * @since 1.0.0
     1886         * @deprecated 1.5.0
    18881887         *
    18891888         * @todo properly deprecate this function.
     
    19131912 * as a link to the item's permalink).
    19141913 *
    1915  * @since BuddyPress (1.2.0)
     1914 * @since 1.2.0
    19161915 *
    19171916 * @global object $activities_template {@link BP_Activity_Template}
     
    19401939         * Filters the activity item time since markup.
    19411940         *
    1942          * @since BuddyPress (1.2.0)
     1941         * @since 1.2.0
    19431942         *
    19441943         * @param array $value Array containing the time since markup and the current activity component.
     
    19641963                 * Filters the activity permalink to be added to the activity content.
    19651964                 *
    1966                  * @since BuddyPress (1.2.0)
     1965                 * @since 1.2.0
    19671966                 *
    19681967                 * @param array $value Array containing the html markup for the activity permalink, after being parsed by sprintf and current activity component.
     
    19791978         * Filters the activity content after activity metadata has been attached.
    19801979         *
    1981          * @since BuddyPress (1.2.0)
     1980         * @since 1.2.0
    19821981         *
    19831982         * @param string $content Activity content with the activity metadata added.
     
    19891988 * Determine if the current user can delete an activity item.
    19901989 *
    1991  * @since BuddyPress (1.2.0)
     1990 * @since 1.2.0
    19921991 *
    19931992 * @global object $activities_template {@link BP_Activity_Template}
     
    20382037         * Filters whether the current user can delete an activity item.
    20392038         *
    2040          * @since BuddyPress (1.5.0)
     2039         * @since 1.5.0
    20412040         *
    20422041         * @param bool   $can_delete Whether the user can delete the item.
     
    20492048 * Output the activity parent content.
    20502049 *
    2051  * @since BuddyPress (1.2.0)
     2050 * @since 1.2.0
    20522051 *
    20532052 * @see bp_get_activity_parent_content() for a description of arguments.
     
    20632062         * Return the activity content.
    20642063         *
    2065          * @since BuddyPress (1.2.0)
     2064         * @since 1.2.0
    20662065         *
    20672066         * @global object $activities_template {@link BP_Activity_Template}
     
    21102109                 * Filters the activity parent content.
    21112110                 *
    2112                  * @since BuddyPress (1.2.0)
     2111                 * @since 1.2.0
    21132112                 *
    21142113                 * @param string $content Content set to be displayed as parent content.
     
    21202119 * Output the parent activity's user ID.
    21212120 *
    2122  * @since BuddyPress (1.7.0)
     2121 * @since 1.7.0
    21232122 */
    21242123function bp_activity_parent_user_id() {
     
    21292128         * Return the parent activity's user ID.
    21302129         *
    2131          * @since BuddyPress (1.7.0)
     2130         * @since 1.7.0
    21322131         *
    21332132         * @global BP_Activity_Template $activities_template
     
    21622161                 * Filters the activity parent item's user ID.
    21632162                 *
    2164                  * @since BuddyPress (1.7.0)
     2163                 * @since 1.7.0
    21652164                 *
    21662165                 * @param int $retval ID for the activity parent's user.
     
    21722171 * Output whether or not the current activity is in a current user's favorites.
    21732172 *
    2174  * @since BuddyPress (1.2.0)
     2173 * @since 1.2.0
    21752174 *
    21762175 * @uses bp_get_activity_is_favorite()
     
    21832182         * Return whether the current activity is in a current user's favorites.
    21842183         *
    2185          * @since BuddyPress (1.2.0)
     2184         * @since 1.2.0
    21862185         *
    21872186         * @global object $activities_template {@link BP_Activity_Template}
     
    21962195                 * Filters whether the current activity item is in the current user's favorites.
    21972196                 *
    2198                  * @since BuddyPress (1.2.0)
     2197                 * @since 1.2.0
    21992198                 *
    22002199                 * @param bool $value Whether or not the current activity item is in the current user's favorites.
     
    22062205 * Output the comment markup for an activity item.
    22072206 *
    2208  * @since BuddyPress (1.2.0)
     2207 * @since 1.2.0
    22092208 *
    22102209 * @todo deprecate $args param
     
    22192218         * Get the comment markup for an activity item.
    22202219         *
    2221          * @since BuddyPress (1.2.0)
     2220         * @since 1.2.0
    22222221         *
    22232222         * @todo deprecate $args param
     
    22492248                 * split between here and the comment.php template.
    22502249                 *
    2251                  * @since BuddyPress (1.2.0)
     2250                 * @since 1.2.0
    22522251                 *
    22532252                 * @param object $comment The activity object currently being recursed.
     
    22722271                         * Filters the opening tag for the template that lists activity comments.
    22732272                         *
    2274                          * @since BuddyPress (1.6.0)
     2273                         * @since 1.6.0
    22752274                         *
    22762275                         * @param string $value Opening tag for the HTML markup to use.
     
    23002299                         * Filters the closing tag for the template that list activity comments.
    23012300                         *
    2302                          * @since BuddyPress (1.6.0)
     2301                         * @since  1.6.0
    23032302                         *
    23042303                         * @param string $value Closing tag for the HTML markup to use.
     
    23102309 * Utility function that returns the comment currently being recursed.
    23112310 *
    2312  * @since BuddyPress (1.5.0)
     2311 * @since 1.5.0
    23132312 *
    23142313 * @global object $activities_template {@link BP_Activity_Template}
     
    23282327         * Filters the current comment being recursed.
    23292328         *
    2330          * @since BuddyPress (1.5.0)
     2329         * @since 1.5.0
    23312330         *
    23322331         * @param object|bool $current_comment The activity comment currently being displayed. False on failure.
     
    23392338 * Output the ID of the activity comment currently being displayed.
    23402339 *
    2341  * @since BuddyPress (1.5.0)
     2340 * @since 1.5.0
    23422341 *
    23432342 * @uses bp_get_activity_comment_id()
     
    23502349         * Return the ID of the activity comment currently being displayed.
    23512350         *
    2352          * @since BuddyPress (1.5.0)
     2351         * @since 1.5.0
    23532352         *
    23542353         * @global object $activities_template {@link BP_Activity_Template}
     
    23662365                 * Filters the ID of the activity comment currently being displayed.
    23672366                 *
    2368                  * @since BuddyPress (1.5.0)
     2367                 * @since 1.5.0
    23692368                 *
    23702369                 * @param int|bool $comment_id ID for the comment currently being displayed.
     
    23762375 * Output the ID of the author of the activity comment currently being displayed.
    23772376 *
    2378  * @since BuddyPress (1.5.0)
     2377 * @since 1.5.0
    23792378 *
    23802379 * @uses bp_get_activity_comment_user_id()
     
    23872386         * Return the ID of the author of the activity comment currently being displayed.
    23882387         *
    2389          * @since BuddyPress (1.5.0)
     2388         * @since 1.5.0
    23902389         *
    23912390         * @global object $activities_template {@link BP_Activity_Template}
     
    24032402                 * Filters the ID of the author of the activity comment currently being displayed.
    24042403                 *
    2405                  * @since BuddyPress (1.5.0)
     2404                 * @since 1.5.0
    24062405                 *
    24072406                 * @param int|bool $user_id ID for the author of the comment currently being displayed.
     
    24132412 * Output the author link for the activity comment currently being displayed.
    24142413 *
    2415  * @since BuddyPress (1.5.0)
     2414 * @since 1.5.0
    24162415 *
    24172416 * @uses bp_get_activity_comment_user_link()
     
    24242423         * Return the author link for the activity comment currently being displayed.
    24252424         *
    2426          * @since BuddyPress (1.5.0)
     2425         * @since 1.5.0
    24272426         *
    24282427         * @uses bp_core_get_user_domain()
     
    24382437                 * Filters the author link for the activity comment currently being displayed.
    24392438                 *
    2440                  * @since BuddyPress (1.5.0)
     2439                 * @since 1.5.0
    24412440                 *
    24422441                 * @param string $user_link Link for the author of the activity comment currently being displayed.
     
    24482447 * Output the author name for the activity comment currently being displayed.
    24492448 *
    2450  * @since BuddyPress (1.5.0)
     2449 * @since 1.5.0
    24512450 *
    24522451 * @uses bp_get_activity_comment_name()
     
    24622461         * 'bp_activity_comment_name'.
    24632462         *
    2464          * @since BuddyPress (1.5.0)
     2463         * @since 1.5.0
    24652464         *
    24662465         * @global object $activities_template {@link BP_Activity_Template}
     
    24832482                 * Filters the name of the author for the activity comment.
    24842483                 *
    2485                  * @since BuddyPress (1.5.0)
     2484                 * @since 1.5.0
    24862485                 *
    24872486                 * @param string $name Name to be displayed with the activity comment.
     
    24932492 * Output the formatted date_recorded of the activity comment currently being displayed.
    24942493 *
    2495  * @since BuddyPress (1.5.0)
     2494 * @since 1.5.0
    24962495 *
    24972496 * @uses bp_get_activity_comment_date_recorded()
     
    25042503         * Return the formatted date_recorded for the activity comment currently being displayed.
    25052504         *
    2506          * @since BuddyPress (1.5.0)
     2505         * @since 1.5.0
    25072506         *
    25082507         * @uses bp_core_time_since()
     
    25172516                 * Filters the recorded date of the activity comment currently being displayed.
    25182517                 *
    2519                  * @since BuddyPress (1.5.0)
     2518                 * @since 1.5.0
    25202519                 *
    25212520                 * @param string|bool Date for the activity comment currently being displayed.
     
    25272526 * Output the date_recorded of the activity comment currently being displayed.
    25282527 *
    2529  * @since BuddyPress (2.3.0)
     2528 * @since 2.3.0
    25302529 *
    25312530 * @uses bp_get_activity_comment_date_recorded()
     
    25382537         * Return the date_recorded for the activity comment currently being displayed.
    25392538         *
    2540          * @since BuddyPress (2.3.0)
     2539         * @since 2.3.0
    25412540         *
    25422541         * @global object $activities_template {@link BP_Activity_Template}
     
    25532552                 * Filters the raw recorded date of the activity comment currently being displayed.
    25542553                 *
    2555                  * @since BuddyPress (2.3.0)
     2554                 * @since 2.3.0
    25562555                 *
    25572556                 * @param string|bool Raw date for the activity comment currently being displayed.
     
    25632562 * Output the 'delete' URL for the activity comment currently being displayed.
    25642563 *
    2565  * @since BuddyPress (1.5.0)
     2564 * @since 1.5.0
    25662565 *
    25672566 * @uses bp_get_activity_comment_delete_link()
     
    25742573         * Gets the 'delete' URL for the activity comment currently being displayed.
    25752574         *
    2576          * @since BuddyPress (1.5.0)
     2575         * @since 1.5.0
    25772576         *
    25782577         * @uses wp_nonce_url()
     
    25912590                 * Filters the link used for deleting the activity comment currently being displayed.
    25922591                 *
    2593                  * @since BuddyPress (1.5.0)
     2592                 * @since 1.5.0
    25942593                 *
    25952594                 * @param string $link Link to use for deleting the currently displayed activity comment.
     
    26012600 * Output the content of the activity comment currently being displayed.
    26022601 *
    2603  * @since BuddyPress (1.5.0)
     2602 * @since 1.5.0
    26042603 *
    26052604 * @uses bp_get_activity_comment_content()
     
    26172616         * comments only.
    26182617         *
    2619          * @since BuddyPress (1.5.0)
     2618         * @since 1.5.0
    26202619         *
    26212620         * @global object $activities_template {@link BP_Activity_Template}
     
    26342633                 * Filters the content of the current activity comment.
    26352634                 *
    2636                  * @since BuddyPress (1.2.0)
     2635                 * @since 1.2.0
    26372636                 *
    26382637                 * @param string $content The content of the current activity comment.
     
    26442643 * Output the activity comment count.
    26452644 *
    2646  * @since BuddyPress (1.2.0)
     2645 * @since 1.2.0
    26472646 *
    26482647 * @uses bp_activity_get_comment_count()
     
    26552654         * Return the comment count of an activity item.
    26562655         *
    2657          * @since BuddyPress (1.2.0)
     2656         * @since 1.2.0
    26582657         *
    26592658         * @global object $activities_template {@link BP_Activity_Template}
     
    26812680                 * Filters the activity comment count.
    26822681                 *
    2683                  * @since BuddyPress (1.2.0)
     2682                 * @since 1.2.0
    26842683                 *
    26852684                 * @param int $count The activity comment count.
     
    26942693                 * activity child has, and returns them.
    26952694                 *
    2696                  * @since BuddyPress (1.2.0)
     2695                 * @since 1.2.0
    26972696                 *
    26982697                 * @uses bp_activity_recurse_comment_count()
     
    27202719                         * Filters the total number of comments for the current comment.
    27212720                         *
    2722                          * @since BuddyPress (2.1.0)
     2721                         * @since 2.1.0
    27232722                         *
    27242723                         * @param int    $new_count New total count for the current comment.
     
    27322731 * Output the depth of the current activity comment.
    27332732 *
    2734  * @since BuddyPress (2.0.0)
     2733 * @since 2.0.0
    27352734 */
    27362735function bp_activity_comment_depth() {
     
    27402739         * Return the current activity comment depth.
    27412740         *
    2742          * @since BuddyPress (2.0.0)
     2741         * @since 2.0.0
    27432742         *
    27442743         * @return int $depth Depth for the current activity comment.
     
    27502749                 * Filters the comment depth of the current activity comment.
    27512750                 *
    2752                  * @since BuddyPress (2.0.0)
     2751                 * @since 2.0.0
    27532752                 *
    27542753                 * @param int $depth Depth for the current activity comment.
     
    27602759 * Output the activity comment link.
    27612760 *
    2762  * @since BuddyPress (1.2.0)
     2761 * @since 1.2.0
    27632762 *
    27642763 * @uses bp_get_activity_comment_link()
     
    27712770         * Return the activity comment link.
    27722771         *
    2773          * @since BuddyPress (1.2.0)
     2772         * @since 1.2.0
    27742773         *
    27752774         * @global object $activities_template {@link BP_Activity_Template}
     
    27842783                 * Filters the comment link for the current activity comment.
    27852784                 *
    2786                  * @since BuddyPress (1.2.0)
     2785                 * @since 1.2.0
    27872786                 *
    27882787                 * @param string $value Constructed URL parameters with activity IDs.
     
    27942793 * Output the activity comment form no JavaScript display CSS.
    27952794 *
    2796  * @since BuddyPress (1.2.0)
     2795 * @since 1.2.0
    27972796 *
    27982797 * @uses bp_get_activity_comment_form_nojs_display()
     
    28052804         * Return the activity comment form no JavaScript display CSS.
    28062805         *
    2807          * @since BuddyPress (1.2.0)
     2806         * @since 1.2.0
    28082807         *
    28092808         * @global object $activities_template {@link BP_Activity_Template}
     
    28252824 * Output the activity comment form action.
    28262825 *
    2827  * @since BuddyPress (1.2.0)
     2826 * @since 1.2.0
    28282827 *
    28292828 * @uses bp_get_activity_comment_form_action()
     
    28362835         * Return the activity comment form action.
    28372836         *
    2838          * @since BuddyPress (1.2.0)
     2837         * @since 1.2.0
    28392838         *
    28402839         * @uses home_url()
     
    28492848                 * Filters the activity comment form action URL.
    28502849                 *
    2851                  * @since BuddyPress (1.2.0)
     2850                 * @since 1.2.0
    28522851                 *
    28532852                 * @param string $value URL to use in the comment form's action attribute.
     
    28592858 * Output the activity permalink ID.
    28602859 *
    2861  * @since BuddyPress (1.2.0)
     2860 * @since 1.2.0
    28622861 *
    28632862 * @uses bp_get_activity_permalink_id()
     
    28702869         * Return the activity permalink ID.
    28712870         *
    2872          * @since BuddyPress (1.2.0)
     2871         * @since 1.2.0
    28732872         *
    28742873         * @uses apply_filters() To call the 'bp_get_activity_permalink_id' hook.
     
    28812880                 * Filters the activity action permalink ID.
    28822881                 *
    2883                  * @since BuddyPress (1.2.0)
     2882                 * @since 1.2.0
    28842883                 *
    28852884                 * @param string $value Current action for the activity item.
     
    28912890 * Output the activity thread permalink.
    28922891 *
    2893  * @since BuddyPress (1.2.0)
     2892 * @since 1.2.0
    28942893 *
    28952894 * @uses bp_get_activity_permalink_id()
     
    29022901         * Return the activity thread permalink.
    29032902         *
    2904          * @since BuddyPress (1.2.0)
     2903         * @since 1.2.0
    29052904         *
    29062905         * @uses bp_activity_get_permalink()
     
    29172916                 * Filters the activity thread permalink.
    29182917                 *
    2919                  * @since BuddyPress (1.2.0)
     2918                 * @since 1.2.0
    29202919                 *
    29212920                 * @param string $link The activity thread permalink.
     
    29272926 * Output the activity comment permalink.
    29282927 *
    2929  * @since BuddyPress (1.8.0)
     2928 * @since 1.8.0
    29302929 *
    29312930 * @uses bp_get_activity_permalink_id()
     
    29372936         * Return the activity comment permalink.
    29382937         *
    2939          * @since BuddyPress (1.8.0)
     2938         * @since 1.8.0
    29402939         *
    29412940         * @uses bp_activity_get_permalink()
     
    29632962                 * Filters the activity comment permalink.
    29642963                 *
    2965                  * @since BuddyPress (1.8.0)
     2964                 * @since 1.8.0
    29662965                 *
    29672966                 * @param string $link       Activity comment permalink.
     
    29742973 * Output the activity favorite link.
    29752974 *
    2976  * @since BuddyPress (1.2.0)
     2975 * @since 1.2.0
    29772976 *
    29782977 * @uses bp_get_activity_favorite_link()
     
    29852984         * Return the activity favorite link.
    29862985         *
    2987          * @since BuddyPress (1.2.0)
     2986         * @since 1.2.0
    29882987         *
    29892988         * @global object $activities_template {@link BP_Activity_Template}
     
    30013000                 * Filters the activity favorite link.
    30023001                 *
    3003                  * @since BuddyPress (1.2.0)
     3002                 * @since 1.2.0
    30043003                 *
    30053004                 * @param string $value Constructed link for favoriting the activity comment.
     
    30113010 * Output the activity unfavorite link.
    30123011 *
    3013  * @since BuddyPress (1.2.0)
     3012 * @since 1.2.0
    30143013 *
    30153014 * @uses bp_get_activity_unfavorite_link()
     
    30223021         * Return the activity unfavorite link.
    30233022         *
    3024          * @since BuddyPress (1.2.0)
     3023         * @since 1.2.0
    30253024         *
    30263025         * @global object $activities_template {@link BP_Activity_Template}
     
    30383037                 * Filters the activity unfavorite link.
    30393038                 *
    3040                  * @since BuddyPress (1.2.0)
     3039                 * @since 1.2.0
    30413040                 *
    30423041                 * @param string $value Constructed link for unfavoriting the activity comment.
     
    30483047 * Output the activity CSS class.
    30493048 *
    3050  * @since BuddyPress (1.0.0)
     3049 * @since 1.0.0
    30513050 *
    30523051 * @uses bp_get_activity_css_class()
     
    30593058         * Return the current activity item's CSS class.
    30603059         *
    3061          * @since BuddyPress (1.0.0)
     3060         * @since 1.0.0
    30623061         *
    30633062         * @global object $activities_template {@link BP_Activity_Template}
     
    30753074                 * Filters the available mini activity actions available as CSS classes.
    30763075                 *
    3077                  * @since BuddyPress (1.2.0)
     3076                 * @since 1.2.0
    30783077                 *
    30793078                 * @param array $value Array of classes used to determine classes applied to HTML element.
     
    31013100                 * Filters the determined classes to add to the HTML element.
    31023101                 *
    3103                  * @since BuddyPress (1.0.0)
     3102                 * @since 1.0.0
    31043103                 *
    31053104                 * @param string $value Classes to be added to the HTML element.
     
    31113110 * Output the activity delete link.
    31123111 *
    3113  * @since BuddyPress (1.1.0)
     3112 * @since 1.1.0
    31143113 *
    31153114 * @uses bp_get_activity_delete_link()
     
    31223121         * Return the activity delete link.
    31233122         *
    3124          * @since BuddyPress (1.1.0)
     3123         * @since 1.1.0
    31253124         *
    31263125         * @global object $activities_template {@link BP_Activity_Template}
     
    31513150                 * Filters the activity delete link.
    31523151                 *
    3153                  * @since BuddyPress (1.1.0)
     3152                 * @since 1.1.0
    31543153                 *
    31553154                 * @param string $link Activity delete HTML link.
     
    31613160 * Output the URL to delete a single activity stream item.
    31623161 *
    3163  * @since BuddyPress (2.1.0)
     3162 * @since 2.1.0
    31643163 *
    31653164 * @uses bp_get_activity_delete_link()
     
    31713170         * Return the URL to delete a single activity item.
    31723171         *
    3173          * @since BuddyPress (2.1.0)
     3172         * @since 2.1.0
    31743173         *
    31753174         * @global object $activities_template {@link BP_Activity_Template}
     
    32013200                 * Filters the activity delete URL.
    32023201                 *
    3203                  * @since BuddyPress (2.1.0)
     3202                 * @since 2.1.0
    32043203                 *
    32053204                 * @param string $url Activity delete URL.
     
    32113210 * Output the activity latest update link.
    32123211 *
    3213  * @since BuddyPress (1.2.0)
     3212 * @since 1.2.0
    32143213 *
    32153214 * @see bp_get_activity_latest_update() for description of parameters.
     
    32253224         * Return the activity latest update link.
    32263225         *
    3227          * @since BuddyPress (1.2.0)
     3226         * @since 1.2.0
    32283227         *
    32293228         * @uses bp_is_user_inactive()
     
    32583257                 * Filters the latest update excerpt.
    32593258                 *
    3260                  * @since BuddyPress (1.2.10)
     3259                 * @since 1.2.10
    32613260                 *
    32623261                 * @param string $value The excerpt for the latest update.
     
    32743273                 * Filters the latest update excerpt with view link appended to the end.
    32753274                 *
    3276                  * @since BuddyPress (1.2.0)
     3275                 * @since 1.2.0
    32773276                 *
    32783277                 * @param string $latest_update The latest update with "view" link appended to it.
     
    32843283 * Output the activity filter links.
    32853284 *
    3286  * @since BuddyPress (1.1.0)
     3285 * @since 1.1.0
    32873286 *
    32883287 * @see bp_get_activity_filter_links() for description of parameters.
     
    32983297         * Return the activity filter links.
    32993298         *
    3300          * @since BuddyPress (1.1.0)
     3299         * @since 1.1.0
    33013300         *
    33023301         * @uses wp_parse_args()
     
    33703369                         * Filters the activity filter link URL for the current activity component.
    33713370                         *
    3372                          * @since BuddyPress (1.1.0)
     3371                         * @since 1.1.0
    33733372                         *
    33743373                         * @param string $link      The URL for the current component.
     
    33893388                 * Filters all of the constructed filter links.
    33903389                 *
    3391                  * @since BuddyPress (1.1.0)
     3390                 * @since 1.1.0
    33923391                 *
    33933392                 * @param string $value All of the links to be displayed to the user.
     
    33993398 * Determine if a comment can be made on an activity item.
    34003399 *
    3401  * @since BuddyPress (1.2.0)
     3400 * @since 1.2.0
    34023401 *
    34033402 * @global object $activities_template {@link BP_Activity_Template}
     
    34473446         * Filters whether a comment can be made on an activity item.
    34483447         *
    3449          * @since BuddyPress (1.5.0)
     3448         * @since 1.5.0
    34503449         *
    34513450         * @param bool   $can_comment     Status on if activity can be commented on.
     
    34583457 * Determine whether a comment can be made on an activity reply item.
    34593458 *
    3460  * @since BuddyPress (1.5.0)
     3459 * @since 1.5.0
    34613460 *
    34623461 * @param  bool|object $comment     Activity comment.
     
    34943493         * Filters whether a comment can be made on an activity reply item.
    34953494         *
    3496          * @since BuddyPress (1.5.0)
     3495         * @since 1.5.0
    34973496         *
    34983497         * @param bool   $can_comment Status on if activity reply can be commented on.
     
    35073506 * Defaults to true, but can be modified by plugins.
    35083507 *
    3509  * @since BuddyPress (1.5.0)
     3508 * @since 1.5.0
    35103509 *
    35113510 * @uses apply_filters() To call the 'bp_activity_can_favorite' hook.
     
    35183517         * Filters whether or not users can favorite activity items.
    35193518         *
    3520          * @since BuddyPress (1.5.0)
     3519         * @since 1.5.0
    35213520         *
    35223521         * @param bool $value Whether or not favoriting is enabled.
     
    35283527 * Output the total favorite count for a specified user.
    35293528 *
    3530  * @since BuddyPress (1.2.0)
     3529 * @since 1.2.0
    35313530 *
    35323531 * @see bp_get_total_favorite_count_for_user() for description of parameters.
     
    35423541         * Return the total favorite count for a specified user.
    35433542         *
    3544          * @since BuddyPress (1.2.0)
     3543         * @since 1.2.0
    35453544         *
    35463545         * @uses bp_activity_total_favorites_for_user()
     
    35693568                 * Filters the total favorite count for a user.
    35703569                 *
    3571                  * @since BuddyPress (1.2.0)
     3570                 * @since 1.2.0
    35723571                 *
    35733572                 * @param int|bool $retval Total favorite count for a user. False on no favorites.
     
    35803579 * Output the total mention count for a specified user.
    35813580 *
    3582  * @since BuddyPress (1.2.0)
     3581 * @since 1.2.0
    35833582 *
    35843583 * @see bp_get_total_mention_count_for_user() for description of parameters.
     
    35943593         * Return the total mention count for a specified user.
    35953594         *
    3596          * @since BuddyPress (1.2.0)
     3595         * @since 1.2.0
    35973596         *
    35983597         * @uses bp_get_user_meta()
     
    36183617                 * Filters the total mention count for a user.
    36193618                 *
    3620                  * @since BuddyPress (1.2.0)
     3619                 * @since 1.2.0
    36213620                 *
    36223621                 * @param int|bool $retval Total mention count for a user. False on no mentions.
     
    36283627 * Output the public message link for displayed user.
    36293628 *
    3630  * @since BuddyPress (1.2.0)
     3629 * @since 1.2.0
    36313630 *
    36323631 * @uses bp_get_send_public_message_link()
     
    36393638         * Return the public message link for the displayed user.
    36403639         *
    3641          * @since BuddyPress (1.2.0)
     3640         * @since 1.2.0
    36423641         *
    36433642         * @uses is_user_logged_in()
     
    36643663                 * Filters the public message link for the displayed user.
    36653664                 *
    3666                  * @since BuddyPress (1.2.0)
     3665                 * @since 1.2.0
    36673666                 *
    36683667                 * @param string $retval The URL for the public message link.
     
    36743673 * Recurse through all activity comments and return the activity comment IDs.
    36753674 *
    3676  * @since BuddyPress (2.0.0)
     3675 * @since 2.0.0
    36773676 *
    36783677 * @param array $activity Array of activities generated from {@link bp_activity_get()}.
     
    37023701 * Output the mentioned user display name.
    37033702 *
    3704  * @since BuddyPress (1.2.0)
     3703 * @since 1.2.0
    37053704 *
    37063705 * @see bp_get_mentioned_user_display_name() for description of parameters.
     
    37163715         * Returns the mentioned user display name.
    37173716         *
    3718          * @since BuddyPress (1.2.0)
     3717         * @since 1.2.0
    37193718         *
    37203719         * @uses bp_core_get_user_displayname()
     
    37383737                 * Filters the mentioned user display name.
    37393738                 *
    3740                  * @since BuddyPress (1.2.0)
     3739                 * @since 1.2.0
    37413740                 *
    37423741                 * @param string     $name                Display name for the mentioned user.
     
    37493748 * Output button for sending a public message (an @-mention).
    37503749 *
    3751  * @since BuddyPress (1.2.0)
     3750 * @since 1.2.0
    37523751 *
    37533752 * @see bp_get_send_public_message_button() for description of parameters.
     
    37633762         * Return button for sending a public message (an @-mention).
    37643763         *
    3765          * @since BuddyPress (1.2.0)
     3764         * @since 1.2.0
    37663765         *
    37673766         * @uses bp_get_send_public_message_link()
     
    38043803                 * Filters the public message button HTML.
    38053804                 *
    3806                  * @since BuddyPress (1.2.10)
     3805                 * @since 1.2.10
    38073806                 *
    38083807                 * @param array $r Array of arguments for the public message button HTML.
     
    38143813 * Output the activity post form action.
    38153814 *
    3816  * @since BuddyPress (1.2.0)
     3815 * @since 1.2.0
    38173816 *
    38183817 * @uses bp_get_activity_post_form_action()
     
    38253824         * Return the activity post form action.
    38263825         *
    3827          * @since BuddyPress (1.2.0)
     3826         * @since 1.2.0
    38283827         *
    38293828         * @uses home_url()
     
    38383837                 * Filters the action url used for the activity post form.
    38393838                 *
    3840                  * @since BuddyPress (1.2.0)
     3839                 * @since 1.2.0
    38413840                 *
    38423841                 * @param string $value URL to be used for the activity post form.
     
    38533852 * <ul> or <ol> wrapper markup.
    38543853 *
    3855  * @since BuddyPress (1.7.0)
     3854 * @since 1.7.0
    38563855 *
    38573856 * @see bp_core_fetch_avatar() for a description of arguments.
     
    39083907         * Filters the list of linked avatars for users who have commented on the current activity item.
    39093908         *
    3910          * @since BuddyPress (1.7.0)
     3909         * @since 1.7.0
    39113910         *
    39123911         * @param string $retval HTML markup for the list of avatars.
     
    39203919 * Return the IDs of every user who's left a comment on the current activity item.
    39213920 *
    3922  * @since BuddyPress (1.7.0)
     3921 * @since 1.7.0
    39233922 *
    39243923 * @return bool|array An array of IDs, or false if none are found.
     
    39343933         * Filters the list of user IDs for the current activity item.
    39353934         *
    3936          * @since BuddyPress (1.7.0)
     3935         * @since 1.7.0
    39373936         *
    39383937         * @param array $value Array of unique user IDs for the current activity item.
     
    39443943         * Recurse through all activity comments and collect the IDs of the users who wrote them.
    39453944         *
    3946          * @since BuddyPress (1.7.0)
     3945         * @since 1.7.0
    39473946         *
    39483947         * @param array $comments Array of {@link BP_Activity_Activity} items.
     
    39783977                 * Filters the list of user IDs for the current activity comment item.
    39793978                 *
    3980                  * @since BuddyPress (2.1.0)
     3979                 * @since 2.1.0
    39813980                 *
    39823981                 * @param array $user_ids Array of user IDs for the current activity comment item.
     
    39893988 * Output the mentionname for the displayed user.
    39903989 *
    3991  * @since BuddyPress (1.9.0)
     3990 * @since 1.9.0
    39923991 */
    39933992function bp_displayed_user_mentionname() {
     
    39973996         * Get the mentionname for the displayed user.
    39983997         *
    3999          * @since BuddyPress (1.9.0)
     3998         * @since 1.9.0
    40003999         *
    40014000         * @return string Mentionname for the displayed user, if available.
     
    40064005                 * Filters the mentionname for the displayed user.
    40074006                 *
    4008                  * @since BuddyPress (1.9.0)
     4007                 * @since 1.9.0
    40094008                 *
    40104009                 * @param string $value The mentionanme for the displayed user.
     
    40164015 * Echo a list of all registered activity types for use in dropdowns or checkbox lists.
    40174016 *
    4018  * @since BuddyPress (1.7.0)
     4017 * @since 1.7.0
    40194018 *
    40204019 * @param string       $output Optional. Either 'select' or 'checkbox'. Default: 'select'.
     
    40604059                 * Two default hooks are bp_activity_types_list_select and bp_activity_types_list_checkbox.
    40614060                 *
    4062                  * @since BuddyPress (1.7.0)
     4061                 * @since 1.7.0
    40634062                 *
    40644063                 * @param array  $args        Array of arguments passed into function.
     
    40814080 * Output the sitewide activity feed link.
    40824081 *
    4083  * @since BuddyPress (1.0.0)
     4082 * @since 1.0.0
    40844083 *
    40854084 * @uses bp_get_sitewide_activity_feed_link()
     
    40924091         * Returns the sitewide activity feed link.
    40934092         *
    4094          * @since BuddyPress (1.0.0)
     4093         * @since 1.0.0
    40954094         *
    40964095         * @uses home_url()
     
    41054104                 * Filters the sidewide activity feed link.
    41064105                 *
    4107                  * @since BuddyPress (1.0.0)
     4106                 * @since 1.0.0
    41084107                 *
    41094108                 * @param string $value The feed link for sitewide activity.
     
    41154114 * Output the member activity feed link.
    41164115 *
    4117  * @since BuddyPress (1.2.0)
     4116 * @since 1.2.0
    41184117 *
    41194118 * @uses bp_get_member_activity_feed_link()
     
    41264125 * Output the member activity feed link.
    41274126 *
    4128  * @since BuddyPress (1.0.0)
    4129  * @deprecated BuddyPress (1.2.0)
     4127 * @since 1.0.0
     4128 * @deprecated 1.2.0
    41304129 *
    41314130 * @todo properly deprecate in favor of bp_member_activity_feed_link().
     
    41384137         * Return the member activity feed link.
    41394138         *
    4140          * @since BuddyPress (1.2.0)
     4139         * @since 1.2.0
    41414140         *
    41424141         * @uses bp_is_profile_component()
     
    41814180                 * Filters the member activity feed link.
    41824181                 *
    4183                  * @since BuddyPress (1.0.0)
     4182                 * @since 1.0.0
    41844183                 *
    41854184                 * @param string $link URL for the member activity feed.
     
    41914190         * Return the member activity feed link.
    41924191         *
    4193          * @since BuddyPress (1.0.0)
    4194          * @deprecated BuddyPress (1.2.0)
     4192         * @since 1.0.0
     4193         * @deprecated 1.2.0
    41954194         *
    41964195         * @todo properly deprecate in favor of bp_get_member_activity_feed_link().
     
    42084207 * Outputs the activity feed item guid.
    42094208 *
    4210  * @since BuddyPress (1.0.0)
     4209 * @since 1.0.0
    42114210 *
    42124211 * @uses bp_activity_feed_item_guid()
     
    42194218         * Returns the activity feed item guid.
    42204219         *
    4221          * @since BuddyPress (1.2.0)
     4220         * @since 1.2.0
    42224221         *
    42234222         * @global object $activities_template {@link BP_Activity_Template}
     
    42324231                 * Filters the activity feed item guid.
    42334232                 *
    4234                  * @since BuddyPress (1.1.3)
     4233                 * @since 1.1.3
    42354234                 *
    42364235                 * @param string $value Calculated md5 value for the activity feed item.
     
    42424241 * Output the activity feed item title.
    42434242 *
    4244  * @since BuddyPress (1.0.0)
     4243 * @since 1.0.0
    42454244 *
    42464245 * @uses bp_get_activity_feed_item_title()
     
    42534252         * Return the activity feed item title.
    42544253         *
    4255          * @since BuddyPress (1.0.0)
     4254         * @since 1.0.0
    42564255         *
    42574256         * @global object $activities_template {@link BP_Activity_Template}
     
    42864285                 * Filters the activity feed item title.
    42874286                 *
    4288                  * @since BuddyPress (1.0.0)
     4287                 * @since 1.0.0
    42894288                 *
    42904289                 * @param string $title The title for the activity feed item.
     
    42964295 * Output the activity feed item link.
    42974296 *
    4298  * @since BuddyPress (1.0.0)
     4297 * @since 1.0.0
    42994298 *
    43004299 * @uses bp_get_activity_feed_item_link()
     
    43074306         * Return the activity feed item link.
    43084307         *
    4309          * @since BuddyPress (1.0.0)
     4308         * @since 1.0.0
    43104309         *
    43114310         * @global object $activities_template {@link BP_Activity_Template}
     
    43244323                 * Filters the activity feed item link.
    43254324                 *
    4326                  * @since BuddyPress (1.0.0)
     4325                 * @since 1.0.0
    43274326                 *
    43284327                 * @param string $retval The URL for the activity feed item.
     
    43344333 * Output the activity feed item date.
    43354334 *
    4336  * @since BuddyPress (1.0.0)
     4335 * @since 1.0.0
    43374336 *
    43384337 * @uses bp_get_activity_feed_item_date()
     
    43454344         * Return the activity feed item date.
    43464345         *
    4347          * @since BuddyPress (1.0.0)
     4346         * @since 1.0.0
    43484347         *
    43494348         * @global object $activities_template {@link BP_Activity_Template}
     
    43624361                 * Filters the activity feed item date.
    43634362                 *
    4364                  * @since BuddyPress (1.0.0)
     4363                 * @since 1.0.0
    43654364                 *
    43664365                 * @param string $retval The date for the activity feed item.
     
    43724371 * Output the activity feed item description.
    43734372 *
    4374  * @since BuddyPress (1.0.0)
     4373 * @since 1.0.0
    43754374 *
    43764375 * @uses bp_get_activity_feed_item_description()
     
    43834382         * Return the activity feed item description.
    43844383         *
    4385          * @since BuddyPress (1.0.0)
     4384         * @since 1.0.0
    43864385         *
    43874386         * @global object $activities_template {@link BP_Activity_Template}
     
    44084407                 * Filters the activity feed item description.
    44094408                 *
    4410                  * @since BuddyPress (1.0.0)
     4409                 * @since 1.0.0
    44114410                 *
    44124411                 * @param string $content The description for the activity feed item.
     
    44184417 * Template tag so we can hook activity feed to <head>.
    44194418 *
    4420  * @since BuddyPress (1.5.0)
     4419 * @since 1.5.0
    44214420 *
    44224421 * @uses bloginfo()
     
    44354434 * Display available filters depending on the scope.
    44364435 *
    4437  * @since BuddyPress (2.1.0)
     4436 * @since 2.1.0
    44384437 *
    44394438 * @param string $context The current context. 'activity', 'member',
     
    44474446         * Get available filters depending on the scope.
    44484447         *
    4449          * @since BuddyPress (2.1.0)
     4448         * @since 2.1.0
    44504449         *
    44514450         * @param string $context The current context. 'activity', 'member',
     
    44994498                 * Filters the options available in the activity filter dropdown.
    45004499                 *
    4501                  * @since BuddyPress (2.2.0)
     4500                 * @since 2.2.0
    45024501                 *
    45034502                 * @param array  $filters Array of filter options for the given context, in the following format: $option_value => $option_name.
     
    45184517                 * Filters the HTML markup result for the activity filter dropdown.
    45194518                 *
    4520                  * @since BuddyPress (2.1.0)
     4519                 * @since 2.1.0
    45214520                 *
    45224521                 * @param string $output  HTML output for the activity filter dropdown.
  • trunk/src/bp-activity/classes/class-bp-activity-activity.php

    r9961 r10077  
    1616 * static methods for querying activities.
    1717 *
    18  * @since BuddyPress (1.0.0)
     18 * @since 1.0.0
    1919 */
    2020class BP_Activity_Activity {
     
    210210                 * Please use this hook to filter the properties above. Each part will be passed in.
    211211                 *
    212                  * @since BuddyPress (1.0.0)
     212                 * @since 1.0.0
    213213                 *
    214214                 * @param BP_Activity_Activity $this Current instance of the activity item being saved. Passed by reference.
     
    247247                 * Fires after an activity item has been saved to the database.
    248248                 *
    249                  * @since BuddyPress (1.0.0)
     249                 * @since 1.0.0
    250250                 *
    251251                 * @param BP_Activity_Activity $this Current instance of activity item being saved. Passed by reference.
     
    457457                 * Filters the MySQL WHERE conditions for the Activity items get method.
    458458                 *
    459                  * @since BuddyPress (1.9.0)
     459                 * @since 1.9.0
    460460                 *
    461461                 * @param array  $where_conditions Current conditions for MySQL WHERE statement.
     
    473473                 * Filters the preferred order of indexes for activity item.
    474474                 *
    475                  * @since BuddyPress (1.6.0)
     475                 * @since 1.6.0
    476476                 *
    477477                 * @param array Array of indexes in preferred order.
     
    507507                 * It is not recommended to use the legacy structure, but allowed to if needed.
    508508                 *
    509                  * @since BuddyPress (2.0.0)
     509                 * @since 2.0.0
    510510                 *
    511511                 * @param bool                 $value Whether to use legacy structure or not.
     
    530530                                 * Filters the legacy MySQL query statement so plugins can alter before results are fetched.
    531531                                 *
    532                                  * @since BuddyPress (1.5.0)
     532                                 * @since 1.5.0
    533533                                 *
    534534                                 * @param string $value      Concatenated MySQL statement pieces to be query results with for legacy query.
     
    554554                         * Filters the paged activities MySQL statement.
    555555                         *
    556                          * @since BuddyPress (2.0.0)
     556                         * @since 2.0.0
    557557                         *
    558558                         * @param string $activity_ids_sql MySQL statement used to query for Activity IDs.
     
    605605                         * Filters the total activities MySQL statement.
    606606                         *
    607                          * @since BuddyPress (1.5.0)
     607                         * @since 1.5.0
    608608                         *
    609609                         * @param string $value     MySQL statement used to query for total activities.
     
    629629         * Convert activity IDs to activity objects, as expected in template loop.
    630630         *
    631          * @since BuddyPress (2.0.0)
     631         * @since 2.0.0
    632632         *
    633633         * @param array $activity_ids Array of activity IDs.
     
    694694         * Append xProfile fullnames to an activity array.
    695695         *
    696          * @since BuddyPress (2.0.0)
     696         * @since 2.0.0
    697697         *
    698698         * @param array $activities Activities array.
     
    735735         * their own caches at the beginning of an activity loop.
    736736         *
    737          * @since BuddyPress (2.0.0)
     737         * @since 2.0.0
    738738         *
    739739         * @param array $activities Array of activities.
     
    746746                 * Filters inside prefetch_object_data method to aid in pre-fetching object data associated with activity item.
    747747                 *
    748                  * @since BuddyPress (2.0.0)
     748                 * @since 2.0.0
    749749                 *
    750750                 * @param array $activities Array of activities.
     
    761761         * be left in place.
    762762         *
    763          * @since BuddyPress (2.0.0)
     763         * @since 2.0.0
    764764         *
    765765         * @param array $activities Array of activities.
     
    789789         * AND keyword from the 'where' clause).
    790790         *
    791          * @since BuddyPress (1.8.0)
     791         * @since 1.8.0
    792792         *
    793793         * @param array $meta_query An array of meta_query filters. See the
     
    830830         * keyword from the query).
    831831         *
    832          * @since BuddyPress (2.1.0)
     832         * @since 2.1.0
    833833         *
    834834         * @param array $date_query An array of date_query parameters. See the
     
    857857         * Can handle multiple scopes.
    858858         *
    859          * @since BuddyPress (2.2.0)
     859         * @since 2.2.0
    860860         *
    861861         * @param  mixed $scope  The activity scope. Accepts string or array of scopes.
     
    906906                         *   - bp_friends_filter_activity_scope() - used for 'friends' scope
    907907                         *
    908                          * @since BuddyPress (2.2.0)
     908                         * @since 2.2.0
    909909                         *
    910910                         *  @param array {
     
    959959         * As of 1.5.x, use BP_Activity_Activity::get() with an 'in' parameter instead.
    960960         *
    961          * @since BuddyPress (1.2.0)
     961         * @since 1.2.0
    962962         *
    963963         * @deprecated 1.5
     
    10471047         * Otherwise use the filters.
    10481048         *
    1049          * @since BuddyPress (1.2.0)
     1049         * @since 1.2.0
    10501050         *
    10511051         * @param array $args {
     
    11551155                 * Action to allow intercepting activity items to be deleted.
    11561156                 *
    1157                  * @since BuddyPress (2.3.0)
     1157                 * @since 2.3.0
    11581158                 *
    11591159                 * @param array $activities Array of activities.
     
    11731173                 * Action to allow intercepting activity items just deleted.
    11741174                 *
    1175                  * @since BuddyPress (2.3.0)
     1175                 * @since 2.3.0
    11761176                 *
    11771177                 * @param array $activities Array of activities.
     
    12221222         * use it going forward, and use BP_Activity_Activity::delete() instead.
    12231223         *
    1224          * @since BuddyPress (1.2.0)
    1225          * @deprecated BuddyPress (2.3.0)
     1224         * @since 1.2.0
     1225         * @deprecated 2.3.0
    12261226         *
    12271227         * @param array $activity_ids Activity IDs whose comments should be deleted.
     
    12531253         * Delete the meta entries associated with a set of activity items.
    12541254         *
    1255          * @since BuddyPress (1.2.0)
     1255         * @since 1.2.0
    12561256         *
    12571257         * @param array $activity_ids Activity IDs whose meta should be deleted.
     
    12721272         * Append activity comments to their associated activity items.
    12731273         *
    1274          * @since BuddyPress (1.2.0)
     1274         * @since 1.2.0
    12751275         *
    12761276         * @global wpdb $wpdb WordPress database object.
     
    13031303         * Get activity comments that are associated with a specific activity ID.
    13041304         *
    1305          * @since BuddyPress (1.2.0)
     1305         * @since 1.2.0
    13061306         *
    13071307         * @global wpdb $wpdb WordPress database object.
     
    13601360                         * Filters if BuddyPress should use the legacy activity query.
    13611361                         *
    1362                          * @since BuddyPress (2.0.0)
     1362                         * @since 2.0.0
    13631363                         *
    13641364                         * @param bool                 $value     Whether or not to use the legacy query.
     
    13711371                                 * Filters the MySQL prepared statement for the legacy activity query.
    13721372                                 *
    1373                                  * @since BuddyPress (1.5.0)
     1373                                 * @since 1.5.0
    13741374                                 *
    13751375                                 * @param string $value       Prepared statement for the activity query.
     
    14631463         * Rebuild nested comment tree under an activity or activity comment.
    14641464         *
    1465          * @since BuddyPress (1.2.0)
     1465         * @since 1.2.0
    14661466         *
    14671467         * @global wpdb $wpdb WordPress database object.
     
    15031503         * Get child comments of an activity or activity comment.
    15041504         *
    1505          * @since BuddyPress (1.2.0)
     1505         * @since 1.2.0
    15061506         *
    15071507         * @global wpdb $wpdb WordPress database object.
     
    15691569         * Create SQL IN clause for filter queries.
    15701570         *
    1571          * @since BuddyPress (1.5.0)
     1571         * @since 1.5.0
    15721572         *
    15731573         * @see BP_Activity_Activity::get_filter_sql()
     
    16071607         * Create filter SQL clauses.
    16081608         *
    1609          * @since BuddyPress (1.5.0)
     1609         * @since 1.5.0
    16101610         *
    16111611         * @param array $filter_array {
     
    16871687         * Get the date/time of last recorded activity.
    16881688         *
    1689          * @since BuddyPress (1.2.0)
     1689         * @since 1.2.0
    16901690         *
    16911691         * @return string ISO timestamp.
     
    17021702         * Get favorite count for a given user.
    17031703         *
    1704          * @since BuddyPress (1.2.0)
     1704         * @since 1.2.0
    17051705         *
    17061706         * @param int $user_id The ID of the user whose favorites you're counting.
     
    17621762         * Subject to removal once WordPress makes PHP 5.3.0 the minimum requirement.
    17631763         *
    1764          * @since BuddyPress (2.2.0)
     1764         * @since 2.2.0
    17651765         *
    17661766         * @see http://php.net/manual/en/function.array-replace-recursive.php#109390
  • trunk/src/bp-activity/classes/class-bp-activity-feed.php

    r9834 r10077  
    44 *
    55 * @package BuddyPress
    6  * @subpackage Activity
     6 * @subpackage ActivityFeeds
    77 */
    88
     
    3131 *   @type array  $activity_args    Optional. Arguments passed to {@link bp_has_activities()}
    3232 * }
    33  * @since BuddyPress (1.8.0)
     33 * @since 1.8.0
    3434 */
    3535class BP_Activity_Feed {
     
    7474                 * Filters if BuddyPress should consider feeds enabled. If disabled, it will return early.
    7575                 *
    76                  * @since BuddyPress (1.8.0)
     76                 * @since 1.8.0
    7777                 *
    7878                 * @param bool true Default true aka feeds are enabled.
     
    126126                 * Fires before the feed is setup so plugins can modify.
    127127                 *
    128                  * @since BuddyPress (1.8.0)
     128                 * @since 1.8.0
    129129                 *
    130130                 * @param BP_Activity_Feed $this Current instance of activity feed. Passed by reference.
     
    144144                 * Fires after the feed is setup so plugins can modify.
    145145                 *
    146                  * @since BuddyPress (1.8.0)
     146                 * @since 1.8.0
    147147                 *
    148148                 * @param BP_Activity_Feed $this Current instance of activity feed. Passed by reference.
     
    210210                 * This hook was originally separated out for individual components but has since been abstracted into the BP_Activity_Feed class.
    211211                 *
    212                  * @since BuddyPress (1.0.0)
     212                 * @since 1.0.0
    213213                 */
    214214                do_action( 'bp_activity_' . $this->id . '_feed' );
     
    225225                 * This hook was originally separated out for individual components but has since been abstracted into the BP_Activity_Feed class.
    226226                 *
    227                  * @since BuddyPress (1.0.0)
     227                 * @since 1.0.0
    228228                 */
    229229                do_action( 'bp_activity_' . $this->id . '_feed_head' );
     
    254254                 * This hook was originally separated out for individual components but has since been abstracted into the BP_Activity_Feed class.
    255255                 *
    256                  * @since BuddyPress (1.0.0)
     256                 * @since 1.0.0
    257257                 */
    258258                do_action( 'bp_activity_' . $id . '_feed_item' );
     
    293293         * Most of this class method is derived from {@link WP::send_headers()}.
    294294         *
    295          * @since BuddyPress (1.9.0)
     295         * @since 1.9.0
    296296         *
    297297         * @access protected
     
    388388         * Fires at the end of the opening RSS tag for feed output so plugins can add extra attributes.
    389389         *
    390          * @since BuddyPress (1.8.0)
     390         * @since 1.8.0
    391391         */
    392392        do_action( 'bp_activity_feed_rss_attributes' ); ?>
     
    409409         * Fires at the end of channel elements list in RSS feed so plugins can add extra channel elements.
    410410         *
    411          * @since BuddyPress (1.8.0)
     411         * @since 1.8.0
    412412         */
    413413        do_action( 'bp_activity_feed_channel_elements' ); ?>
     
    434434                                 * Fires at the end of the individual RSS Item list in RSS feed so plugins can add extra item elements.
    435435                                 *
    436                                  * @since BuddyPress (1.8.0)
     436                                 * @since 1.8.0
    437437                                 */
    438438                                do_action( 'bp_activity_feed_item_elements' ); ?>
  • trunk/src/bp-activity/classes/class-bp-activity-query.php

    r9834 r10077  
    44 *
    55 * @package BuddyPress
    6  * @subpackage Activity
     6 * @subpackage ActivityQuery
    77 */
    88
     
    1616 * 'filter_query' parameter.
    1717 *
    18  * @since BuddyPress (2.2.0)
     18 * @since 2.2.0
    1919 */
    2020class BP_Activity_Query extends BP_Recursive_Query {
     
    2424         * See {@see BP_Activity_Query::__construct()} for information on query arguments.
    2525         *
    26          * @since BuddyPress (2.2.0)
     26         * @since 2.2.0
    2727         * @access public
    2828         * @var array
     
    3333         * Table alias.
    3434         *
    35          * @since BuddyPress (2.2.0)
     35         * @since 2.2.0
    3636         * @access public
    3737         * @var string
     
    4444         * See the 'wp_bp_activity' DB table schema.
    4545         *
    46          * @since BuddyPress (2.2.0)
     46         * @since 2.2.0
    4747         * @access public
    4848         * @var array
     
    5656         * Constructor.
    5757         *
    58          * @since BuddyPress (2.2.0)
     58         * @since 2.2.0
    5959         *
    6060         * @param array $query {
     
    8787         * Generates WHERE SQL clause to be appended to a main query.
    8888         *
    89          * @since BuddyPress (2.2.0)
     89         * @since 2.2.0
    9090         * @access public
    9191         *
     
    112112         * Generate WHERE clauses for a first-order clause.
    113113         *
    114          * @since BuddyPress (2.2.0)
     114         * @since 2.2.0
    115115         * @access protected
    116116         *
     
    225225         * Determine whether a clause is first-order.
    226226         *
    227          * @since BuddyPress (2.2.0)
     227         * @since 2.2.0
    228228         * @access protected
    229229         *
     
    242242         * See {@link BP_Activity_Query::db_tables}.
    243243         *
    244          * @since BuddyPress (2.2.0)
     244         * @since 2.2.0
    245245         * @access public
    246246         *
Note: See TracChangeset for help on using the changeset viewer.