Skip to:
Content

BuddyPress.org

Ticket #5938: bp-activity-template-5938-1.diff

File bp-activity-template-5938-1.diff, 74.2 KB (added by tw2113, 10 years ago)
  • src/bp-activity/bp-activity-template.php

     
    1313/**
    1414 * Output the activity component slug.
    1515 *
    16  * @since BuddyPress (1.5)
     16 * @since BuddyPress (1.5.0)
    1717 *
    1818 * @uses bp_get_activity_slug()
    1919 */
     
    2323        /**
    2424         * Return the activity component slug.
    2525         *
    26          * @since BuddyPress (1.5)
     26         * @since BuddyPress (1.5.0)
    2727         *
    2828         * @uses apply_filters() To call the 'bp_get_activity_slug' hook.
    2929         *
     
    3030         * @return string The activity component slug.
    3131         */
    3232        function bp_get_activity_slug() {
     33
     34                /**
     35                 * Filters the activity component slug.
     36                 *
     37                 * @since BuddyPress (1.5.0)
     38                 *
     39                 * @param string $slug Activity component slug.
     40                 */
    3341                return apply_filters( 'bp_get_activity_slug', buddypress()->activity->slug );
    3442        }
    3543
     
    3644/**
    3745 * Output the activity component root slug.
    3846 *
    39  * @since BuddyPress (1.5)
     47 * @since BuddyPress (1.5.0)
    4048 *
    4149 * @uses bp_get_activity_root_slug()
    4250 */
     
    4654        /**
    4755         * Return the activity component root slug.
    4856         *
    49          * @since BuddyPress (1.5)
     57         * @since BuddyPress (1.5.0)
    5058         *
    5159         * @uses apply_filters() To call the 'bp_get_activity_root_slug' hook.
    5260         *
     
    5361         * @return string The activity component root slug.
    5462         */
    5563        function bp_get_activity_root_slug() {
     64
     65                /**
     66                 * Filters the activity component root slug.
     67                 *
     68                 * @since BuddyPress(1.5.0)
     69                 *
     70                 * @param string $root_slug Activity component root slug.
     71                 */
    5672                return apply_filters( 'bp_get_activity_root_slug', buddypress()->activity->root_slug );
    5773        }
    5874
     
    5975/**
    6076 * Output activity directory permalink.
    6177 *
    62  * @since BuddyPress (1.5)
     78 * @since BuddyPress (1.5.0)
    6379 *
    6480 * @uses bp_get_activity_directory_permalink()
    6581 */
     
    6985        /**
    7086         * Return activity directory permalink
    7187         *
    72          * @since BuddyPress (1.5)
     88         * @since BuddyPress (1.5.0)
    7389         *
    7490         * @uses traisingslashit()
    7591         * @uses bp_get_root_domain()
     
    7995         * @return string Activity directory permalink.
    8096         */
    8197        function bp_get_activity_directory_permalink() {
     98
     99                /**
     100                 * Filters the activity directory permalink.
     101                 *
     102                 * @since BuddyPress (1.5.0)
     103                 *
     104                 * @param string $url Permalink url for the activity directory.
     105                 */
    82106                return apply_filters( 'bp_get_activity_directory_permalink', trailingslashit( bp_get_root_domain() . '/' . bp_get_activity_root_slug() ) );
    83107        }
    84108
     
    87111 *
    88112 * This is responsible for loading a group of activity items and displaying them.
    89113 *
    90  * @since BuddyPress (1.0)
     114 * @since BuddyPress (1.0.0)
    91115 */
    92116class BP_Activity_Template {
    93117        var $current_activity = -1;
     
    340364                if ( $this->current_activity + 1 < $this->activity_count ) {
    341365                        return true;
    342366                } elseif ( $this->current_activity + 1 == $this->activity_count ) {
    343                         do_action('activity_loop_end');
     367
     368                        /**
     369                         * Fires right before the rewinding of activity posts.
     370                         *
     371                         * @since BuddyPress (1.1.0)
     372                         */
     373                        do_action( 'activity_loop_end' );
    344374                        // Do some cleaning up after the loop
    345375                        $this->rewind_activities();
    346376                }
     
    366396                if ( is_array( $this->activity ) )
    367397                        $this->activity = (object) $this->activity;
    368398
    369                 if ( $this->current_activity == 0 ) // loop has just started
     399                if ( $this->current_activity == 0 ) { // loop has just started
     400
     401                        /**
     402                         * Fires if the current activity item is the first in the activity loop.
     403                         */
    370404                        do_action('activity_loop_start');
     405                }
    371406        }
    372407}
    373408
     
    378413 * $activities_template global, enabling the use of BuddyPress templates and
    379414 * template functions to display a list of activity items.
    380415 *
    381  * @since BuddyPress (1.0)
     416 * @since BuddyPress (1.0.0)
    382417 *
    383418 * @global object $activities_template {@link BP_Activity_Template}
    384419 * @global object $bp BuddyPress global settings.
     
    657692        if ( !empty( $max ) && ( (int) $per_page > (int) $max ) )
    658693                $per_page = $max;
    659694
    660         // Support for basic filters in earlier BP versions is disabled by default. To enable, put
    661         //   add_filter( 'bp_activity_enable_afilter_support', '__return_true' );
    662         // into bp-custom.php or your theme's functions.php
     695        /**
     696         * Filters whether BuddyPress should enable afilter support.
     697         *
     698         * Support for basic filters in earlier BP versions is disabled by default.
     699         * To enable, put add_filter( 'bp_activity_enable_afilter_support', '__return_true' );
     700         * into bp-custom.php or your theme's functions.php.
     701         *
     702         * @since BuddyPress (1.6.0)
     703         *
     704         * @param bool $value If BuddyPress should enable afilter support.
     705         */
    663706        if ( isset( $_GET['afilter'] ) && apply_filters( 'bp_activity_enable_afilter_support', false ) )
    664707                $filter = array( 'object' => $_GET['afilter'] );
    665708        else if ( ! empty( $user_id ) || ! empty( $object ) || ! empty( $action ) || ! empty( $primary_id ) || ! empty( $secondary_id ) || ! empty( $offset ) || ! empty( $since ) )
     
    692735
    693736        $activities_template = new BP_Activity_Template( $template_args );
    694737
     738        /**
     739         * Filters whether or not there are activity items to display.
     740         *
     741         * @since BuddyPress (1.1.0)
     742         *
     743         * @param bool   $has_activities Whether or not there are activity items to display.
     744         * @param string $activities_template Current activities template being used.
     745         * @param array  $template_args Array of arguments passed into the BP_Activity_Template class.
     746         */
    695747        return apply_filters( 'bp_has_activities', $activities_template->has_activities(), $activities_template, $template_args );
    696748}
    697749
     
    698750/**
    699751 * Determine if there are still activities left in the loop.
    700752 *
    701  * @since BuddyPress (1.0)
     753 * @since BuddyPress (1.0.0)
    702754 *
    703755 * @global object $activities_template {@link BP_Activity_Template}
    704756 * @uses BP_Activity_Template::user_activities() {@link BP_Activity_Template::user_activities()}
     
    713765/**
    714766 * Get the current activity object in the loop.
    715767 *
    716  * @since BuddyPress (1.0)
     768 * @since BuddyPress (1.0.0)
    717769 *
    718770 * @global object $activities_template {@link BP_Activity_Template}
    719771 * @uses BP_Activity_Template::the_activity() {@link BP_Activity_Template::the_activity()}
     
    739791                $link = bp_get_requested_url();
    740792                $link = add_query_arg( $activities_template->pag_arg, $activities_template->pag_page + 1, $link );
    741793
     794                /**
     795                 * Filters the Load More link url.
     796                 *
     797                 * @since BuddyPress (2.1.0)
     798                 *
     799                 * @param string $link The Load More link url.
     800                 */
    742801                return apply_filters( 'bp_get_activity_load_more_link', $link );
    743802        }
    744803
     
    745804/**
    746805 * Output the activity pagination count.
    747806 *
    748  * @since BuddyPress (1.0)
     807 * @since BuddyPress (1.0.0)
    749808 *
    750809 * @global object $activities_template {@link BP_Activity_Template}
    751810 * @uses BP_Activity_Template::the_activity() {@link BP_Activity_Template::the_activity()}
     
    757816        /**
    758817         * Return the activity pagination count.
    759818         *
    760          * @since BuddyPress (1.2)
     819         * @since BuddyPress (1.2.0)
    761820         *
    762821         * @global object $activities_template {@link BP_Activity_Template}
    763822         * @uses bp_core_number_format()
     
    778837/**
    779838 * Output the activity pagination links.
    780839 *
    781  * @since BuddyPress (1.0)
     840 * @since BuddyPress (1.0.0)
    782841 *
    783842 * @uses bp_get_activity_pagination_links()
    784843 */
     
    789848        /**
    790849         * Return the activity pagination links.
    791850         *
    792          * @since BuddyPress (1.0)
     851         * @since BuddyPress (1.0.0)
    793852         *
    794853         * @global object $activities_template {@link BP_Activity_Template}
    795854         * @uses apply_filters() To call the 'bp_get_activity_pagination_links' hook.
     
    799858        function bp_get_activity_pagination_links() {
    800859                global $activities_template;
    801860
     861                /**
     862                 * Filters the activity pagination link output.
     863                 *
     864                 * @since BuddyPress (1.0.0)
     865                 *
     866                 * @param string $pag_links Output for the activity pagination links.
     867                 */
    802868                return apply_filters( 'bp_get_activity_pagination_links', $activities_template->pag_links );
    803869        }
    804870
     
    805871/**
    806872 * Return true when there are more activity items to be shown than currently appear.
    807873 *
    808  * @since BuddyPress (1.5)
     874 * @since BuddyPress (1.5.0)
    809875 *
    810876 * @global object $activities_template {@link BP_Activity_Template}
    811877 * @uses apply_filters() To call the 'bp_activity_has_more_items' hook.
     
    827893                $has_more_items = (int) $remaining_pages > 0;
    828894        }
    829895
     896        /**
     897         * Filters whether there are more activity items to display.
     898         *
     899         * @since BuddyPress (1.5.0)
     900         *
     901         * @param bool $has_more_items Whether or not there are more activity items to display.
     902         */
    830903        return apply_filters( 'bp_activity_has_more_items', $has_more_items );
    831904}
    832905
     
    833906/**
    834907 * Output the activity count.
    835908 *
    836  * @since BuddyPress (1.2)
     909 * @since BuddyPress (1.2.0)
    837910 *
    838911 * @uses bp_get_activity_count()
    839912 */
     
    844917        /**
    845918         * Return the activity count.
    846919         *
    847          * @since BuddyPress (1.2)
     920         * @since BuddyPress (1.2.0)
    848921         *
    849922         * @global object $activities_template {@link BP_Activity_Template}
    850923         * @uses apply_filters() To call the 'bp_get_activity_count' hook.
     
    854927        function bp_get_activity_count() {
    855928                global $activities_template;
    856929
     930                /**
     931                 * Filters the activity count for the activity template.
     932                 *
     933                 * @since BuddyPress (1.2.0)
     934                 *
     935                 * @param int $activity_count The count for total activity.
     936                 */
    857937                return apply_filters( 'bp_get_activity_count', (int) $activities_template->activity_count );
    858938        }
    859939
     
    860940/**
    861941 * Output the number of activities per page.
    862942 *
    863  * @since BuddyPress (1.2)
     943 * @since BuddyPress (1.2.0)
    864944 *
    865945 * @uses bp_get_activity_per_page()
    866946 */
     
    871951        /**
    872952         * Return the number of activities per page.
    873953         *
    874          * @since BuddyPress (1.2)
     954         * @since BuddyPress (1.2.0)
    875955         *
    876956         * @global object $activities_template {@link BP_Activity_Template}
    877957         * @uses apply_filters() To call the 'bp_get_activity_per_page' hook.
     
    881961        function bp_get_activity_per_page() {
    882962                global $activities_template;
    883963
     964                /**
     965                 * Filters the activity posts per page value.
     966                 *
     967                 * @since BuddyPress (1.2.0)
     968                 *
     969                 * @param int $pag_num How many post should be displayed for pagination.
     970                 */
    884971                return apply_filters( 'bp_get_activity_per_page', (int) $activities_template->pag_num );
    885972        }
    886973
     
    887974/**
    888975 * Output the activities title.
    889976 *
    890  * @since BuddyPress (1.0)
     977 * @since BuddyPress (1.0.0)
    891978 *
    892979 * @uses bp_get_activities_title()
    893980 * @todo Deprecate.
     
    899986        /**
    900987         * Return the activities title.
    901988         *
    902          * @since BuddyPress (1.0)
     989         * @since BuddyPress (1.0.0)
    903990         *
    904991         * @global string $bp_activity_title
    905992         * @uses apply_filters() To call the 'bp_get_activities_title' hook.
    906993         * @todo Deprecate.
    907994         *
    908          * @return int The activities title.
     995         * @return string The activities title.
    909996         */
    910997        function bp_get_activities_title() {
    911998                global $bp_activity_title;
    912999
     1000                /**
     1001                 * Filters the activities title for the activity template.
     1002                 *
     1003                 * @since BuddyPress (1.0.0)
     1004                 *
     1005                 * @param string $bp_activity_title The title to be displayed.
     1006                 */
    9131007                return apply_filters( 'bp_get_activities_title', $bp_activity_title );
    9141008        }
    9151009
     
    9161010/**
    9171011 * {@internal Missing Description}
    9181012 *
    919  * @since BuddyPress (1.0)
     1013 * @since BuddyPress (1.0.0)
    9201014 *
    9211015 * @uses bp_get_activities_no_activity()
    9221016 * @todo Deprecate.
     
    9281022        /**
    9291023         * {@internal Missing Description}
    9301024         *
    931          * @since BuddyPress (1.0)
     1025         * @since BuddyPress (1.0.0)
    9321026         *
    9331027         * @global string $bp_activity_no_activity
    9341028         * @uses apply_filters() To call the 'bp_get_activities_no_activity' hook
     
    9391033        function bp_get_activities_no_activity() {
    9401034                global $bp_activity_no_activity;
    9411035
     1036                /**
     1037                 * Filters the text used when there is no activity to display.
     1038                 *
     1039                 * @since BuddyPress (1.0.0)
     1040                 *
     1041                 * @param string $bp_activity_no_activity Text to display for no activity.
     1042                 */
    9421043                return apply_filters( 'bp_get_activities_no_activity', $bp_activity_no_activity );
    9431044        }
    9441045
     
    9451046/**
    9461047 * Output the activity ID.
    9471048 *
    948  * @since BuddyPress (1.2)
     1049 * @since BuddyPress (1.2.0)
    9491050 *
    9501051 * @uses bp_get_activity_id()
    9511052 */
     
    9561057        /**
    9571058         * Return the activity ID.
    9581059         *
    959          * @since BuddyPress (1.2)
     1060         * @since BuddyPress (1.2.0)
    9601061         *
    9611062         * @global object $activities_template {@link BP_Activity_Template}
    9621063         * @uses apply_filters() To call the 'bp_get_activity_id' hook.
     
    9651066         */
    9661067        function bp_get_activity_id() {
    9671068                global $activities_template;
     1069
     1070                /**
     1071                 * Filters the activity ID being displayed.
     1072                 *
     1073                 * @since BuddyPress (1.2.0)
     1074                 *
     1075                 * @param int $id The activity ID.
     1076                 */
    9681077                return apply_filters( 'bp_get_activity_id', $activities_template->activity->id );
    9691078        }
    9701079
     
    9711080/**
    9721081 * Output the activity item ID.
    9731082 *
    974  * @since BuddyPress (1.2)
     1083 * @since BuddyPress (1.2.0)
    9751084 *
    9761085 * @uses bp_get_activity_item_id()
    9771086 */
     
    9821091        /**
    9831092         * Return the activity item ID.
    9841093         *
    985          * @since BuddyPress (1.2)
     1094         * @since BuddyPress (1.2.0)
    9861095         *
    9871096         * @global object $activities_template {@link BP_Activity_Template}
    9881097         * @uses apply_filters() To call the 'bp_get_activity_item_id' hook.
     
    9911100         */
    9921101        function bp_get_activity_item_id() {
    9931102                global $activities_template;
     1103
     1104                /**
     1105                 * Filters the activity item ID being displayed.
     1106                 *
     1107                 * @since BuddyPress (1.2.0)
     1108                 *
     1109                 * @param int $item_id The activity item ID.
     1110                 */
    9941111                return apply_filters( 'bp_get_activity_item_id', $activities_template->activity->item_id );
    9951112        }
    9961113
     
    9971114/**
    9981115 * Output the activity secondary item ID.
    9991116 *
    1000  * @since BuddyPress (1.2)
     1117 * @since BuddyPress (1.2.0)
    10011118 *
    10021119 * @uses bp_get_activity_secondary_item_id()
    10031120 */
     
    10081125        /**
    10091126         * Return the activity secondary item ID.
    10101127         *
    1011          * @since BuddyPress (1.2)
     1128         * @since BuddyPress (1.2.0)
    10121129         *
    10131130         * @global object $activities_template {@link BP_Activity_Template}
    10141131         * @uses apply_filters() To call the 'bp_get_activity_secondary_item_id' hook.
     
    10171134         */
    10181135        function bp_get_activity_secondary_item_id() {
    10191136                global $activities_template;
     1137
     1138                /**
     1139                 * Filters the activity secondary item ID being displayed.
     1140                 *
     1141                 * @since BuddyPress (1.2.0)
     1142                 *
     1143                 * @param int $secondary_item_id The activity secondary item ID.
     1144                 */
    10201145                return apply_filters( 'bp_get_activity_secondary_item_id', $activities_template->activity->secondary_item_id );
    10211146        }
    10221147
     
    10231148/**
    10241149 * Output the date the activity was recorded.
    10251150 *
    1026  * @since BuddyPress (1.2)
     1151 * @since BuddyPress (1.2.0)
    10271152 *
    10281153 * @uses bp_get_activity_date_recorded()
    10291154 */
     
    10341159        /**
    10351160         * Return the date the activity was recorded.
    10361161         *
    1037          * @since BuddyPress (1.2)
     1162         * @since BuddyPress (1.2.0)
    10381163         *
    10391164         * @global object $activities_template {@link BP_Activity_Template}
    10401165         * @uses apply_filters() To call the 'bp_get_activity_date_recorded' hook.
     
    10431168         */
    10441169        function bp_get_activity_date_recorded() {
    10451170                global $activities_template;
     1171
     1172                /**
     1173                 * Filters the date the activity was recorded.
     1174                 *
     1175                 * @since BuddyPress (1.2.0)
     1176                 *
     1177                 * @param int $date_recorded The activity's date.
     1178                 */
    10461179                return apply_filters( 'bp_get_activity_date_recorded', $activities_template->activity->date_recorded );
    10471180        }
    10481181
     
    10741207                        ? $activities_template->activity->display_name
    10751208                        : '';
    10761209
     1210                /**
     1211                 * Filters the display name of the member who posted the activity.
     1212                 *
     1213                 * @since BuddyPress (2.1.0)
     1214                 *
     1215                 * @param int $retval Display name for the member who posted.
     1216                 */
    10771217                return apply_filters( 'bp_get_activity_member_display_name', $retval );
    10781218        }
    10791219
     
    10801220/**
    10811221 * Output the activity object name.
    10821222 *
    1083  * @since BuddyPress (1.2)
     1223 * @since BuddyPress (1.2.0)
    10841224 *
    10851225 * @uses bp_get_activity_object_name()
    10861226 */
     
    10911231        /**
    10921232         * Return the activity object name.
    10931233         *
    1094          * @since BuddyPress (1.2)
     1234         * @since BuddyPress (1.2.0)
    10951235         *
    10961236         * @global object $activities_template {@link BP_Activity_Template}
    10971237         * @uses apply_filters() To call the 'bp_get_activity_object_name' hook.
     
    11001240         */
    11011241        function bp_get_activity_object_name() {
    11021242                global $activities_template;
     1243
     1244                /**
     1245                 * Filters the activity object name.
     1246                 *
     1247                 * @since BuddyPress (1.2.0)
     1248                 *
     1249                 * @param string $activity_component The activity object name.
     1250                 */
    11031251                return apply_filters( 'bp_get_activity_object_name', $activities_template->activity->component );
    11041252        }
    11051253
     
    11061254/**
    11071255 * Output the activity type.
    11081256 *
    1109  * @since BuddyPress (1.2)
     1257 * @since BuddyPress (1.2.0)
    11101258 *
    11111259 * @uses bp_get_activity_type()
    11121260 */
     
    11171265        /**
    11181266         * Return the activity type.
    11191267         *
    1120          * @since BuddyPress (1.2)
     1268         * @since BuddyPress (1.2.0)
    11211269         *
    11221270         * @global object $activities_template {@link BP_Activity_Template}
    11231271         * @uses apply_filters() To call the 'bp_get_activity_type' hook.
     
    11261274         */
    11271275        function bp_get_activity_type() {
    11281276                global $activities_template;
     1277
     1278                /**
     1279                 * Filters the activity type.
     1280                 *
     1281                 * @since BuddyPress (1.2.0)
     1282                 *
     1283                 * @param string $activity_type The activity type.
     1284                 */
    11291285                return apply_filters( 'bp_get_activity_type', $activities_template->activity->type );
    11301286        }
    11311287
     
    11341290         *
    11351291         * Just a wrapper for bp_activity_type().
    11361292         *
    1137          * @since BuddyPress (1.2)
    1138          * @deprecated BuddyPress (1.5)
     1293         * @since BuddyPress (1.2.0)
     1294         * @deprecated BuddyPress (1.5.0)
    11391295         *
    11401296         * @todo Properly deprecate in favor of bp_activity_type() and
    11411297         *               remove redundant echo
     
    11491305         *
    11501306         * Just a wrapper for bp_get_activity_type().
    11511307         *
    1152          * @since BuddyPress (1.2)
    1153          * @deprecated BuddyPress (1.5)
     1308         * @since BuddyPress (1.2.0)
     1309         * @deprecated BuddyPress (1.5.0)
    11541310         *
    11551311         * @todo Properly deprecate in favor of bp_get_activity_type().
    11561312         *
     
    11631319/**
    11641320 * Output the activity user ID.
    11651321 *
    1166  * @since BuddyPress (1.1)
     1322 * @since BuddyPress (1.1.0)
    11671323 *
    11681324 * @uses bp_get_activity_user_id()
    11691325 */
     
    11741330        /**
    11751331         * Return the activity user ID.
    11761332         *
    1177          * @since BuddyPress (1.1)
     1333         * @since BuddyPress (1.1.0)
    11781334         *
    11791335         * @global object $activities_template {@link BP_Activity_Template}
    11801336         * @uses apply_filters() To call the 'bp_get_activity_user_id' hook.
     
    11831339         */
    11841340        function bp_get_activity_user_id() {
    11851341                global $activities_template;
     1342
     1343                /**
     1344                 * Filters the activity user ID.
     1345                 *
     1346                 * @since BuddyPress (1.1.0)
     1347                 *
     1348                 * @param int $user_id The activity user ID.
     1349                 */
    11861350                return apply_filters( 'bp_get_activity_user_id', $activities_template->activity->user_id );
    11871351        }
    11881352
     
    11891353/**
    11901354 * Output the activity user link.
    11911355 *
    1192  * @since BuddyPress (1.2)
     1356 * @since BuddyPress (1.2.0)
    11931357 *
    11941358 * @uses bp_get_activity_user_link()
    11951359 */
     
    12001364        /**
    12011365         * Return the activity user link.
    12021366         *
    1203          * @since BuddyPress (1.2)
     1367         * @since BuddyPress (1.2.0)
    12041368         *
    12051369         * @global object $activities_template {@link BP_Activity_Template}
    12061370         * @uses bp_core_get_user_domain()
     
    12171381                        $link = bp_core_get_user_domain( $activities_template->activity->user_id, $activities_template->activity->user_nicename, $activities_template->activity->user_login );
    12181382                }
    12191383
     1384                /**
     1385                 * Filters the activity user link.
     1386                 *
     1387                 * @since BuddyPress (1.2.0)
     1388                 *
     1389                 * @param string $link The activity user link.
     1390                 */
    12201391                return apply_filters( 'bp_get_activity_user_link', $link );
    12211392        }
    12221393
     
    12231394/**
    12241395 * Output the avatar of the user that performed the action.
    12251396 *
    1226  * @since BuddyPress (1.1)
     1397 * @since BuddyPress (1.1.0)
    12271398 *
    12281399 * @see bp_get_activity_avatar() for description of arguments.
    12291400 * @uses bp_get_activity_avatar()
     
    12361407        /**
    12371408         * Return the avatar of the user that performed the action.
    12381409         *
    1239          * @since BuddyPress (1.1)
     1410         * @since BuddyPress (1.1.0)
    12401411         *
    12411412         * @see bp_core_fetch_avatar() For a description of the arguments.
    12421413         * @global object $activities_template {@link BP_Activity_Template}
     
    13091480                        }
    13101481                }
    13111482
    1312                 // Primary activity avatar is always a user, but can be modified via a filter
     1483                /**
     1484                 * Filters the activity avatar object based on current activity item component.
     1485                 *
     1486                 * This is a variable filter dependent on the component used.
     1487                 * Possible hooks are bp_get_activity_avatar_object_blog,
     1488                 * bp_get_activity_avatar_object_group, and bp_get_activity_avatar_object_user.
     1489                 *
     1490                 * @since BuddyPress (1.1.0)
     1491                 *
     1492                 * @param string $component Component being displayed.
     1493                 */
    13131494                $object  = apply_filters( 'bp_get_activity_avatar_object_' . $current_activity_item->component, 'user' );
    13141495                $item_id = !empty( $user_id ) ? $user_id : $current_activity_item->user_id;
     1496
     1497                /**
     1498                 * Filters the activity avatar item ID.
     1499                 *
     1500                 * @since BuddyPress (1.2.10)
     1501                 *
     1502                 * @param int $item_id Item ID for the activity avatar.
     1503                 */
    13151504                $item_id = apply_filters( 'bp_get_activity_avatar_item_id', $item_id );
    13161505
    13171506                // If this is a user object pass the users' email address for Gravatar so we don't have to refetch it.
     
    13181507                if ( 'user' == $object && empty( $user_id ) && empty( $email ) && isset( $current_activity_item->user_email ) )
    13191508                        $email = $current_activity_item->user_email;
    13201509
     1510                /**
     1511                 * Filters the value returned by bp_core_fetch_avatar.
     1512                 *
     1513                 * @since BuddyPress (1.1.3)
     1514                 *
     1515                 * @param array $value Array of arguments calculated for use with bp_core_fetch_avatar.
     1516                 */
    13211517                return apply_filters( 'bp_get_activity_avatar', bp_core_fetch_avatar( array(
    13221518                        'item_id' => $item_id,
    13231519                        'object'  => $object,
     
    13331529/**
    13341530 * Output the avatar of the object that action was performed on.
    13351531 *
    1336  * @since BuddyPress (1.2)
     1532 * @since BuddyPress (1.2.0)
    13371533 *
    13381534 * @see bp_get_activity_secondary_avatar() for description of arguments.
    13391535 * @uses bp_get_activity_secondary_avatar()
     
    13471543        /**
    13481544         * Return the avatar of the object that action was performed on
    13491545         *
    1350          * @since BuddyPress (1.2)
     1546         * @since BuddyPress (1.2.0)
    13511547         *
    13521548         * @see bp_core_fetch_avatar() for description of arguments.
    13531549         * @global object $activities_template {@link BP_Activity_Template}
     
    14461642                                break;
    14471643                }
    14481644
    1449                 // Allow object, item_id, and link to be filtered
     1645                /**
     1646                 * Filters the activity secondary avatar object based on current activity item component.
     1647                 *
     1648                 * This is a variable filter dependent on the component used. Possible hooks are bp_get_activity_secondary_avatar_object_blog, bp_get_activity_secondary_avatar_object_group, and bp_get_activity_secondary_avatar_object_user.
     1649                 *
     1650                 * @since BuddyPress (1.2.10)
     1651                 *
     1652                 * @param string $object Component being displayed.
     1653                 */
    14501654                $object  = apply_filters( 'bp_get_activity_secondary_avatar_object_' . $activities_template->activity->component, $object );
     1655
     1656                /**
     1657                 * Filters the activity secondary avatar item ID.
     1658                 *
     1659                 * @since BuddyPress (1.2.10)
     1660                 *
     1661                 * @param int $item_id ID for the secondary avatar item.
     1662                 */
    14511663                $item_id = apply_filters( 'bp_get_activity_secondary_avatar_item_id', $item_id );
    14521664
    14531665                // If we have no item_id or object, there is no avatar to display
     
    14681680                ) );
    14691681
    14701682                if ( !empty( $linked ) ) {
     1683
     1684                        /**
     1685                         * Filters the secondary avatar link for current activity.
     1686                         *
     1687                         * @since BuddyPress (1.7.0)
     1688                         *
     1689                         * @param string $link Link to wrap the avatar image in.
     1690                         * @param string $component Activity componant being acted on.
     1691                         */
    14711692                        $link = apply_filters( 'bp_get_activity_secondary_avatar_link', $link, $activities_template->activity->component );
    14721693
     1694                        /**
     1695                         * Filters the determined avatar for the secondary activity item.
     1696                         *
     1697                         * @since BuddyPress (1.2.10)
     1698                         *
     1699                         * @param string Formatted HTML <img> element, or raw avatar URL.
     1700                         */
     1701                        $avatar = apply_filters( 'bp_get_activity_secondary_avatar', $avatar );
     1702
    14731703                        return sprintf( '<a href="%s" class="%s">%s</a>',
    14741704                                $link,
    14751705                                $link_class,
    1476                                 apply_filters( 'bp_get_activity_secondary_avatar', $avatar )
     1706                                $avatar
    14771707                        );
    14781708                }
    14791709
    1480                 // else
     1710                /** This filter is documented in bp-activity/bp-activity-template.php */
    14811711                return apply_filters( 'bp_get_activity_secondary_avatar', $avatar );
    14821712        }
    14831713
     
    14841714/**
    14851715 * Output the activity action
    14861716 *
    1487  * @since BuddyPress (1.2)
     1717 * @since BuddyPress (1.2.0)
    14881718 *
    14891719 * @param array $args See bp_get_activity_action()
    14901720 * @uses bp_get_activity_action()
     
    14961726        /**
    14971727         * Return the activity action
    14981728         *
    1499          * @since BuddyPress (1.2)
     1729         * @since BuddyPress (1.2.0)
    15001730         *
    15011731         * @global object $activities_template {@link BP_Activity_Template}
    15021732         * @param array $args Only parameter is "no_timestamp". If true, timestamp is shown in output.
     
    15201750                extract( $args, EXTR_SKIP );
    15211751
    15221752                $action = $activities_template->activity->action;
     1753
     1754                /**
     1755                 * Filters the activity action before the action is inserted as meta.
     1756                 *
     1757                 * @since BuddyPress (1.2.10)
     1758                 *
     1759                 * @param array $value Array containing the current action, the current activity, and the $args array passed into the function.
     1760                 */
    15231761                $action = apply_filters_ref_array( 'bp_get_activity_action_pre_meta', array( $action, &$activities_template->activity, $args ) );
    15241762
    15251763                if ( ! empty( $action ) && ! $no_timestamp )
    15261764                        $action = bp_insert_activity_meta( $action );
    15271765
     1766                /**
     1767                 * Filters the activity action after the action has been inserted as meta.
     1768                 *
     1769                 * @since BuddyPress (1.2.0)
     1770                 *
     1771                 * @param array $value Array containing the current action, the current activity, and the $args array passed into the function.
     1772                 */
    15281773                return apply_filters_ref_array( 'bp_get_activity_action', array( $action, &$activities_template->activity, $args ) );
    15291774        }
    15301775
     
    15311776/**
    15321777 * Output the activity content body
    15331778 *
    1534  * @since BuddyPress (1.2)
     1779 * @since BuddyPress (1.2.0)
    15351780 *
    15361781 * @uses bp_get_activity_content_body()
    15371782 */
     
    15421787        /**
    15431788         * Return the activity content body
    15441789         *
    1545          * @since BuddyPress (1.2)
     1790         * @since BuddyPress (1.2.0)
    15461791         *
    15471792         * @global object $activities_template {@link BP_Activity_Template}
    15481793         * @uses bp_insert_activity_meta()
     
    15571802                if ( empty( $activities_template->activity->action ) && !empty( $activities_template->activity->content ) )
    15581803                        $activities_template->activity->content = bp_insert_activity_meta( $activities_template->activity->content );
    15591804
     1805                /**
     1806                 * Filters the activity content body.
     1807                 *
     1808                 * @since BuddyPress (1.2.0)
     1809                 *
     1810                 * @param array $value Array containing the current activity content body and the current activity.
     1811                 */
    15601812                return apply_filters_ref_array( 'bp_get_activity_content_body', array( $activities_template->activity->content, &$activities_template->activity ) );
    15611813        }
    15621814
     
    15631815/**
    15641816 * Does the activity have content?
    15651817 *
    1566  * @since BuddyPress (1.2)
     1818 * @since BuddyPress (1.2.0)
    15671819 *
    15681820 * @global object $activities_template {@link BP_Activity_Template}
    15691821 *
     
    15811833/**
    15821834 * Output the activity content.
    15831835 *
    1584  * @since BuddyPress (1.0)
    1585  * @deprecated BuddyPress (1.5)
     1836 * @since BuddyPress (1.0.0)
     1837 * @deprecated BuddyPress (1.5.0)
    15861838 *
    15871839 * @todo properly deprecate this function.
    15881840 *
     
    15951847        /**
    15961848         * Return the activity content.
    15971849         *
    1598          * @since BuddyPress (1.0)
    1599          * @deprecated BuddyPress (1.5)
     1850         * @since BuddyPress (1.0.0)
     1851         * @deprecated BuddyPress (1.5.0)
    16001852         *
    16011853         * @todo properly deprecate this function.
    16021854         *
     
    16071859         * @return string The activity content.
    16081860         */
    16091861        function bp_get_activity_content() {
     1862
    16101863                /**
    16111864                 * If you want to filter activity update content, please use
    16121865                 * the filter 'bp_get_activity_content_body'
     
    16131866                 *
    16141867                 * This function is mainly for backwards comptibility.
    16151868                 */
    1616 
    16171869                $content = bp_get_activity_action() . ' ' . bp_get_activity_content_body();
    16181870                return apply_filters( 'bp_get_activity_content', $content );
    16191871        }
     
    16241876 * This metadata includes the time since the item was posted (which will appear
    16251877 * as a link to the item's permalink).
    16261878 *
    1627  * @since BuddyPress (1.2)
     1879 * @since BuddyPress (1.2.0)
    16281880 *
    16291881 * @global object $activities_template {@link BP_Activity_Template}
    16301882 * @uses bp_core_time_since()
     
    16441896        // Strip any legacy time since placeholders from BP 1.0-1.1
    16451897        $content = str_replace( '<span class="time-since">%s</span>', '', $content );
    16461898
    1647         // Insert the time since.
     1899        /**
     1900         * Filters the activity item time since markup.
     1901         *
     1902         * @since BuddyPress (1.2.0)
     1903         *
     1904         * @param array $value Array containing the time since markup and the current activity component.
     1905         */
    16481906        $time_since = apply_filters_ref_array( 'bp_activity_time_since', array( '<span class="time-since">' . bp_core_time_since( $activities_template->activity->date_recorded ) . '</span>', &$activities_template->activity ) );
    16491907
    16501908        // Insert the permalink
    1651         if ( !bp_is_single_activity() )
     1909        if ( !bp_is_single_activity() ) {
     1910
     1911                /**
     1912                 * Filters the activity permalink to be added to the activity content.
     1913                 *
     1914                 * @since BuddyPress (1.2.0)
     1915                 *
     1916                 * @param array $value Array containing the html markup for the activity permalink, after being parsed by sprintf and current activity component.
     1917                 */
    16521918                $content = apply_filters_ref_array( 'bp_activity_permalink', array( sprintf( '%1$s <a href="%2$s" class="view activity-time-since" title="%3$s">%4$s</a>', $content, bp_activity_get_permalink( $activities_template->activity->id, $activities_template->activity ), esc_attr__( 'View Discussion', 'buddypress' ), $time_since ), &$activities_template->activity ) );
    1653         else
     1919        } else {
    16541920                $content .= str_pad( $time_since, strlen( $time_since ) + 2, ' ', STR_PAD_BOTH );
     1921        }
    16551922
     1923        /**
     1924         * Filters the activity content after activity metadata has been attached.
     1925         *
     1926         * @since BuddyPress (1.2.0)
     1927         *
     1928         * @param string $content Activity content with the activity metadata added.
     1929         */
    16561930        return apply_filters( 'bp_insert_activity_meta', $content );
    16571931}
    16581932
     
    16591933/**
    16601934 * Determine if the current user can delete an activity item.
    16611935 *
    1662  * @since BuddyPress (1.2)
     1936 * @since BuddyPress (1.2.0)
    16631937 *
    16641938 * @global object $activities_template {@link BP_Activity_Template}
    16651939 * @uses apply_filters() To call the 'bp_activity_user_can_delete' hook
     
    17041978                }
    17051979        }
    17061980
     1981        /**
     1982         * Filters whether the current user can delete an activity item.
     1983         *
     1984         * @since BuddyPress (1.5.0)
     1985         *
     1986         * @param bool   $can_delete Whether the user can delete the item.
     1987         * @param object $activity Current activity item object.
     1988         */
    17071989        return (bool) apply_filters( 'bp_activity_user_can_delete', $can_delete, $activity );
    17081990}
    17091991
     
    17101992/**
    17111993 * Output the activity parent content.
    17121994 *
    1713  * @since BuddyPress (1.2)
     1995 * @since BuddyPress (1.2.0)
    17141996 *
    17151997 * @see bp_get_activity_parent_content() for a description of arguments.
    17161998 * @uses bp_get_activity_parent_content()
     
    17242006        /**
    17252007         * Return the activity content.
    17262008         *
    1727          * @since BuddyPress (1.2)
     2009         * @since BuddyPress (1.2.0)
    17282010         *
    17292011         * @global object $activities_template {@link BP_Activity_Template}
    17302012         * @uses wp_parse_args()
     
    17712053                // Remove images
    17722054                $content = preg_replace( '/<img[^>]*>/Ui', '', $content );
    17732055
     2056                /**
     2057                 * Filters the activity parent content.
     2058                 *
     2059                 * @since BuddyPress (1.2.0)
     2060                 *
     2061                 * @param string $content Content set to be displayed as parent content.
     2062                 */
    17742063                return apply_filters( 'bp_get_activity_parent_content', $content );
    17752064        }
    17762065
     
    17772066/**
    17782067 * Output the parent activity's user ID.
    17792068 *
    1780  * @since BuddyPress (1.7)
     2069 * @since BuddyPress (1.7.0)
    17812070 */
    17822071function bp_activity_parent_user_id() {
    17832072        echo bp_get_activity_parent_user_id();
     
    17862075        /**
    17872076         * Return the parent activity's user ID.
    17882077         *
    1789          * @since BuddyPress (1.7)
     2078         * @since BuddyPress (1.7.0)
    17902079         *
    17912080         * @global BP_Activity_Template $activities_template
    17922081         *
     
    18142103
    18152104                $retval = $activities_template->activity_parents[$parent_id]->user_id;
    18162105
     2106                /**
     2107                 * Filters the activity parent item's user ID.
     2108                 *
     2109                 * @since BuddyPress (1.7.0)
     2110                 *
     2111                 * @param int $retval ID for the activity parent's user.
     2112                 */
    18172113                return (int) apply_filters( 'bp_get_activity_parent_user_id', $retval );
    18182114        }
    18192115
     
    18202116/**
    18212117 * Output whether or not the current activity is in a current user's favorites.
    18222118 *
    1823  * @since BuddyPress (1.2)
     2119 * @since BuddyPress (1.2.0)
    18242120 *
    18252121 * @uses bp_get_activity_is_favorite()
    18262122 */
     
    18312127        /**
    18322128         * Return whether the current activity is in a current user's favorites.
    18332129         *
    1834          * @since BuddyPress (1.2)
     2130         * @since BuddyPress (1.2.0)
    18352131         *
    18362132         * @global object $activities_template {@link BP_Activity_Template}
    18372133         * @uses apply_filters() To call the 'bp_get_activity_is_favorite' hook.
     
    18412137        function bp_get_activity_is_favorite() {
    18422138                global $activities_template;
    18432139
     2140                /**
     2141                 * Filters whether the current activity item is in the current user's favorites.
     2142                 *
     2143                 * @since BuddyPress (1.2.0)
     2144                 *
     2145                 * @param bool $value Whether or not the current activity item is in the current user's favorites.
     2146                 */
    18442147                return (bool) apply_filters( 'bp_get_activity_is_favorite', in_array( $activities_template->activity->id, (array) $activities_template->my_favs ) );
    18452148        }
    18462149
     
    18472150/**
    18482151 * Output the comment markup for an activity item.
    18492152 *
    1850  * @since BuddyPress (1.2)
     2153 * @since BuddyPress (1.2.0)
    18512154 *
    18522155 * @todo deprecate $args param
    18532156 *
     
    18602163        /**
    18612164         * Get the comment markup for an activity item.
    18622165         *
    1863          * @since BuddyPress (1.2)
     2166         * @since BuddyPress (1.2.0)
    18642167         *
    18652168         * @todo deprecate $args param
    18662169         *
     
    18872190                 * Note: The recursion itself used to happen entirely in this function. Now it is
    18882191                 * split between here and the comment.php template.
    18892192                 *
    1890                  * @since BuddyPress (1.2)
     2193                 * @since BuddyPress (1.2.0)
    18912194                 *
    18922195                 * @param object $comment The activity object currently being recursed
    18932196                 *
     
    19032206                        if ( empty( $comment->children ) )
    19042207                                return false;
    19052208
     2209                        /**
     2210                         * Filters the opening tag for the template that lists activity comments.
     2211                         *
     2212                         * @since BuddyPress (1.6.0)
     2213                         *
     2214                         * @param string $value Opening tag for the html markup to use.
     2215                         */
    19062216                        echo apply_filters( 'bp_activity_recurse_comments_start_ul', '<ul>');
    19072217                        foreach ( (array) $comment->children as $comment_child ) {
    19082218                                // Put the comment into the global so it's available to filters
     
    19222232
    19232233                                unset( $activities_template->activity->current_comment );
    19242234                        }
     2235
     2236                        /**
     2237                         * Filters the closing tag for the template that list activity comments.
     2238                         *
     2239                         * @since BuddyPress (1.6.0)
     2240                         *
     2241                         * @param string $value Closing tag for the html markup to use.
     2242                         */
    19252243                        echo apply_filters( 'bp_activity_recurse_comments_end_ul', '</ul>');
    19262244                }
    19272245
     
    19282246/**
    19292247 * Utility function that returns the comment currently being recursed.
    19302248 *
    1931  * @since BuddyPress (1.5)
     2249 * @since BuddyPress (1.5.0)
    19322250 *
    19332251 * @global object $activities_template {@link BP_Activity_Template}
    19342252 * @uses apply_filters() To call the 'bp_activity_current_comment' hook.
     
    19412259
    19422260        $current_comment = !empty( $activities_template->activity->current_comment ) ? $activities_template->activity->current_comment : false;
    19432261
     2262        /**
     2263         * Filters the current comment being recursed.
     2264         *
     2265         * @since BuddyPress (1.5.0)
     2266         *
     2267         * @param object|bool $current_comment The activity comment currently being displayed. False on failure.
     2268         */
    19442269        return apply_filters( 'bp_activity_current_comment', $current_comment );
    19452270}
    19462271
     
    19482273/**
    19492274 * Output the ID of the activity comment currently being displayed.
    19502275 *
    1951  * @since BuddyPress (1.5)
     2276 * @since BuddyPress (1.5.0)
    19522277 *
    19532278 * @uses bp_get_activity_comment_id()
    19542279 */
     
    19592284        /**
    19602285         * Return the ID of the activity comment currently being displayed.
    19612286         *
    1962          * @since BuddyPress (1.5)
     2287         * @since BuddyPress (1.5.0)
    19632288         *
    19642289         * @global object $activities_template {@link BP_Activity_Template}
    19652290         * @uses apply_filters() To call the 'bp_activity_comment_id' hook.
     
    19722297
    19732298                $comment_id = isset( $activities_template->activity->current_comment->id ) ? $activities_template->activity->current_comment->id : false;
    19742299
     2300                /**
     2301                 * Filters the ID of the activity comment currently being displayed.
     2302                 *
     2303                 * @since BuddyPress (1.5.0)
     2304                 *
     2305                 * @param int|bool $comment_id ID for the comment currently being displayed.
     2306                 */
    19752307                return apply_filters( 'bp_activity_comment_id', $comment_id );
    19762308        }
    19772309
     
    19782310/**
    19792311 * Output the ID of the author of the activity comment currently being displayed.
    19802312 *
    1981  * @since BuddyPress (1.5)
     2313 * @since BuddyPress (1.5.0)
    19822314 *
    19832315 * @uses bp_get_activity_comment_user_id()
    19842316 */
     
    19892321        /**
    19902322         * Return the ID of the author of the activity comment currently being displayed.
    19912323         *
    1992          * @since BuddyPress (1.5)
     2324         * @since BuddyPress (1.5.0)
    19932325         *
    19942326         * @global object $activities_template {@link BP_Activity_Template}
    19952327         * @uses apply_filters() To call the 'bp_activity_comment_user_id' hook.
     
    20022334
    20032335                $user_id = isset( $activities_template->activity->current_comment->user_id ) ? $activities_template->activity->current_comment->user_id : false;
    20042336
     2337                /**
     2338                 * Filters the ID of the author of the activity comment currently being displayed.
     2339                 *
     2340                 * @since BuddyPress (1.5.0)
     2341                 *
     2342                 * @param int|bool $user_id ID for the author of the comment currently being displayed.
     2343                 */
    20052344                return apply_filters( 'bp_activity_comment_user_id', $user_id );
    20062345        }
    20072346
     
    20082347/**
    20092348 * Output the author link for the activity comment currently being displayed.
    20102349 *
    2011  * @since BuddyPress (1.5)
     2350 * @since BuddyPress (1.5.0)
    20122351 *
    20132352 * @uses bp_get_activity_comment_user_link()
    20142353 */
     
    20192358        /**
    20202359         * Return the author link for the activity comment currently being displayed.
    20212360         *
    2022          * @since BuddyPress (1.5)
     2361         * @since BuddyPress (1.5.0)
    20232362         *
    20242363         * @uses bp_core_get_user_domain()
    20252364         * @uses bp_get_activity_comment_user_id()
     
    20302369        function bp_get_activity_comment_user_link() {
    20312370                $user_link = bp_core_get_user_domain( bp_get_activity_comment_user_id() );
    20322371
     2372                /**
     2373                 * Filters the author link for the activity comment currently being displayed.
     2374                 *
     2375                 * @since BuddyPress (1.5.0)
     2376                 *
     2377                 * @param string $user_link Link for the author of the activity comment currently being displayed.
     2378                 */
    20332379                return apply_filters( 'bp_activity_comment_user_link', $user_link );
    20342380        }
    20352381
     
    20362382/**
    20372383 * Output the author name for the activity comment currently being displayed.
    20382384 *
    2039  * @since BuddyPress (1.5)
     2385 * @since BuddyPress (1.5.0)
    20402386 *
    20412387 * @uses bp_get_activity_comment_name()
    20422388 */
     
    20502396         * The use of the 'bp_acomment_name' filter is deprecated. Please use
    20512397         * 'bp_activity_comment_name'.
    20522398         *
    2053          * @since BuddyPress (1.5)
     2399         * @since BuddyPress (1.5.0)
    20542400         *
    20552401         * @global object $activities_template {@link BP_Activity_Template}
    20562402         * @uses apply_filters() To call the 'bp_acomment_name' hook.
     
    20612407        function bp_get_activity_comment_name() {
    20622408                global $activities_template;
    20632409
    2064                 if ( isset( $activities_template->activity->current_comment->user_fullname ) )
     2410                if ( isset( $activities_template->activity->current_comment->user_fullname ) ) {
     2411
    20652412                        $name = apply_filters( 'bp_acomment_name', $activities_template->activity->current_comment->user_fullname, $activities_template->activity->current_comment );  // backward compatibility
    2066                 else
     2413                } else {
    20672414                        $name = $activities_template->activity->current_comment->display_name;
     2415                }
    20682416
     2417                /**
     2418                 * Filters the name of the author for the activity comment.
     2419                 *
     2420                 * @since BuddyPress (1.5.0)
     2421                 *
     2422                 * @param string $name Name to be displayed with the activity comment.
     2423                 */
    20692424                return apply_filters( 'bp_activity_comment_name', $name );
    20702425        }
    20712426
     
    20722427/**
    20732428 * Output the date_recorded of the activity comment currently being displayed.
    20742429 *
    2075  * @since BuddyPress (1.5)
     2430 * @since BuddyPress (1.5.0)
    20762431 *
    20772432 * @uses bp_get_activity_comment_date_recorded()
    20782433 */
     
    20832438        /**
    20842439         * Return the date_recorded for the activity comment currently being displayed.
    20852440         *
    2086          * @since BuddyPress (1.5)
     2441         * @since BuddyPress (1.5.0)
    20872442         *
    20882443         * @global object $activities_template {@link BP_Activity_Template}
    20892444         * @uses bp_core_time_since()
     
    21002455
    21012456                $date_recorded = bp_core_time_since( $activities_template->activity->current_comment->date_recorded );
    21022457
     2458                /**
     2459                 * Filters the recorded date of the activity comment currently being displayed.
     2460                 *
     2461                 * @since BuddyPress (1.5.0)
     2462                 *
     2463                 * @param string|bool Date for the activity comment currently being displayed.
     2464                 */
    21032465                return apply_filters( 'bp_activity_comment_date_recorded', $date_recorded );
    21042466        }
    21052467
     
    21062468/**
    21072469 * Output the 'delete' URL for the activity comment currently being displayed.
    21082470 *
    2109  * @since BuddyPress (1.5)
     2471 * @since BuddyPress (1.5.0)
    21102472 *
    21112473 * @uses bp_get_activity_comment_delete_link()
    21122474 */
     
    21172479        /**
    21182480         * Gets the 'delete' URL for the activity comment currently being displayed
    21192481         *
    2120          * @since BuddyPress (1.5)
     2482         * @since BuddyPress (1.5.0)
    21212483         *
    21222484         * @uses wp_nonce_url()
    21232485         * @uses bp_get_root_domain()
     
    21312493        function bp_get_activity_comment_delete_link() {
    21322494                $link = wp_nonce_url( bp_get_root_domain() . '/' . bp_get_activity_slug() . '/delete/' . bp_get_activity_comment_id() . '?cid=' . bp_get_activity_comment_id(), 'bp_activity_delete_link' );
    21332495
     2496                /**
     2497                 * Filters the link used for deleting the activity comment currently being displayed.
     2498                 *
     2499                 * @since BuddyPress (1.5.0)
     2500                 *
     2501                 * @param string $link Link to use for deleting the currently displayed activity comment.
     2502                 */
    21342503                return apply_filters( 'bp_activity_comment_delete_link', $link );
    21352504        }
    21362505
     
    21372506/**
    21382507 * Output the content of the activity comment currently being displayed.
    21392508 *
    2140  * @since BuddyPress (1.5)
     2509 * @since BuddyPress (1.5.0)
    21412510 *
    21422511 * @uses bp_get_activity_comment_content()
    21432512 */
     
    21532522         * 'bp_activity_comment_content' to modify the content of activity
    21542523         * comments only.
    21552524         *
    2156          * @since BuddyPress (1.5)
     2525         * @since BuddyPress (1.5.0)
    21572526         *
    21582527         * @global object $activities_template {@link BP_Activity_Template}
    21592528         * @uses apply_filters() To call the 'bp_get_activity_content' hook.
     
    21642533        function bp_get_activity_comment_content() {
    21652534                global $activities_template;
    21662535
     2536                /** This filter is documented in bp-activity/bp-activity-template.php */
    21672537                $content = apply_filters( 'bp_get_activity_content', $activities_template->activity->current_comment->content );
    21682538
     2539                /**
     2540                 * Filters the content of the current activity comment.
     2541                 *
     2542                 * @since BuddyPress (1.2.0)
     2543                 *
     2544                 * @param string $content The content of the current activity comment.
     2545                 */
    21692546                return apply_filters( 'bp_activity_comment_content', $content );
    21702547        }
    21712548
     
    21722549/**
    21732550 * Output the activity comment count.
    21742551 *
    2175  * @since BuddyPress (1.2)
     2552 * @since BuddyPress (1.2.0)
    21762553 *
    21772554 * @uses bp_activity_get_comment_count()
    21782555 */
     
    21832560        /**
    21842561         * Return the comment count of an activity item.
    21852562         *
    2186          * @since BuddyPress (1.2)
     2563         * @since BuddyPress (1.2.0)
    21872564         *
    21882565         * @global object $activities_template {@link BP_Activity_Template}
    21892566         * @uses bp_activity_recurse_comment_count()
     
    22062583                        ? bp_activity_recurse_comment_count( $activities_template->activity )
    22072584                        : 0;
    22082585
     2586                /**
     2587                 * Filters the activity comment count.
     2588                 *
     2589                 * @since BuddyPress (1.2.0)
     2590                 *
     2591                 * @param int $count The activity comment count.
     2592                 */
    22092593                return apply_filters( 'bp_activity_get_comment_count', (int) $count );
    22102594        }
    22112595
     
    22152599                 * This function recursively adds the total number of comments each
    22162600                 * activity child has, and returns them.
    22172601                 *
    2218                  * @since BuddyPress (1.2)
     2602                 * @since BuddyPress (1.2.0)
    22192603                 *
    22202604                 * @uses bp_activity_recurse_comment_count()
    22212605                 * @uses apply_filters() To call the 'bp_activity_recurse_comment_count' hook
     
    22382622                                }
    22392623                        }
    22402624
    2241                         // Filter and return
     2625                        /**
     2626                         * Filters the total number of comments for the current comment.
     2627                         *
     2628                         * @since BuddyPress (2.1.0)
     2629                         *
     2630                         * @param int    $new_count New total count for the current comment.
     2631                         * @param object $comment Activity comment object.
     2632                         * @param int    $count Current iteration count for the current comment.
     2633                         */
    22422634                        return apply_filters( 'bp_activity_recurse_comment_count', $new_count, $comment, $count );
    22432635                }
    22442636
     
    22552647         *
    22562648         * @since BuddyPress (2.0.0)
    22572649         *
    2258          * @return int
     2650         * @return int $depth Depth for the current activity comment
    22592651         */
    22602652        function bp_activity_get_comment_depth() {
    22612653                global $activities_template;
     2654
     2655                /**
     2656                 * Filters the comment depth of the current activity comment.
     2657                 *
     2658                 * @since BuddyPress (2.0.0)
     2659                 *
     2660                 * @param int $depth Depth for the current activity comment.
     2661                 */
    22622662                return apply_filters( 'bp_activity_get_comment_depth', $activities_template->activity->current_comment->depth );
    22632663        }
    22642664
     
    22652665/**
    22662666 * Output the activity comment link.
    22672667 *
    2268  * @since BuddyPress (1.2)
     2668 * @since BuddyPress (1.2.0)
    22692669 *
    22702670 * @uses bp_get_activity_comment_link()
    22712671 */
     
    22762676        /**
    22772677         * Return the activity comment link.
    22782678         *
    2279          * @since BuddyPress (1.2)
     2679         * @since BuddyPress (1.2.0)
    22802680         *
    22812681         * @global object $activities_template {@link BP_Activity_Template}
    22822682         * @uses apply_filters() To call the 'bp_get_activity_comment_link' hook.
     
    22852685         */
    22862686        function bp_get_activity_comment_link() {
    22872687                global $activities_template;
     2688
     2689                /**
     2690                 * Filters the comment link for the current activity comment.
     2691                 *
     2692                 * @since BuddyPress (1.2.0)
     2693                 *
     2694                 * @param string $value Constructed URL parameters with activity IDs.
     2695                 */
    22882696                return apply_filters( 'bp_get_activity_comment_link', '?ac=' . $activities_template->activity->id . '/#ac-form-' . $activities_template->activity->id );
    22892697        }
    22902698
     
    22912699/**
    22922700 * Output the activity comment form no javascript display CSS.
    22932701 *
    2294  * @since BuddyPress (1.2)
     2702 * @since BuddyPress (1.2.0)
    22952703 *
    22962704 * @uses bp_get_activity_comment_form_nojs_display()
    22972705 */
     
    23022710        /**
    23032711         * Return the activity comment form no javascript display CSS.
    23042712         *
    2305          * @since BuddyPress (1.2)
     2713         * @since BuddyPress (1.2.0)
    23062714         *
    23072715         * @global object $activities_template {@link BP_Activity_Template}
    23082716         *
     
    23202728/**
    23212729 * Output the activity comment form action.
    23222730 *
    2323  * @since BuddyPress (1.2)
     2731 * @since BuddyPress (1.2.0)
    23242732 *
    23252733 * @uses bp_get_activity_comment_form_action()
    23262734 */
     
    23312739        /**
    23322740         * Return the activity comment form action.
    23332741         *
    2334          * @since BuddyPress (1.2)
     2742         * @since BuddyPress (1.2.0)
    23352743         *
    23362744         * @uses home_url()
    23372745         * @uses bp_get_activity_root_slug()
     
    23402748         * @return string The activity comment form action.
    23412749         */
    23422750        function bp_get_activity_comment_form_action() {
     2751
     2752                /**
     2753                 * Filters the activity comment form action url.
     2754                 *
     2755                 * @since BuddyPress (1.2.0)
     2756                 *
     2757                 * @param string $value URL to use in the comment form's action attribute.
     2758                 */
    23432759                return apply_filters( 'bp_get_activity_comment_form_action', home_url( bp_get_activity_root_slug() . '/reply/' ) );
    23442760        }
    23452761
     
    23462762/**
    23472763 * Output the activity permalink ID.
    23482764 *
    2349  * @since BuddyPress (1.2)
     2765 * @since BuddyPress (1.2.0)
    23502766 *
    23512767 * @uses bp_get_activity_permalink_id()
    23522768 */
     
    23572773        /**
    23582774         * Return the activity permalink ID.
    23592775         *
    2360          * @since BuddyPress (1.2)
     2776         * @since BuddyPress (1.2.0)
    23612777         *
    23622778         * @uses apply_filters() To call the 'bp_get_activity_permalink_id' hook.
    23632779         *
     
    23642780         * @return string The activity permalink ID.
    23652781         */
    23662782        function bp_get_activity_permalink_id() {
     2783
     2784                /**
     2785                 * Filters the activity action permalink ID.
     2786                 *
     2787                 * @since BuddyPress (1.2.0)
     2788                 *
     2789                 * @param string $value Current action for the activity item.
     2790                 */
    23672791                return apply_filters( 'bp_get_activity_permalink_id', bp_current_action() );
    23682792        }
    23692793
     
    23702794/**
    23712795 * Output the activity thread permalink.
    23722796 *
    2373  * @since BuddyPress (1.2)
     2797 * @since BuddyPress (1.2.0)
    23742798 *
    23752799 * @uses bp_get_activity_permalink_id()
    23762800 */
     
    23812805        /**
    23822806         * Return the activity thread permalink.
    23832807         *
    2384          * @since BuddyPress (1.2)
     2808         * @since BuddyPress (1.2.0)
    23852809         *
    23862810         * @uses bp_activity_get_permalink()
    23872811         * @uses apply_filters() To call the 'bp_get_activity_thread_permalink' hook.
     
    23932817
    23942818                $link = bp_activity_get_permalink( $activities_template->activity->id, $activities_template->activity );
    23952819
     2820                /**
     2821                 * Filters the activity thread permalink.
     2822                 *
     2823                 * @since BuddyPress (1.2.0)
     2824                 *
     2825                 * @param string $link The activity thread permalink.
     2826                 */
    23962827                return apply_filters( 'bp_get_activity_thread_permalink', $link );
    23972828        }
    23982829
     
    23992830/**
    24002831 * Output the activity comment permalink.
    24012832 *
    2402  * @since BuddyPress (1.8)
     2833 * @since BuddyPress (1.8.0)
    24032834 *
    24042835 * @uses bp_get_activity_permalink_id()
    24052836 */
     
    24092840        /**
    24102841         * Return the activity comment permalink.
    24112842         *
    2412          * @since BuddyPress (1.8)
     2843         * @since BuddyPress (1.8.0)
    24132844         *
    24142845         * @uses bp_activity_get_permalink()
    24152846         * @uses apply_filters() To call the 'bp_get_activity_comment_permalink' hook.
     
    24322863                // Append comment ID to end of activity permalink
    24332864                $link = bp_activity_get_permalink( $activities_template->activity->id, $activities_template->activity ) . $comment_link;
    24342865
     2866                /**
     2867                 * Filters the activity comment permalink.
     2868                 *
     2869                 * @since BuddyPress (1.8.0)
     2870                 *
     2871                 * @param string $link Activity comment permalink.
     2872                 * @param int    $comment_id ID for the current activity comment.
     2873                 */
    24352874                return apply_filters( 'bp_get_activity_comment_permalink', $link, $comment_id );
    24362875        }
    24372876
     
    24382877/**
    24392878 * Output the activity favorite link.
    24402879 *
    2441  * @since BuddyPress (1.2)
     2880 * @since BuddyPress (1.2.0)
    24422881 *
    24432882 * @uses bp_get_activity_favorite_link()
    24442883 */
     
    24492888        /**
    24502889         * Return the activity favorite link.
    24512890         *
    2452          * @since BuddyPress (1.2)
     2891         * @since BuddyPress (1.2.0)
    24532892         *
    24542893         * @global object $activities_template {@link BP_Activity_Template}
    24552894         * @uses wp_nonce_url()
     
    24612900         */
    24622901        function bp_get_activity_favorite_link() {
    24632902                global $activities_template;
     2903
     2904                /**
     2905                 * Filters the activity favorite link.
     2906                 *
     2907                 * @since BuddyPress (1.2.0)
     2908                 *
     2909                 * @param string $value Constructed link for favoriting the activity comment.
     2910                 */
    24642911                return apply_filters( 'bp_get_activity_favorite_link', wp_nonce_url( home_url( bp_get_activity_root_slug() . '/favorite/' . $activities_template->activity->id . '/' ), 'mark_favorite' ) );
    24652912        }
    24662913
     
    24672914/**
    24682915 * Output the activity unfavorite link.
    24692916 *
    2470  * @since BuddyPress (1.2)
     2917 * @since BuddyPress (1.2.0)
    24712918 *
    24722919 * @uses bp_get_activity_unfavorite_link()
    24732920 */
     
    24782925        /**
    24792926         * Return the activity unfavorite link.
    24802927         *
    2481          * @since BuddyPress (1.2)
     2928         * @since BuddyPress (1.2.0)
    24822929         *
    24832930         * @global object $activities_template {@link BP_Activity_Template}
    24842931         * @uses wp_nonce_url()
     
    24902937         */
    24912938        function bp_get_activity_unfavorite_link() {
    24922939                global $activities_template;
     2940
     2941                /**
     2942                 * Filters the activity unfavorite link.
     2943                 *
     2944                 * @since BuddyPress (1.2.0)
     2945                 *
     2946                 * @param string $value Constructed link for unfavoriting the activity comment.
     2947                 */
    24932948                return apply_filters( 'bp_get_activity_unfavorite_link', wp_nonce_url( home_url( bp_get_activity_root_slug() . '/unfavorite/' . $activities_template->activity->id . '/' ), 'unmark_favorite' ) );
    24942949        }
    24952950
     
    24962951/**
    24972952 * Output the activity CSS class.
    24982953 *
    2499  * @since BuddyPress (1.0)
     2954 * @since BuddyPress (1.0.0)
    25002955 *
    25012956 * @uses bp_get_activity_css_class()
    25022957 */
     
    25072962        /**
    25082963         * Return the current activity item's CSS class.
    25092964         *
    2510          * @since BuddyPress (1.0)
     2965         * @since BuddyPress (1.0.0)
    25112966         *
    25122967         * @global object $activities_template {@link BP_Activity_Template}
    25132968         * @uses apply_filters() To call the 'bp_activity_mini_activity_types' hook.
     
    25202975        function bp_get_activity_css_class() {
    25212976                global $activities_template;
    25222977
     2978                /**
     2979                 * Filters the available mini activity actions available as css classes.
     2980                 *
     2981                 * @since BuddyPress (1.2.0)
     2982                 *
     2983                 * @param array $value Array of classes used to determine classes applied to HTML element.
     2984                 */
    25232985                $mini_activity_actions = apply_filters( 'bp_activity_mini_activity_types', array(
    25242986                        'friendship_accepted',
    25252987                        'friendship_created',
     
    25372999                if ( bp_activity_get_comment_count() && bp_activity_can_comment() )
    25383000                        $class .= ' has-comments';
    25393001
     3002                /**
     3003                 * Filters the determined classes to add to the HTML element.
     3004                 *
     3005                 * @since BuddyPress (1.0.0)
     3006                 *
     3007                 * @param string $value Classes to be added to the HTML element.
     3008                 */
    25403009                return apply_filters( 'bp_get_activity_css_class', $activities_template->activity->component . ' ' . $activities_template->activity->type . $class );
    25413010        }
    25423011
     
    25433012/**
    25443013 * Output the activity delete link.
    25453014 *
    2546  * @since BuddyPress (1.1)
     3015 * @since BuddyPress (1.1.0)
    25473016 *
    25483017 * @uses bp_get_activity_delete_link()
    25493018 */
     
    25543023        /**
    25553024         * Return the activity delete link.
    25563025         *
    2557          * @since BuddyPress (1.1)
     3026         * @since BuddyPress (1.1.0)
    25583027         *
    25593028         * @global object $activities_template {@link BP_Activity_Template}
    25603029         * @uses bp_get_root_domain()
     
    25813050
    25823051                $link = '<a href="' . esc_url( $url ) . '" class="button item-button bp-secondary-action ' . $class . ' confirm" rel="nofollow">' . __( 'Delete', 'buddypress' ) . '</a>';
    25833052
     3053                /**
     3054                 * Filters the activity delete link.
     3055                 *
     3056                 * @since BuddyPress (1.1.0)
     3057                 *
     3058                 * @param string $link Activity delete HTML link.
     3059                 */
    25843060                return apply_filters( 'bp_get_activity_delete_link', $link );
    25853061        }
    25863062
     
    26243100
    26253101                $url = wp_nonce_url( $url, 'bp_activity_delete_link' );
    26263102
     3103                /**
     3104                 * Filters the activity delete URL.
     3105                 *
     3106                 * @since BuddyPress (2.1.0)
     3107                 *
     3108                 * @param string $url Activity delete URL.
     3109                 */
    26273110                return apply_filters( 'bp_get_activity_delete_url', $url );
    26283111        }
    26293112
     
    26303113/**
    26313114 * Output the activity latest update link.
    26323115 *
    2633  * @since BuddyPress (1.2)
     3116 * @since BuddyPress (1.2.0)
    26343117 *
    26353118 * @see bp_get_activity_latest_update() for description of parameters.
    26363119 * @uses bp_get_activity_latest_update()
     
    26443127        /**
    26453128         * Return the activity latest update link.
    26463129         *
    2647          * @since BuddyPress (1.2)
     3130         * @since BuddyPress (1.2.0)
    26483131         *
    26493132         * @uses bp_is_user_inactive()
    26503133         * @uses bp_core_is_user_deleted()
     
    26703153                if ( !$update = bp_get_user_meta( $user_id, 'bp_latest_update', true ) )
    26713154                        return false;
    26723155
     3156                /**
     3157                 * Filters the latest update excerpt.
     3158                 *
     3159                 * @since BuddyPress (1.2.10)
     3160                 *
     3161                 * @param string $value The excerpt for the latest update.
     3162                 */
    26733163                $latest_update = apply_filters( 'bp_get_activity_latest_update_excerpt', trim( strip_tags( bp_create_excerpt( $update['content'], 358 ) ) ) );
    26743164
    26753165                $latest_update = sprintf(
     
    26793169                        esc_attr__( 'View', 'buddypress' )
    26803170                );
    26813171
     3172                /**
     3173                 * Filters the latest update excerpt with view link appended to the end.
     3174                 *
     3175                 * @since BuddyPress (1.2.0)
     3176                 *
     3177                 * @param string $latest_update The latest update with "view" link appended to it.
     3178                 */
    26823179                return apply_filters( 'bp_get_activity_latest_update', $latest_update );
    26833180        }
    26843181
     
    26853182/**
    26863183 * Output the activity filter links.
    26873184 *
    2688  * @since BuddyPress (1.1)
     3185 * @since BuddyPress (1.1.0)
    26893186 *
    26903187 * @see bp_get_activity_filter_links() for description of parameters.
    26913188 * @uses bp_get_activity_filter_links()
     
    26993196        /**
    27003197         * Return the activity filter links.
    27013198         *
    2702          * @since BuddyPress (1.1)
     3199         * @since BuddyPress (1.1.0)
    27033200         *
    27043201         * @uses wp_parse_args()
    27053202         * @uses BP_Activity_Activity::get_recorded_components() {@link BP_Activity_Activity}
     
    27673264
    27683265                        $link = add_query_arg( 'afilter', $component );
    27693266                        $link = remove_query_arg( 'acpage' , $link );
     3267
     3268                        /**
     3269                         * Filters the activity filter link url for the current activity component.
     3270                         *
     3271                         * @since BuddyPress (1.1.0)
     3272                         *
     3273                         * @param string $link The URL for the current component.
     3274                         * @param string $component The current component getting links constructed for.
     3275                         */
    27703276                        $link = apply_filters( 'bp_get_activity_filter_link_href', $link, $component );
    27713277
    27723278                        $component_links[] = $before . '<a href="' . esc_attr( $link ) . '">' . ucwords( $component ) . '</a>' . $after;
     
    27773283                if ( isset( $_GET['afilter'] ) )
    27783284                        $component_links[] = '<' . $tag . ' id="afilter-clear"><a href="' . esc_attr( $link ) . '">' . __( 'Clear Filter', 'buddypress' ) . '</a></' . $tag . '>';
    27793285
     3286                /**
     3287                 * Filters all of the constructed filter links.
     3288                 *
     3289                 * @since BuddyPress (1.1.0)
     3290                 *
     3291                 * @param string $value All of the links to be displayed to the user.
     3292                 */
    27803293                return apply_filters( 'bp_get_activity_filter_links', implode( "\n", $component_links ) );
    27813294        }
    27823295
     
    27833296/**
    27843297 * Determine if a comment can be made on an activity item.
    27853298 *
    2786  * @since BuddyPress (1.2)
     3299 * @since BuddyPress (1.2.0)
    27873300 *
    27883301 * @global object $activities_template {@link BP_Activity_Template}
    27893302 * @uses bp_get_activity_action_name()
     
    28173330                        break;
    28183331        }
    28193332
     3333        /**
     3334         * Filters whether a comment can be made on an activity item.
     3335         *
     3336         * @since BuddyPress (1.5.0)
     3337         *
     3338         * @param bool   $can_comment Status on if activity can be commented on.
     3339         * @param string $activity_action Current activity action being checked on.
     3340         */
    28203341        return apply_filters( 'bp_activity_can_comment', $can_comment, $activity_action );
    28213342}
    28223343
     
    28563377                }
    28573378        }
    28583379
     3380        /**
     3381         * Filters whether a comment can be made on an activity reply item.
     3382         *
     3383         * @since BuddyPress (1.5.0)
     3384         *
     3385         * @param bool   $can_comment Status on if activity reply can be commented on.
     3386         * @param string $comment Current comment being checked on.
     3387         */
    28593388        return (bool) apply_filters( 'bp_activity_can_comment_reply', $can_comment, $comment );
    28603389}
    28613390
    28623391/**
    2863  * Determine if an favorites are allowed.
     3392 * Determine if favorites are allowed.
    28643393 *
    28653394 * Defaults to true, but can be modified by plugins.
    28663395 *
    2867  * @since BuddyPress (1.5)
     3396 * @since BuddyPress (1.5.0)
    28683397 *
    28693398 * @uses apply_filters() To call the 'bp_activity_can_favorite' hook.
    28703399 *
     
    28713400 * @return bool True if comment can receive comments.
    28723401 */
    28733402function bp_activity_can_favorite() {
     3403
     3404        /**
     3405         * Filters whether or not users can favorite activity items.
     3406         *
     3407         * @since BuddyPress (1.5.0)
     3408         *
     3409         * @param bool $value Whether or not users can currently favorite.
     3410         */
    28743411        return apply_filters( 'bp_activity_can_favorite', true );
    28753412}
    28763413
     
    28773414/**
    28783415 * Output the total favorite count for a specified user.
    28793416 *
    2880  * @since BuddyPress (1.2)
     3417 * @since BuddyPress (1.2.0)
    28813418 *
    28823419 * @see bp_get_total_favorite_count_for_user() for description of parameters.
    28833420 * @uses bp_get_total_favorite_count_for_user()
     
    28913428        /**
    28923429         * Return the total favorite count for a specified user.
    28933430         *
    2894          * @since BuddyPress (1.2)
     3431         * @since BuddyPress (1.2.0)
    28953432         *
    28963433         * @uses bp_activity_total_favorites_for_user()
    28973434         * @uses apply_filters() To call the 'bp_get_total_favorite_count_for_user' hook
     
    29113448                        ? bp_activity_total_favorites_for_user( $user_id )
    29123449                        : false;
    29133450
     3451                /**
     3452                 * Filters the total favorite count for a user.
     3453                 *
     3454                 * @since BuddyPress (1.2.0)
     3455                 *
     3456                 * @param int|bool $retval Total favorite count for a user. False on no favorites.
     3457                 */
    29143458                return apply_filters( 'bp_get_total_favorite_count_for_user', $retval );
    29153459        }
    29163460
     
    29183462/**
    29193463 * Output the total mention count for a specified user.
    29203464 *
    2921  * @since BuddyPress (1.2)
     3465 * @since BuddyPress (1.2.0)
    29223466 *
    29233467 * @see bp_get_total_mention_count_for_user() for description of parameters.
    29243468 * @uses bp_get_total_favorite_count_for_user()
     
    29323476        /**
    29333477         * Return the total mention count for a specified user.
    29343478         *
    2935          * @since BuddyPress (1.2)
     3479         * @since BuddyPress (1.2.0)
    29363480         *
    29373481         * @uses bp_get_user_meta()
    29383482         * @uses apply_filters() To call the 'bp_get_total_mention_count_for_user' hook.
     
    29523496                        ? bp_get_user_meta( $user_id, 'bp_new_mention_count', true )
    29533497                        : false;
    29543498
     3499                /**
     3500                 * Filters the total mention count for a user.
     3501                 *
     3502                 * @since BuddyPress (1.2.0)
     3503                 *
     3504                 * @param int|bool $retval Total mention count for a user. False on no mentions.
     3505                 */
    29553506                return apply_filters( 'bp_get_total_mention_count_for_user', $retval );
    29563507        }
    29573508
     
    29583509/**
    29593510 * Output the public message link for displayed user.
    29603511 *
    2961  * @since BuddyPress (1.2)
     3512 * @since BuddyPress (1.2.0)
    29623513 *
    29633514 * @uses bp_get_send_public_message_link()
    29643515 */
     
    29693520        /**
    29703521         * Return the public message link for the displayed user.
    29713522         *
    2972          * @since BuddyPress (1.2)
     3523         * @since BuddyPress (1.2.0)
    29733524         *
    29743525         * @uses is_user_logged_in()
    29753526         * @uses bp_is_my_profile()
     
    29913542                        $retval = wp_nonce_url( $url );
    29923543                }
    29933544
     3545                /**
     3546                 * Filters the public message link for the displayed user.
     3547                 *
     3548                 * @since BuddyPress (1.2.0)
     3549                 *
     3550                 * @param string $retval The URL for the public message link.
     3551                 */
    29943552                return apply_filters( 'bp_get_send_public_message_link', $retval );
    29953553        }
    29963554
     
    30243582/**
    30253583 * Output the mentioned user display name.
    30263584 *
    3027  * @since BuddyPress (1.2)
     3585 * @since BuddyPress (1.2.0)
    30283586 *
    30293587 * @see bp_get_mentioned_user_display_name() for description of parameters.
    30303588 * @uses bp_get_mentioned_user_display_name()
     
    30383596        /**
    30393597         * Returns the mentioned user display name
    30403598         *
    3041          * @since BuddyPress (1.2)
     3599         * @since BuddyPress (1.2.0)
    30423600         *
    30433601         * @uses bp_core_get_user_displayname()
    30443602         * @uses apply_filters() To call the 'bp_get_mentioned_user_display_name' hook.
     
    30563614                        $name = __( 'a user', 'buddypress' );
    30573615                }
    30583616
     3617                /**
     3618                 * Filters the mentioned user display name.
     3619                 *
     3620                 * @since BuddyPress (1.2.0)
     3621                 *
     3622                 * @param string     $name Display name for the mentioned user.
     3623                 * @param int|string $user_id_or_username User ID or username use for query.
     3624                 */
    30593625                return apply_filters( 'bp_get_mentioned_user_display_name', $name, $user_id_or_username );
    30603626        }
    30613627
     
    30623628/**
    30633629 * Output button for sending a public message (an @-mention).
    30643630 *
    3065  * @since BuddyPress (1.2)
     3631 * @since BuddyPress (1.2.0)
    30663632 *
    30673633 * @see bp_get_send_public_message_button() for description of parameters.
    30683634 * @uses bp_get_send_public_message_button()
     
    30763642        /**
    30773643         * Return button for sending a public message (an @-mention).
    30783644         *
    3079          * @since BuddyPress (1.2)
     3645         * @since BuddyPress (1.2.0)
    30803646         *
    30813647         * @uses bp_get_send_public_message_link()
    30823648         * @uses wp_parse_args()
     
    31143680                        'link_class'        => 'activity-button mention'
    31153681                ) );
    31163682
    3117                 // Filter and return the HTML button
     3683                /**
     3684                 * Filters the public message button HTML.
     3685                 *
     3686                 * @since BuddyPress (1.2.10)
     3687                 *
     3688                 * @param array $r Array of arguments for the public message button HTML.
     3689                 */
    31183690                return bp_get_button( apply_filters( 'bp_get_send_public_message_button', $r ) );
    31193691        }
    31203692
     
    31213693/**
    31223694 * Output the activity post form action.
    31233695 *
    3124  * @since BuddyPress (1.2)
     3696 * @since BuddyPress (1.2.0)
    31253697 *
    31263698 * @uses bp_get_activity_post_form_action()
    31273699 */
     
    31323704        /**
    31333705         * Return the activity post form action.
    31343706         *
    3135          * @since BuddyPress (1.2)
     3707         * @since BuddyPress (1.2.0)
    31363708         *
    31373709         * @uses home_url()
    31383710         * @uses bp_get_activity_root_slug()
     
    31413713         * @return string The activity post form action.
    31423714         */
    31433715        function bp_get_activity_post_form_action() {
     3716
     3717                /**
     3718                 * Filters the action url used for the activity post form.
     3719                 *
     3720                 * @since BuddyPress (1.2.0)
     3721                 *
     3722                 * @param string $value URL to be used for the activity post form.
     3723                 */
    31443724                return apply_filters( 'bp_get_activity_post_form_action', home_url( bp_get_activity_root_slug() . '/post/' ) );
    31453725        }
    31463726
     
    31523732 * Avatars are wrapped in <li> elements, but you've got to provide your own
    31533733 * <ul> or <ol> wrapper markup.
    31543734 *
    3155  * @since BuddyPress (1.7)
     3735 * @since BuddyPress (1.7.0)
    31563736 *
    31573737 * @see bp_core_fetch_avatar() for a description of arguments.
    31583738 *
     
    32043784                }
    32053785        }
    32063786
     3787        /**
     3788         * Filters the list of linked avatars for users who have commented on the current activity item.
     3789         *
     3790         * @since BuddyPress (1.7.0)
     3791         *
     3792         * @param string $retval HTML markup for the list of avatars.
     3793         * @param array  $r Array of arguments used for each avatar.
     3794         * @param array  $output Array of each avatar found, before imploded into single string.
     3795         */
    32073796        echo apply_filters( 'bp_activity_comments_user_avatars', $retval, $r, $output );
    32083797}
    32093798
     
    32103799/**
    32113800 * Return the IDs of every user who's left a comment on the current activity item.
    32123801 *
    3213  * @since BuddyPress (1.7)
     3802 * @since BuddyPress (1.7.0)
    32143803 *
    32153804 * @return bool|array An array of IDs, or false if none are found.
    32163805 */
     
    32213810                ? (array) bp_activity_recurse_comments_user_ids( $activities_template->activity->children )
    32223811                : array();
    32233812
     3813        /**
     3814         * Filters the list of user IDs for the current activity item.
     3815         *
     3816         * @since BuddyPress (1.7.0)
     3817         *
     3818         * @param array $value Array of unique user IDs for the current activity item.
     3819         */
    32243820        return apply_filters( 'bp_activity_get_comments_user_ids', array_unique( $user_ids ) );
    32253821}
    32263822
     
    32273823        /**
    32283824         * Recurse through all activity comments and collect the IDs of the users who wrote them.
    32293825         *
    3230          * @since BuddyPress (1.7)
     3826         * @since BuddyPress (1.7.0)
    32313827         *
    32323828         * @param array $comments Array of {@link BP_Activity_Activity} items.
    32333829         * @return array Array of user IDs.
     
    32573853                        }
    32583854                }
    32593855
    3260                 // Filter and return
     3856                /**
     3857                 * Filters the list of user IDs for the current activity comment item.
     3858                 *
     3859                 * @since BuddyPress (2.1.0)
     3860                 *
     3861                 * @param array $user_ids Array of user IDs for the current activity comment item.
     3862                 * @param array $comments Array of comments being checked for user IDs.
     3863                 */
    32613864                return apply_filters( 'bp_activity_recurse_comments_user_ids', $user_ids, $comments );
    32623865        }
    32633866
     
    32773880         * @return string Mentionname for the displayed user, if available.
    32783881         */
    32793882        function bp_get_displayed_user_mentionname() {
     3883
     3884                /**
     3885                 * Filters the mentionname for the displayed user.
     3886                 *
     3887                 * @since BuddyPress (1.9.0)
     3888                 *
     3889                 * @param string $value The mentionanme for the displayed user.
     3890                 */
    32803891                return apply_filters( 'bp_get_displayed_user_mentionname', bp_activity_get_user_mentionname( bp_displayed_user_id() ) );
    32813892        }
    32823893
     
    32833894/**
    32843895 * Echo a list of all registered activity types for use in dropdowns or checkbox lists.
    32853896 *
    3286  * @since BuddyPress (1.7)
     3897 * @since BuddyPress (1.7.0)
    32873898 *
    32883899 * @param string $output Optional. Either 'select' or 'checkbox'. Default: 'select'.
    32893900 * @param array $args {
     
    33213932                                break;
    33223933                }
    33233934
    3324                 // Allow custom markup
     3935                /**
     3936                 * Fires at the end of the listing of activity types.
     3937                 *
     3938                 * This is a variable action hook. The actual hook to use will depend on the output type specified. Two default hooks are bp_activity_types_list_select and bp_activity_types_list_checkbox.
     3939                 *
     3940                 * @since BuddyPress (1.7.0)
     3941                 *
     3942                 * @param array  $args Array of arguments passed into function.
     3943                 * @param string $type Activity type being rendered in the output.
     3944                 * @param string $description Description of the activity type being rendered.
     3945                 */
    33253946                do_action( 'bp_activity_types_list_' . $output, $args, $type, $description );
    33263947        }
    33273948
     
    33373958/**
    33383959 * Output the sitewide activity feed link.
    33393960 *
    3340  * @since BuddyPress (1.0)
     3961 * @since BuddyPress (1.0.0)
    33413962 *
    33423963 * @uses bp_get_sitewide_activity_feed_link()
    33433964 */
     
    33483969        /**
    33493970         * Returns the sitewide activity feed link.
    33503971         *
    3351          * @since BuddyPress (1.0)
     3972         * @since BuddyPress (1.0.0)
    33523973         *
    33533974         * @uses home_url()
    33543975         * @uses bp_get_activity_root_slug()
     
    33573978         * @return string The sitewide activity feed link.
    33583979         */
    33593980        function bp_get_sitewide_activity_feed_link() {
     3981
     3982                /**
     3983                 * Filters the sidewide activity feed link.
     3984                 *
     3985                 * @since BuddyPress (1.0.0)
     3986                 *
     3987                 * @param string $value The feed link for sitewide activity.
     3988                 */
    33603989                return apply_filters( 'bp_get_sitewide_activity_feed_link', bp_get_root_domain() . '/' . bp_get_activity_root_slug() . '/feed/' );
    33613990        }
    33623991
     
    33633992/**
    33643993 * Output the member activity feed link.
    33653994 *
    3366  * @since BuddyPress (1.2)
     3995 * @since BuddyPress (1.2.0)
    33673996 *
    33683997 * @uses bp_get_member_activity_feed_link()
    33693998 */
     
    33744003/**
    33754004 * Output the member activity feed link.
    33764005 *
    3377  * @since BuddyPress (1.0)
    3378  * @deprecated BuddyPress (1.2)
     4006 * @since BuddyPress (1.0.0)
     4007 * @deprecated BuddyPress (1.2.0)
    33794008 *
    33804009 * @todo properly deprecate in favor of bp_member_activity_feed_link().
    33814010 *
     
    33864015        /**
    33874016         * Return the member activity feed link.
    33884017         *
    3389          * @since BuddyPress (1.2)
     4018         * @since BuddyPress (1.2.0)
    33904019         *
    33914020         * @uses bp_is_profile_component()
    33924021         * @uses bp_is_current_action()
     
    34264055                        $link = '';
    34274056                }
    34284057
     4058                /**
     4059                 * Filters the member activity feed link.
     4060                 *
     4061                 * @since BuddyPress (1.0.0)
     4062                 *
     4063                 * @param string $link URL for the member activity feed.
     4064                 */
    34294065                return apply_filters( 'bp_get_activities_member_rss_link', $link );
    34304066        }
    34314067
     
    34324068        /**
    34334069         * Return the member activity feed link.
    34344070         *
    3435          * @since BuddyPress (1.0)
    3436          * @deprecated BuddyPress (1.2)
     4071         * @since BuddyPress (1.0.0)
     4072         * @deprecated BuddyPress (1.2.0)
    34374073         *
    34384074         * @todo properly deprecate in favor of bp_get_member_activity_feed_link().
    34394075         *
     
    34494085/**
    34504086 * Outputs the activity feed item guid.
    34514087 *
    3452  * @since BuddyPress (1.0)
     4088 * @since BuddyPress (1.0.0)
    34534089 *
    34544090 * @uses bp_activity_feed_item_guid()
    34554091 */
     
    34604096        /**
    34614097         * Returns the activity feed item guid.
    34624098         *
    3463          * @since BuddyPress (1.2)
     4099         * @since BuddyPress (1.2.0)
    34644100         *
    34654101         * @global object $activities_template {@link BP_Activity_Template}
    34664102         * @uses apply_filters() To call the 'bp_get_activity_feed_item_guid' hook.
     
    34704106        function bp_get_activity_feed_item_guid() {
    34714107                global $activities_template;
    34724108
     4109                /**
     4110                 * Filters the activity feed item guid.
     4111                 *
     4112                 * @since BuddyPress (1.1.3)
     4113                 *
     4114                 * @param string $value Calculated md5 value for the activity feed item.
     4115                 */
    34734116                return apply_filters( 'bp_get_activity_feed_item_guid', md5( $activities_template->activity->date_recorded . '-' . $activities_template->activity->content ) );
    34744117        }
    34754118
     
    34764119/**
    34774120 * Output the activity feed item title.
    34784121 *
    3479  * @since BuddyPress (1.0)
     4122 * @since BuddyPress (1.0.0)
    34804123 *
    34814124 * @uses bp_get_activity_feed_item_title()
    34824125 */
     
    34874130        /**
    34884131         * Return the activity feed item title.
    34894132         *
    3490          * @since BuddyPress (1.0)
     4133         * @since BuddyPress (1.0.0)
    34914134         *
    34924135         * @global object $activities_template {@link BP_Activity_Template}
    34934136         * @uses ent2ncr()
     
    35174160                        $title .= ': ' . strip_tags( ent2ncr( trim( convert_chars( bp_create_excerpt( $activities_template->activity->content, 70, array( 'ending' => " [&#133;]" ) ) ) ) ) );
    35184161                }
    35194162
     4163                /**
     4164                 * Filters the activity feed item title.
     4165                 *
     4166                 * @since BuddyPress (1.0.0)
     4167                 *
     4168                 * @param string $title The title for the activity feed item.
     4169                 */
    35204170                return apply_filters( 'bp_get_activity_feed_item_title', $title );
    35214171        }
    35224172
     
    35234173/**
    35244174 * Output the activity feed item link
    35254175 *
    3526  * @since BuddyPress (1.0)
     4176 * @since BuddyPress (1.0.0)
    35274177 *
    35284178 * @uses bp_get_activity_feed_item_link()
    35294179 */
     
    35344184        /**
    35354185         * Return the activity feed item link
    35364186         *
    3537          * @since BuddyPress (1.0)
     4187         * @since BuddyPress (1.0.0)
    35384188         *
    35394189         * @global object $activities_template {@link BP_Activity_Template}
    35404190         * @uses apply_filters() To call the 'bp_get_activity_feed_item_link' hook.
     
    35484198                        ? $activities_template->activity->primary_link
    35494199                        : '';
    35504200
     4201                /**
     4202                 * Filters the activity feed item link.
     4203                 *
     4204                 * @since BuddyPress (1.0.0)
     4205                 *
     4206                 * @param string $retval The URL for the activity feed item.
     4207                 */
    35514208                return apply_filters( 'bp_get_activity_feed_item_link', $retval );
    35524209        }
    35534210
     
    35544211/**
    35554212 * Output the activity feed item date.
    35564213 *
    3557  * @since BuddyPress (1.0)
     4214 * @since BuddyPress (1.0.0)
    35584215 *
    35594216 * @uses bp_get_activity_feed_item_date()
    35604217 */
     
    35654222        /**
    35664223         * Return the activity feed item date.
    35674224         *
    3568          * @since BuddyPress (1.0)
     4225         * @since BuddyPress (1.0.0)
    35694226         *
    35704227         * @global object $activities_template {@link BP_Activity_Template}
    35714228         * @uses apply_filters() To call the 'bp_get_activity_feed_item_date' hook.
     
    35794236                        ? $activities_template->activity->date_recorded
    35804237                        : '';
    35814238
     4239                /**
     4240                 * Filters the activity feed item date.
     4241                 *
     4242                 * @since BuddyPress (1.0.0)
     4243                 *
     4244                 * @param string $retval The date for the activity feed item.
     4245                 */
    35824246                return apply_filters( 'bp_get_activity_feed_item_date', $retval );
    35834247        }
    35844248
     
    35854249/**
    35864250 * Output the activity feed item description.
    35874251 *
    3588  * @since BuddyPress (1.0)
     4252 * @since BuddyPress (1.0.0)
    35894253 *
    35904254 * @uses bp_get_activity_feed_item_description()
    35914255 */
     
    35964260        /**
    35974261         * Return the activity feed item description.
    35984262         *
    3599          * @since BuddyPress (1.0)
     4263         * @since BuddyPress (1.0.0)
    36004264         *
    36014265         * @global object $activities_template {@link BP_Activity_Template}
    36024266         * @uses ent2ncr()
     
    36184282                        $content = ent2ncr( convert_chars( str_replace( '%s', '', $content ) ) );
    36194283                }
    36204284
     4285                /**
     4286                 * Filters the activity feed item description.
     4287                 *
     4288                 * @since BuddyPress (1.0.0)
     4289                 *
     4290                 * @param string $content The description for the activity feed item.
     4291                 */
    36214292                return apply_filters( 'bp_get_activity_feed_item_description', $content );
    36224293        }
    36234294
     
    36244295/**
    36254296 * Template tag so we can hook activity feed to <head>.
    36264297 *
    3627  * @since BuddyPress (1.5)
     4298 * @since BuddyPress (1.5.0)
    36284299 *
    36294300 * @uses bloginfo()
    36304301 * @uses bp_sitewide_activity_feed_link()
     
    37024373                }
    37034374
    37044375                /**
    3705                  * Modify the filter options available in the activity filter dropdown.
     4376                 * Filters the options available in the activity filter dropdown.
    37064377                 *
    3707                  * @since BuddyPress (2.1.0)
     4378                 * @since BuddyPress (2.2.0)
    37084379                 *
    3709                  * @param array $filters Array of filter options for the given
    3710                  *        context, in the following format:
    3711                  *            $option_value => $option_name
    3712                  * @param string $context Context for the filter. 'activity'
    3713                  *        'member', 'member_groups', 'group'.
     4380                 * @param array $filters Array of filter options for the given context, in the following format: $option_value => $option_name.
     4381                 * @param string $context Context for the filter. 'activity', 'member', 'member_groups', 'group'.
    37144382                 */
    37154383                $filters = apply_filters( 'bp_get_activity_show_filters_options', $filters, $context );
    37164384
     
    37234391                        }
    37244392                }
    37254393
     4394                /**
     4395                 * Filters the HTML markup result for the activity filter dropdown.
     4396                 *
     4397                 * @since BuddyPress (2.1.0)
     4398                 *
     4399                 * @param string $output HTML output for the activity filter dropdown.
     4400                 * @param array  $filters Array of filter options for the given context, in the following format: $option_value => $option_name.
     4401                 * @param string $context Context for the filter. 'activity', 'member', 'member_groups', 'group'.
     4402                 */
    37264403                return apply_filters( 'bp_get_activity_show_filters', $output, $filters, $context );
    37274404        }