Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
05/29/2016 06:12:08 PM (6 years ago)
Author:
djpaul
Message:

Remove redundant @uses PHPDoc tag from inline documentation.

Per WordPress' inline documentation standards, the @uses tag is not recommended to be used to indicate a used-by relationship, as this information can be derived through other means. These tags also are very likely to become out-of-date as our functions change over time.

File:
1 edited

Legend:

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

    r10824 r10825  
    2020 * @since 1.5.0
    2121 *
    22  * @uses bp_get_activity_slug()
    2322 */
    2423function bp_activity_slug() {
     
    3029     * @since 1.5.0
    3130     *
    32      * @uses apply_filters() To call the 'bp_get_activity_slug' hook.
    3331     *
    3432     * @return string The activity component slug.
     
    5149 * @since 1.5.0
    5250 *
    53  * @uses bp_get_activity_root_slug()
    5451 */
    5552function bp_activity_root_slug() {
     
    6158     * @since 1.5.0
    6259     *
    63      * @uses apply_filters() To call the 'bp_get_activity_root_slug' hook.
    6460     *
    6561     * @return string The activity component root slug.
     
    8278 * @since 1.5.0
    8379 *
    84  * @uses bp_get_activity_directory_permalink()
    8580 */
    8681function bp_activity_directory_permalink() {
     
    9287     * @since 1.5.0
    9388     *
    94      * @uses trailingslashit()
    95      * @uses bp_get_root_domain()
    96      * @uses bp_get_activity_root_slug()
    97      * @uses apply_filters() To call the 'bp_get_activity_directory_permalink' hook.
    9889     *
    9990     * @return string Activity directory permalink.
     
    122113 *
    123114 * @global object $activities_template {@link BP_Activity_Template}
    124  * @uses groups_is_user_member()
    125  * @uses bp_current_action()
    126  * @uses bp_is_current_action()
    127  * @uses bp_get_activity_slug()
    128  * @uses bp_action_variable()
    129  * @uses wp_parse_args()
    130  * @uses bp_is_active()
    131  * @uses friends_get_friend_user_ids()
    132  * @uses groups_get_user_groups()
    133  * @uses bp_activity_get_user_favorites()
    134  * @uses apply_filters() To call the 'bp_has_activities' hook.
    135115 *
    136116 * @param array|string $args {
     
    391371 *
    392372 * @global object $activities_template {@link BP_Activity_Template}
    393  * @uses BP_Activity_Template::user_activities() {@link BP_Activity_Template::user_activities()}
    394373 *
    395374 * @return bool Returns true when activities are found.
     
    406385 *
    407386 * @global object $activities_template {@link BP_Activity_Template}
    408  * @uses BP_Activity_Template::the_activity() {@link BP_Activity_Template::the_activity()}
    409387 *
    410388 * @return object The current activity within the loop.
     
    454432 *
    455433 * @global object $activities_template {@link BP_Activity_Template}
    456  * @uses BP_Activity_Template::the_activity() {@link BP_Activity_Template::the_activity()}
    457434 */
    458435function bp_activity_pagination_count() {
     
    466443     *
    467444     * @global object $activities_template {@link BP_Activity_Template}
    468      * @uses bp_core_number_format()
    469445     *
    470446     * @return string The pagination text.
     
    492468 * @since 1.0.0
    493469 *
    494  * @uses bp_get_activity_pagination_links()
    495470 */
    496471function bp_activity_pagination_links() {
     
    504479     *
    505480     * @global object $activities_template {@link BP_Activity_Template}
    506      * @uses apply_filters() To call the 'bp_get_activity_pagination_links' hook.
    507481     *
    508482     * @return string The pagination links.
     
    527501 *
    528502 * @global object $activities_template {@link BP_Activity_Template}
    529  * @uses apply_filters() To call the 'bp_activity_has_more_items' hook.
    530503 *
    531504 * @return bool $has_more_items True if more items, false if not.
     
    561534 * @since 1.2.0
    562535 *
    563  * @uses bp_get_activity_count()
    564536 */
    565537function bp_activity_count() {
     
    573545     *
    574546     * @global object $activities_template {@link BP_Activity_Template}
    575      * @uses apply_filters() To call the 'bp_get_activity_count' hook.
    576547     *
    577548     * @return int The activity count.
     
    595566 * @since 1.2.0
    596567 *
    597  * @uses bp_get_activity_per_page()
    598568 */
    599569function bp_activity_per_page() {
     
    607577     *
    608578     * @global object $activities_template {@link BP_Activity_Template}
    609      * @uses apply_filters() To call the 'bp_get_activity_per_page' hook.
    610579     *
    611580     * @return int The activities per page.
     
    629598 * @since 1.0.0
    630599 *
    631  * @uses bp_get_activities_title()
    632600 * @todo Deprecate.
    633601 */
     
    642610     *
    643611     * @global string $bp_activity_title
    644      * @uses apply_filters() To call the 'bp_get_activities_title' hook.
    645612     * @todo Deprecate.
    646613     *
     
    665632 * @since 1.0.0
    666633 *
    667  * @uses bp_get_activities_no_activity()
    668634 * @todo Deprecate.
    669635 */
     
    678644     *
    679645     * @global string $bp_activity_no_activity
    680      * @uses apply_filters() To call the 'bp_get_activities_no_activity' hook.
    681646     * @todo Deprecate.
    682647     *
     
    701666 * @since 1.2.0
    702667 *
    703  * @uses bp_get_activity_id()
    704668 */
    705669function bp_activity_id() {
     
    713677     *
    714678     * @global object $activities_template {@link BP_Activity_Template}
    715      * @uses apply_filters() To call the 'bp_get_activity_id' hook.
    716679     *
    717680     * @return int The activity ID.
     
    735698 * @since 1.2.0
    736699 *
    737  * @uses bp_get_activity_item_id()
    738700 */
    739701function bp_activity_item_id() {
     
    747709     *
    748710     * @global object $activities_template {@link BP_Activity_Template}
    749      * @uses apply_filters() To call the 'bp_get_activity_item_id' hook.
    750711     *
    751712     * @return int The activity item ID.
     
    769730 * @since 1.2.0
    770731 *
    771  * @uses bp_get_activity_secondary_item_id()
    772732 */
    773733function bp_activity_secondary_item_id() {
     
    781741     *
    782742     * @global object $activities_template {@link BP_Activity_Template}
    783      * @uses apply_filters() To call the 'bp_get_activity_secondary_item_id' hook.
    784743     *
    785744     * @return int The activity secondary item ID.
     
    803762 * @since 1.2.0
    804763 *
    805  * @uses bp_get_activity_date_recorded()
    806764 */
    807765function bp_activity_date_recorded() {
     
    815773     *
    816774     * @global object $activities_template {@link BP_Activity_Template}
    817      * @uses apply_filters() To call the 'bp_get_activity_date_recorded' hook.
    818775     *
    819776     * @return string The date the activity was recorded.
     
    837794 * @since 2.1.0
    838795 *
    839  * @uses bp_get_activity_member_display_name()
    840796 */
    841797function bp_activity_member_display_name() {
     
    849805     *
    850806     * @global object $activities_template {@link BP_Activity_Template}
    851      * @uses apply_filters() To call the 'bp_get_activity_member_display_name' hook.
    852807     *
    853808     * @return string The date the activity was recorded.
     
    875830 * @since 1.2.0
    876831 *
    877  * @uses bp_get_activity_object_name()
    878832 */
    879833function bp_activity_object_name() {
     
    887841     *
    888842     * @global object $activities_template {@link BP_Activity_Template}
    889      * @uses apply_filters() To call the 'bp_get_activity_object_name' hook.
    890843     *
    891844     * @return string The activity object name.
     
    909862 * @since 1.2.0
    910863 *
    911  * @uses bp_get_activity_type()
    912864 */
    913865function bp_activity_type() {
     
    921873     *
    922874     * @global object $activities_template {@link BP_Activity_Template}
    923      * @uses apply_filters() To call the 'bp_get_activity_type' hook.
    924875     *
    925876     * @return string The activity type.
     
    949900     *       remove redundant echo
    950901     *
    951      * @uses bp_activity_type()
    952902     */
    953903    function bp_activity_action_name() { echo bp_activity_type(); }
     
    963913     * @todo Properly deprecate in favor of bp_get_activity_type().
    964914     *
    965      * @uses bp_get_activity_type()
    966915     *
    967916     * @return string The activity type.
     
    974923 * @since 1.1.0
    975924 *
    976  * @uses bp_get_activity_user_id()
    977925 */
    978926function bp_activity_user_id() {
     
    986934     *
    987935     * @global object $activities_template {@link BP_Activity_Template}
    988      * @uses apply_filters() To call the 'bp_get_activity_user_id' hook.
    989936     *
    990937     * @return int The activity user ID.
     
    1008955 * @since 1.2.0
    1009956 *
    1010  * @uses bp_get_activity_user_link()
    1011957 */
    1012958function bp_activity_user_link() {
     
    1020966     *
    1021967     * @global object $activities_template {@link BP_Activity_Template}
    1022      * @uses bp_core_get_user_domain()
    1023      * @uses apply_filters() To call the 'bp_get_activity_user_link' hook.
    1024968     *
    1025969     * @return string $link The activity user link.
     
    1050994 *
    1051995 * @see bp_get_activity_avatar() for description of arguments.
    1052  * @uses bp_get_activity_avatar()
    1053996 *
    1054997 * @param array|string $args See {@link bp_get_activity_avatar()} for description.
     
    10641007     * @see bp_core_fetch_avatar() For a description of the arguments.
    10651008     * @global object $activities_template {@link BP_Activity_Template}
    1066      * @uses bp_is_single_activity()
    1067      * @uses wp_parse_args()
    1068      * @uses apply_filters() To call the 'bp_get_activity_avatar_object_' . $current_activity_item->component hook.
    1069      * @uses apply_filters() To call the 'bp_get_activity_avatar_item_id' hook.
    1070      * @uses bp_core_fetch_avatar()
    1071      * @uses apply_filters() To call the 'bp_get_activity_avatar' hook.
    10721009     *
    10731010     * @param array|string $args  {
     
    11851122 *
    11861123 * @see bp_get_activity_secondary_avatar() for description of arguments.
    1187  * @uses bp_get_activity_secondary_avatar()
    11881124 *
    11891125 * @param array|string $args See {@link bp_get_activity_secondary_avatar} for description.
     
    12001136     * @see bp_core_fetch_avatar() for description of arguments.
    12011137     * @global object $activities_template {@link BP_Activity_Template}
    1202      * @uses wp_parse_args()
    1203      * @uses get_blog_option()
    1204      * @uses apply_filters() To call the 'bp_get_activity_secondary_avatar_object_' . $activities_template->activity->component hook.
    1205      * @uses apply_filters() To call the 'bp_get_activity_secondary_avatar_item_id' hook.
    1206      * @uses bp_core_fetch_avatar()
    1207      * @uses apply_filters() To call the 'bp_get_activity_secondary_avatar' hook.
    12081138     *
    12091139     * @param array|string $args  {
     
    13761306 *
    13771307 * @param array $args See bp_get_activity_action().
    1378  * @uses bp_get_activity_action()
    13791308 */
    13801309function bp_activity_action( $args = array() ) {
     
    13881317     *
    13891318     * @global object $activities_template {@link BP_Activity_Template}
    1390      * @uses apply_filters_ref_array() To call the 'bp_get_activity_action_pre_meta' hook.
    1391      * @uses bp_insert_activity_meta()
    1392      * @uses apply_filters_ref_array() To call the 'bp_get_activity_action' hook.
    13931319     *
    13941320     * @param array $args {
     
    14421368 * @since 1.2.0
    14431369 *
    1444  * @uses bp_get_activity_content_body()
    14451370 */
    14461371function bp_activity_content_body() {
     
    14541379     *
    14551380     * @global object $activities_template {@link BP_Activity_Template}
    1456      * @uses bp_insert_activity_meta()
    1457      * @uses apply_filters_ref_array() To call the 'bp_get_activity_content_body' hook.
    14581381     *
    14591382     * @return string The activity content body.
     
    15041427 * @todo properly deprecate this function.
    15051428 *
    1506  * @uses bp_get_activity_content()
    15071429 */
    15081430function bp_activity_content() {
     
    15181440     * @todo properly deprecate this function.
    15191441     *
    1520      * @uses bp_get_activity_action()
    1521      * @uses bp_get_activity_content_body()
    1522      * @uses apply_filters() To call the 'bp_get_activity_content' hook.
    15231442     *
    15241443     * @return string The activity content.
     
    15451464 *
    15461465 * @global object $activities_template {@link BP_Activity_Template}
    1547  * @uses bp_core_time_since()
    1548  * @uses apply_filters_ref_array() To call the 'bp_activity_time_since' hook.
    1549  * @uses bp_is_single_activity()
    1550  * @uses bp_activity_get_permalink()
    1551  * @uses esc_attr__()
    1552  * @uses apply_filters_ref_array() To call the 'bp_activity_permalink' hook.
    1553  * @uses apply_filters() To call the 'bp_insert_activity_meta' hook.
    15541466 *
    15551467 * @param string $content The activity content.
     
    16211533 *
    16221534 * @global object $activities_template {@link BP_Activity_Template}
    1623  * @uses apply_filters() To call the 'bp_activity_user_can_delete' hook.
    16241535 *
    16251536 * @param object|bool $activity Optional. Falls back on the current item in the loop.
     
    16801591 *
    16811592 * @see bp_get_activity_parent_content() for a description of arguments.
    1682  * @uses bp_get_activity_parent_content()
    16831593 *
    16841594 * @param array|string $args See {@link bp_get_activity_parent_content} for description.
     
    16941604     *
    16951605     * @global object $activities_template {@link BP_Activity_Template}
    1696      * @uses apply_filters() To call the 'bp_get_activity_parent_content' hook.
    16971606     *
    16981607     * @param string $args Unused. Left over from an earlier implementation.
     
    18011710 * @since 1.2.0
    18021711 *
    1803  * @uses bp_get_activity_is_favorite()
    18041712 */
    18051713function bp_activity_is_favorite() {
     
    18131721     *
    18141722     * @global object $activities_template {@link BP_Activity_Template}
    1815      * @uses apply_filters() To call the 'bp_get_activity_is_favorite' hook.
    18161723     *
    18171724     * @return bool True if user favorite, false otherwise.
     
    18531760     *
    18541761     * @global object $activities_template {@link BP_Activity_Template}
    1855      * @uses bp_activity_recurse_comments()
    18561762     *
    18571763     * @param string $args Unused. Left over from an earlier implementation.
     
    18771783         *
    18781784         * @global object $activities_template {@link BP_Activity_Template}
    1879          * @uses locate_template()
    18801785         *
    18811786         * @param object $comment The activity object currently being recursed.
     
    19371842 *
    19381843 * @global object $activities_template {@link BP_Activity_Template}
    1939  * @uses apply_filters() To call the 'bp_activity_current_comment' hook.
    19401844 *
    19411845 * @return object|bool $current_comment The activity comment currently being
     
    19651869 * @since 1.5.0
    19661870 *
    1967  * @uses bp_get_activity_comment_id()
    19681871 */
    19691872function bp_activity_comment_id() {
     
    19771880     *
    19781881     * @global object $activities_template {@link BP_Activity_Template}
    1979      * @uses apply_filters() To call the 'bp_activity_comment_id' hook.
    19801882     *
    19811883     * @return int|bool $comment_id The ID of the activity comment currently
     
    20021904 * @since 1.5.0
    20031905 *
    2004  * @uses bp_get_activity_comment_user_id()
    20051906 */
    20061907function bp_activity_comment_user_id() {
     
    20141915     *
    20151916     * @global object $activities_template {@link BP_Activity_Template}
    2016      * @uses apply_filters() To call the 'bp_activity_comment_user_id' hook.
    20171917     *
    20181918     * @return int|bool $user_id The user_id of the author of the displayed
     
    20391939 * @since 1.5.0
    20401940 *
    2041  * @uses bp_get_activity_comment_user_link()
    20421941 */
    20431942function bp_activity_comment_user_link() {
     
    20501949     * @since 1.5.0
    20511950     *
    2052      * @uses bp_core_get_user_domain()
    2053      * @uses bp_get_activity_comment_user_id()
    2054      * @uses apply_filters() To call the 'bp_activity_comment_user_link' hook.
    20551951     *
    20561952     * @return string $user_link The URL of the activity comment author's profile.
     
    20741970 * @since 1.5.0
    20751971 *
    2076  * @uses bp_get_activity_comment_name()
    20771972 */
    20781973function bp_activity_comment_name() {
     
    20891984     *
    20901985     * @global object $activities_template {@link BP_Activity_Template}
    2091      * @uses apply_filters() To call the 'bp_acomment_name' hook.
    2092      * @uses apply_filters() To call the 'bp_activity_comment_name' hook.
    20931986     *
    20941987     * @return string $name The full name of the activity comment author.
     
    21192012 * @since 1.5.0
    21202013 *
    2121  * @uses bp_get_activity_comment_date_recorded()
    21222014 */
    21232015function bp_activity_comment_date_recorded() {
     
    21302022     * @since 1.5.0
    21312023     *
    2132      * @uses bp_core_time_since()
    2133      * @uses apply_filters() To call the 'bp_activity_comment_date_recorded' hook.
    21342024     *
    21352025     * @return string|bool $date_recorded Time since the activity was recorded,
     
    21532043 * @since 2.3.0
    21542044 *
    2155  * @uses bp_get_activity_comment_date_recorded()
    21562045 */
    21572046function bp_activity_comment_date_recorded_raw() {
     
    21652054     *
    21662055     * @global object $activities_template {@link BP_Activity_Template}
    2167      * @uses bp_core_time_since()
    2168      * @uses apply_filters() To call the 'bp_activity_comment_date_recorded' hook.
    21692056     *
    21702057     * @return string|bool $date_recorded Time since the activity was recorded,
     
    21892076 * @since 1.5.0
    21902077 *
    2191  * @uses bp_get_activity_comment_delete_link()
    21922078 */
    21932079function bp_activity_comment_delete_link() {
     
    22002086     * @since 1.5.0
    22012087     *
    2202      * @uses wp_nonce_url()
    2203      * @uses bp_get_root_domain()
    2204      * @uses bp_get_activity_slug()
    2205      * @uses bp_get_activity_comment_id()
    2206      * @uses apply_filters() To call the 'bp_activity_comment_delete_link' hook.
    22072088     *
    22082089     * @return string $link The nonced URL for deleting the current
     
    22272108 * @since 1.5.0
    22282109 *
    2229  * @uses bp_get_activity_comment_content()
    22302110 */
    22312111function bp_activity_comment_content() {
     
    22442124     *
    22452125     * @global object $activities_template {@link BP_Activity_Template}
    2246      * @uses apply_filters() To call the 'bp_get_activity_content' hook.
    2247      * @uses apply_filters() To call the 'bp_activity_comment_content' hook.
    22482126     *
    22492127     * @return string $content The content of the current activity comment.
     
    22702148 * @since 1.2.0
    22712149 *
    2272  * @uses bp_activity_get_comment_count()
    22732150 */
    22742151function bp_activity_comment_count() {
     
    22822159     *
    22832160     * @global object $activities_template {@link BP_Activity_Template}
    2284      * @uses bp_activity_recurse_comment_count()
    2285      * @uses apply_filters() To call the 'bp_activity_get_comment_count' hook.
    22862161     *
    22872162     * @param array|null $deprecated Deprecated.
     
    23192194         * @since 1.2.0
    23202195         *
    2321          * @uses bp_activity_recurse_comment_count()
    2322          * @uses apply_filters() To call the 'bp_activity_recurse_comment_count' hook.
    23232196         *
    23242197         * @param object $comment Activity comment object.
     
    23842257 * @since 1.2.0
    23852258 *
    2386  * @uses bp_get_activity_comment_link()
    23872259 */
    23882260function bp_activity_comment_link() {
     
    23962268     *
    23972269     * @global object $activities_template {@link BP_Activity_Template}
    2398      * @uses apply_filters() To call the 'bp_get_activity_comment_link' hook.
    23992270     *
    24002271     * @return string The activity comment link.
     
    24182289 * @since 1.2.0
    24192290 *
    2420  * @uses bp_get_activity_comment_form_nojs_display()
    24212291 */
    24222292function bp_activity_comment_form_nojs_display() {
     
    24492319 * @since 1.2.0
    24502320 *
    2451  * @uses bp_get_activity_comment_form_action()
    24522321 */
    24532322function bp_activity_comment_form_action() {
     
    24602329     * @since 1.2.0
    24612330     *
    2462      * @uses home_url()
    2463      * @uses bp_get_activity_root_slug()
    2464      * @uses apply_filters() To call the 'bp_get_activity_comment_form_action' hook.
    24652331     *
    24662332     * @return string The activity comment form action.
     
    24832349 * @since 1.2.0
    24842350 *
    2485  * @uses bp_get_activity_permalink_id()
    24862351 */
    24872352function bp_activity_permalink_id() {
     
    24942359     * @since 1.2.0
    24952360     *
    2496      * @uses apply_filters() To call the 'bp_get_activity_permalink_id' hook.
    24972361     *
    24982362     * @return string The activity permalink ID.
     
    25152379 * @since 1.2.0
    25162380 *
    2517  * @uses bp_get_activity_permalink_id()
    25182381 */
    25192382function bp_activity_thread_permalink() {
     
    25262389     * @since 1.2.0
    25272390     *
    2528      * @uses bp_activity_get_permalink()
    2529      * @uses apply_filters() To call the 'bp_get_activity_thread_permalink' hook.
    25302391     *
    25312392     * @return string $link The activity thread permalink.
     
    25512412 * @since 1.8.0
    25522413 *
    2553  * @uses bp_get_activity_permalink_id()
    25542414 */
    25552415function bp_activity_comment_permalink() {
     
    25612421     * @since 1.8.0
    25622422     *
    2563      * @uses bp_activity_get_permalink()
    2564      * @uses apply_filters() To call the 'bp_get_activity_comment_permalink' hook.
    25652423     *
    25662424     * @return string $link The activity comment permalink.
     
    25982456 * @since 1.2.0
    25992457 *
    2600  * @uses bp_get_activity_favorite_link()
    26012458 */
    26022459function bp_activity_favorite_link() {
     
    26102467     *
    26112468     * @global object $activities_template {@link BP_Activity_Template}
    2612      * @uses wp_nonce_url()
    2613      * @uses home_url()
    2614      * @uses bp_get_activity_root_slug()
    2615      * @uses apply_filters() To call the 'bp_get_activity_favorite_link' hook.
    26162469     *
    26172470     * @return string The activity favorite link.
     
    26352488 * @since 1.2.0
    26362489 *
    2637  * @uses bp_get_activity_unfavorite_link()
    26382490 */
    26392491function bp_activity_unfavorite_link() {
     
    26472499     *
    26482500     * @global object $activities_template {@link BP_Activity_Template}
    2649      * @uses wp_nonce_url()
    2650      * @uses home_url()
    2651      * @uses bp_get_activity_root_slug()
    2652      * @uses apply_filters() To call the 'bp_get_activity_unfavorite_link' hook.
    26532501     *
    26542502     * @return string The activity unfavorite link.
     
    26722520 * @since 1.0.0
    26732521 *
    2674  * @uses bp_get_activity_css_class()
    26752522 */
    26762523function bp_activity_css_class() {
     
    26842531     *
    26852532     * @global object $activities_template {@link BP_Activity_Template}
    2686      * @uses apply_filters() To call the 'bp_activity_mini_activity_types' hook.
    2687      * @uses bp_activity_get_comment_count()
    2688      * @uses bp_activity_can_comment()
    2689      * @uses apply_filters() To call the 'bp_get_activity_css_class' hook.
    26902533     *
    26912534     * @return string The activity item's CSS class.
     
    27352578 * @since 1.1.0
    27362579 *
    2737  * @uses bp_get_activity_delete_link()
    27382580 */
    27392581function bp_activity_delete_link() {
     
    27472589     *
    27482590     * @global object $activities_template {@link BP_Activity_Template}
    2749      * @uses bp_get_root_domain()
    2750      * @uses bp_get_activity_root_slug()
    2751      * @uses bp_is_activity_component()
    2752      * @uses bp_current_action()
    2753      * @uses wp_get_referer()
    2754      * @uses wp_nonce_url()
    2755      * @uses apply_filters() To call the 'bp_get_activity_delete_link' hook.
    27562591     *
    27572592     * @return string $link Activity delete link. Contains $redirect_to arg
     
    27852620 * @since 2.1.0
    27862621 *
    2787  * @uses bp_get_activity_delete_link()
    27882622 */
    27892623function bp_activity_delete_url() {
     
    27962630     *
    27972631     * @global object $activities_template {@link BP_Activity_Template}
    2798      * @uses bp_get_root_domain()
    2799      * @uses bp_get_activity_root_slug()
    2800      * @uses bp_is_activity_component()
    2801      * @uses bp_current_action()
    2802      * @uses add_query_arg()
    2803      * @uses wp_get_referer()
    2804      * @uses wp_nonce_url()
    2805      * @uses apply_filters() To call the 'bp_get_activity_delete_link' hook.
    28062632     *
    28072633     * @return string $link Activity delete link. Contains $redirect_to arg
     
    28362662 *
    28372663 * @see bp_get_activity_latest_update() for description of parameters.
    2838  * @uses bp_get_activity_latest_update()
    28392664 *
    28402665 * @param int $user_id See {@link bp_get_activity_latest_update()} for description.
     
    28492674     * @since 1.2.0
    28502675     *
    2851      * @uses bp_is_user_inactive()
    2852      * @uses bp_core_is_user_deleted()
    2853      * @uses bp_get_user_meta()
    2854      * @uses apply_filters() To call the 'bp_get_activity_latest_update_excerpt' hook.
    2855      * @uses bp_create_excerpt()
    2856      * @uses bp_get_root_domain()
    2857      * @uses bp_get_activity_root_slug()
    2858      * @uses apply_filters() To call the 'bp_get_activity_latest_update' hook.
    28592676     *
    28602677     * @param int $user_id If empty, will fall back on displayed user.
     
    29122729 *
    29132730 * @see bp_get_activity_filter_links() for description of parameters.
    2914  * @uses bp_get_activity_filter_links()
    29152731 *
    29162732 * @param array|bool $args See {@link bp_get_activity_filter_links()} for description.
     
    29252741     * @since 1.1.0
    29262742     *
    2927      * @uses wp_parse_args()
    2928      * @uses BP_Activity_Activity::get_recorded_components() {@link BP_Activity_Activity}
    2929      * @uses esc_attr()
    2930      * @uses add_query_arg()
    2931      * @uses remove_query_arg()
    2932      * @uses apply_filters() To call the 'bp_get_activity_filter_link_href' hook.
    2933      * @uses apply_filters() To call the 'bp_get_activity_filter_links' hook.
    29342743     *
    29352744     * @param array|bool $args {
     
    30292838 *
    30302839 * @global object $activities_template {@link BP_Activity_Template}
    3031  * @uses bp_get_activity_action_name()
    3032  * @uses apply_filters() To call the 'bp_activity_can_comment' hook.
    30332840 *
    30342841 * @return bool $can_comment True if item can receive comments.
     
    31152922 * @since 1.5.0
    31162923 *
    3117  * @uses apply_filters() To call the 'bp_activity_can_favorite' hook.
    3118  *
    31192924 * @return bool True if comment can receive comments.
    31202925 */
     
    31372942 *
    31382943 * @see bp_get_total_favorite_count_for_user() for description of parameters.
    3139  * @uses bp_get_total_favorite_count_for_user()
    31402944 *
    31412945 * @param int $user_id See {@link bp_get_total_favorite_count_for_user()}.
     
    31502954     * @since 1.2.0
    31512955     *
    3152      * @uses bp_activity_total_favorites_for_user()
    3153      * @uses apply_filters() To call the 'bp_get_total_favorite_count_for_user' hook.
    31542956     *
    31552957     * @param int $user_id ID of user being queried. Default: displayed user ID.
     
    31902992 *
    31912993 * @see bp_get_total_mention_count_for_user() for description of parameters.
    3192  * @uses bp_get_total_favorite_count_for_user()
    31932994 *
    31942995 * @param int $user_id See {@link bp_get_total_mention_count_for_user()}.
     
    32033004     * @since 1.2.0
    32043005     *
    3205      * @uses bp_get_user_meta()
    3206      * @uses apply_filters() To call the 'bp_get_total_mention_count_for_user' hook.
    32073006     *
    32083007     * @param int $user_id ID of user being queried. Default: displayed user ID.
     
    32383037 * @since 1.2.0
    32393038 *
    3240  * @uses bp_get_send_public_message_link()
    32413039 */
    32423040function bp_send_public_message_link() {
     
    32493047     * @since 1.2.0
    32503048     *
    3251      * @uses is_user_logged_in()
    3252      * @uses bp_is_my_profile()
    3253      * @uses bp_is_user()
    3254      * @uses wp_nonce_url()
    3255      * @uses bp_get_activity_directory_permalink()
    3256      * @uses apply_filters() To call the 'bp_get_send_public_message_link' hook.
    32573049     *
    32583050     * @return string The public message link for the displayed user.
     
    33123104 *
    33133105 * @see bp_get_mentioned_user_display_name() for description of parameters.
    3314  * @uses bp_get_mentioned_user_display_name()
    33153106 *
    33163107 * @param int|string|bool $user_id_or_username See {@link bp_get_mentioned_user_display_name()}.
     
    33253116     * @since 1.2.0
    33263117     *
    3327      * @uses bp_core_get_user_displayname()
    3328      * @uses apply_filters() To call the 'bp_get_mentioned_user_display_name' hook.
    33293118     *
    33303119     * @param int|string|bool $user_id_or_username User ID or username.
     
    33583147 *
    33593148 * @see bp_get_send_public_message_button() for description of parameters.
    3360  * @uses bp_get_send_public_message_button()
    33613149 *
    33623150 * @param array|string $args See {@link bp_get_send_public_message_button()}.
     
    33713159     * @since 1.2.0
    33723160     *
    3373      * @uses bp_get_send_public_message_link()
    3374      * @uses wp_parse_args()
    3375      * @uses bp_get_button()
    3376      * @uses apply_filters() To call the 'bp_get_send_public_message_button' hook.
    33773161     *
    33783162     * @param array|string $args {
     
    34223206 * @since 1.2.0
    34233207 *
    3424  * @uses bp_get_activity_post_form_action()
    34253208 */
    34263209function bp_activity_post_form_action() {
     
    34333216     * @since 1.2.0
    34343217     *
    3435      * @uses home_url()
    3436      * @uses bp_get_activity_root_slug()
    3437      * @uses apply_filters() To call the 'bp_get_activity_post_form_action' hook.
    34383218     *
    34393219     * @return string The activity post form action.
     
    36883468 * @since 1.0.0
    36893469 *
    3690  * @uses bp_get_sitewide_activity_feed_link()
    36913470 */
    36923471function bp_sitewide_activity_feed_link() {
     
    36993478     * @since 1.0.0
    37003479     *
    3701      * @uses home_url()
    3702      * @uses bp_get_activity_root_slug()
    3703      * @uses apply_filters() To call the 'bp_get_sitewide_activity_feed_link' hook.
    37043480     *
    37053481     * @return string The sitewide activity feed link.
     
    37223498 * @since 1.2.0
    37233499 *
    3724  * @uses bp_get_member_activity_feed_link()
    37253500 */
    37263501function bp_member_activity_feed_link() {
     
    37363511 * @todo properly deprecate in favor of bp_member_activity_feed_link().
    37373512 *
    3738  * @uses bp_get_member_activity_feed_link()
    37393513 */
    37403514function bp_activities_member_rss_link() { echo bp_get_member_activity_feed_link(); }
     
    37453519     * @since 1.2.0
    37463520     *
    3747      * @uses bp_is_profile_component()
    3748      * @uses bp_is_current_action()
    3749      * @uses bp_displayed_user_domain()
    3750      * @uses bp_get_activity_slug()
    3751      * @uses bp_is_active()
    3752      * @uses bp_get_friends_slug()
    3753      * @uses bp_get_groups_slug()
    3754      * @uses apply_filters() To call the 'bp_get_activities_member_rss_link' hook.
    37553521     *
    37563522     * @return string $link The member activity feed link.
     
    38013567     * @todo properly deprecate in favor of bp_get_member_activity_feed_link().
    38023568     *
    3803      * @uses bp_get_member_activity_feed_link()
    38043569     *
    38053570     * @return string The member activity feed link.
     
    38153580 * @since 1.0.0
    38163581 *
    3817  * @uses bp_activity_feed_item_guid()
    38183582 */
    38193583function bp_activity_feed_item_guid() {
     
    38273591     *
    38283592     * @global object $activities_template {@link BP_Activity_Template}
    3829      * @uses apply_filters() To call the 'bp_get_activity_feed_item_guid' hook.
    38303593     *
    38313594     * @return string The activity feed item guid.
     
    38493612 * @since 1.0.0
    38503613 *
    3851  * @uses bp_get_activity_feed_item_title()
    38523614 */
    38533615function bp_activity_feed_item_title() {
     
    38613623     *
    38623624     * @global object $activities_template {@link BP_Activity_Template}
    3863      * @uses ent2ncr()
    3864      * @uses convert_chars()
    3865      * @uses bp_create_excerpt()
    3866      * @uses apply_filters() To call the 'bp_get_activity_feed_item_title' hook.
    38673625     *
    38683626     * @return string $title The activity feed item title.
     
    39033661 * @since 1.0.0
    39043662 *
    3905  * @uses bp_get_activity_feed_item_link()
    39063663 */
    39073664function bp_activity_feed_item_link() {
     
    39153672     *
    39163673     * @global object $activities_template {@link BP_Activity_Template}
    3917      * @uses apply_filters() To call the 'bp_get_activity_feed_item_link' hook.
    39183674     *
    39193675     * @return string The activity feed item link.
     
    39413697 * @since 1.0.0
    39423698 *
    3943  * @uses bp_get_activity_feed_item_date()
    39443699 */
    39453700function bp_activity_feed_item_date() {
     
    39533708     *
    39543709     * @global object $activities_template {@link BP_Activity_Template}
    3955      * @uses apply_filters() To call the 'bp_get_activity_feed_item_date' hook.
    39563710     *
    39573711     * @return string The activity feed item date.
     
    39793733 * @since 1.0.0
    39803734 *
    3981  * @uses bp_get_activity_feed_item_description()
    39823735 */
    39833736function bp_activity_feed_item_description() {
     
    39913744     *
    39923745     * @global object $activities_template {@link BP_Activity_Template}
    3993      * @uses ent2ncr()
    3994      * @uses convert_chars()
    3995      * @uses apply_filters() To call the 'bp_get_activity_feed_item_description' hook.
    39963746     *
    39973747     * @return string The activity feed item description.
     
    40253775 * @since 1.5.0
    40263776 *
    4027  * @uses bloginfo()
    4028  * @uses bp_sitewide_activity_feed_link()
    40293777 */
    40303778function bp_activity_sitewide_feed() {
     
    40443792 * @param string $context The current context. 'activity', 'member',
    40453793 *                        'member_groups', 'group'.
    4046  * @uses bp_get_activity_show_filters()
    40473794 */
    40483795function bp_activity_show_filters( $context = '' ) {
Note: See TracChangeset for help on using the changeset viewer.