Skip to:
Content

BuddyPress.org


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

Standardizing our @since tags for the Activity component.

See #6576.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-activity/bp-activity-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.
Note: See TracChangeset for help on using the changeset viewer.