Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
05/03/2015 10:51:31 PM (11 years ago)
Author:
tw2113
Message:

Punctuation is a key element to complete sentences.

See #6396.

File:
1 edited

Legend:

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

    r9833 r9834  
    8484}
    8585        /**
    86          * Return activity directory permalink
     86         * Return activity directory permalink.
    8787         *
    8888         * @since BuddyPress (1.5.0)
    … …  
    556556 *     @type string            $scope            Use a BuddyPress pre-built filter.
    557557 *                                                 - 'just-me' retrieves items belonging only to a user; this is equivalent
    558  *                                                   to passing a 'user_id' argument
    559  *                                                 - 'friends' retrieves items belonging to the friends of a user
    560  *                                                 - 'groups' retrieves items belonging to groups to which a user belongs to
    561  *                                                 - 'favorites' retrieves a user's favorited activity items
    562  *                                                 - 'mentions' retrieves items where a user has received an @-mention
     558 *                                                   to passing a 'user_id' argument.
     559 *                                                 - 'friends' retrieves items belonging to the friends of a user.
     560 *                                                 - 'groups' retrieves items belonging to groups to which a user belongs to.
     561 *                                                 - 'favorites' retrieves a user's favorited activity items.
     562 *                                                 - 'mentions' retrieves items where a user has received an @-mention.
    563563 *                                               The default value of 'scope' is set to one of the above if that value
    564564 *                                               appears in the appropriate place in the URL; eg, 'scope' will be 'groups'
    … …  
    592592 *     @type string|bool       $display_comments How to handle activity comments. Possible values:
    593593 *                                                 - 'threaded' - comments appear in a threaded tree, under their parent
    594  *                                                   items
     594 *                                                   items.
    595595 *                                                 - 'stream' - the activity stream is presented in a flat manner, with
    596  *                                                   comments sorted in chronological order alongside other activity items
    597  *                                                 - false - don't fetch activity comments at all
     596 *                                                   comments sorted in chronological order alongside other activity items.
     597 *                                                 - false - don't fetch activity comments at all.
    598598 *                                               Default: 'threaded'.
    599599 *     @type bool              $show_hidden      Whether to show items marked hide_sitewide. Defaults to false, except in
    600600 *                                               the following cases:
    601  *                                                 - User is viewing his own activity stream
     601 *                                                 - User is viewing his own activity stream.
    602602 *                                                 - User is viewing the activity stream of a non-public group of which he
    603  *                                                   is a member
     603 *                                                   is a member.
    604604 *     @type string|bool       $spam             Spam status. 'ham_only', 'spam_only', or false to show all activity
    605605 *                                               regardless of spam status. Default: 'ham_only'.
    … …  
    796796}
    797797        /**
    798          * Get the URL for the Load More link
     798         * Get the URL for the Load More link.
    799799         *
    800800         * @since BuddyPress (2.1.0)
    … …  
    811811                 * @since BuddyPress (2.1.0)
    812812                 *
    813                  * @param string $link                The "Load More" link URL with appropriate query args
    814                  * @param string $url                 The original URL
    815                  * @param object $activities_template The activity template loop global
     813                 * @param string $link                The "Load More" link URL with appropriate query args.
     814                 * @param string $url                 The original URL.
     815                 * @param object $activities_template The activity template loop global.
    816816                 */
    817817                return apply_filters( 'bp_get_activity_load_more_link', $link, $url, $activities_template );
    … …  
    10481048         *
    10491049         * @global string $bp_activity_no_activity
    1050          * @uses apply_filters() To call the 'bp_get_activities_no_activity' hook
     1050         * @uses apply_filters() To call the 'bp_get_activities_no_activity' hook.
    10511051         * @todo Deprecate.
    10521052         *
    … …  
    12031203
    12041204/**
    1205  * Output the display name of the member who posted the activity
     1205 * Output the display name of the member who posted the activity.
    12061206 *
    12071207 * @since BuddyPress (2.1.0)
    … …  
    12141214
    12151215        /**
    1216          * Return the display name of the member who posted the activity
     1216         * Return the display name of the member who posted the activity.
    12171217         *
    12181218         * @since BuddyPress (2.1.0)
    … …  
    14361436         * @uses bp_is_single_activity()
    14371437         * @uses wp_parse_args()
    1438          * @uses apply_filters() To call the 'bp_get_activity_avatar_object_' . $current_activity_item->component hook
    1439          * @uses apply_filters() To call the 'bp_get_activity_avatar_item_id' hook
     1438         * @uses apply_filters() To call the 'bp_get_activity_avatar_object_' . $current_activity_item->component hook.
     1439         * @uses apply_filters() To call the 'bp_get_activity_avatar_item_id' hook.
    14401440         * @uses bp_core_fetch_avatar()
    1441          * @uses apply_filters() To call the 'bp_get_activity_avatar' hook
     1441         * @uses apply_filters() To call the 'bp_get_activity_avatar' hook.
    14421442         *
    14431443         * @param array|string $args  {
    … …  
    15641564
    15651565        /**
    1566          * Return the avatar of the object that action was performed on
     1566         * Return the avatar of the object that action was performed on.
    15671567         *
    15681568         * @since BuddyPress (1.2.0)
    … …  
    15771577         * @uses apply_filters() To call the 'bp_get_activity_secondary_avatar' hook.
    15781578         *
    1579          * @param array $args  {
     1579         * @param array|string $args  {
    15801580         *     For a complete description of arguments, see {@link bp_core_fetch_avatar()}.
    15811581         *     @type string      $alt     Default value varies based on current activity
    … …  
    17411741
    17421742/**
    1743  * Output the activity action
     1743 * Output the activity action.
    17441744 *
    17451745 * @since BuddyPress (1.2.0)
    … …  
    17531753
    17541754        /**
    1755          * Return the activity action
     1755         * Return the activity action.
    17561756         *
    17571757         * @since BuddyPress (1.2.0)
    … …  
    17591759         * @global object $activities_template {@link BP_Activity_Template}
    17601760         * @param array $args Only parameter is "no_timestamp". If true, timestamp is shown in output.
    1761          * @uses apply_filters_ref_array() To call the 'bp_get_activity_action_pre_meta' hook
     1761         * @uses apply_filters_ref_array() To call the 'bp_get_activity_action_pre_meta' hook.
    17621762         * @uses bp_insert_activity_meta()
    17631763         * @uses apply_filters_ref_array() To call the 'bp_get_activity_action' hook.
    … …  
    18091809
    18101810/**
    1811  * Output the activity content body
     1811 * Output the activity content body.
    18121812 *
    18131813 * @since BuddyPress (1.2.0)
    … …  
    18201820
    18211821        /**
    1822          * Return the activity content body
     1822         * Return the activity content body.
    18231823         *
    18241824         * @since BuddyPress (1.2.0)
    … …  
    18991899                /**
    19001900                 * If you want to filter activity update content, please use
    1901                  * the filter 'bp_get_activity_content_body'
     1901                 * the filter 'bp_get_activity_content_body'.
    19021902                 *
    19031903                 * This function is mainly for backwards compatibility.
    … …  
    19921992 *
    19931993 * @global object $activities_template {@link BP_Activity_Template}
    1994  * @uses apply_filters() To call the 'bp_activity_user_can_delete' hook
     1994 * @uses apply_filters() To call the 'bp_activity_user_can_delete' hook.
    19951995 *
    19961996 * @param object|bool $activity Optional. Falls back on the current item in the loop.
    … …  
    20702070         * @param string $args Unused. Left over from an earlier implementation.
    20712071         *
    2072          * @return mixed False on failure, otherwise the activity parent content
     2072         * @return mixed False on failure, otherwise the activity parent content.
    20732073         */
    20742074        function bp_get_activity_parent_content( $args = '' ) {
    … …  
    22442244
    22452245                /**
    2246                  * Loops through a level of activity comments and loads the template for each
     2246                 * Loops through a level of activity comments and loads the template for each.
    22472247                 *
    22482248                 * Note: The recursion itself used to happen entirely in this function. Now it is
    … …  
    22512251                 * @since BuddyPress (1.2.0)
    22522252                 *
    2253                  * @param object $comment The activity object currently being recursed
     2253                 * @param object $comment The activity object currently being recursed.
    22542254                 *
    22552255                 * @global object $activities_template {@link BP_Activity_Template}
    … …  
    24282428         * @uses bp_core_get_user_domain()
    24292429         * @uses bp_get_activity_comment_user_id()
    2430          * @uses apply_filters() To call the 'bp_activity_comment_user_link' hook
     2430         * @uses apply_filters() To call the 'bp_activity_comment_user_link' hook.
    24312431         *
    24322432         * @return string $user_link The URL of the activity comment author's profile.
    … …  
    25072507         *
    25082508         * @uses bp_core_time_since()
    2509          * @uses apply_filters() To call the 'bp_activity_comment_date_recorded' hook
     2509         * @uses apply_filters() To call the 'bp_activity_comment_date_recorded' hook.
    25102510         *
    25112511         * @return string|bool $date_recorded Time since the activity was recorded,
    … …  
    25422542         * @global object $activities_template {@link BP_Activity_Template}
    25432543         * @uses bp_core_time_since()
    2544          * @uses apply_filters() To call the 'bp_activity_comment_date_recorded' hook
     2544         * @uses apply_filters() To call the 'bp_activity_comment_date_recorded' hook.
    25452545         *
    25462546         * @return string|bool $date_recorded Time since the activity was recorded,
    2547          *         in the form "%s ago". False on failure.
     2547         *                                    in the form "%s ago". False on failure.
    25482548         */
    25492549        function bp_get_activity_comment_date_recorded_raw() {
    … …  
    25722572
    25732573        /**
    2574          * Gets the 'delete' URL for the activity comment currently being displayed
     2574         * Gets the 'delete' URL for the activity comment currently being displayed.
    25752575         *
    25762576         * @since BuddyPress (1.5.0)
    … …  
    26972697                 *
    26982698                 * @uses bp_activity_recurse_comment_count()
    2699                  * @uses apply_filters() To call the 'bp_activity_recurse_comment_count' hook
     2699                 * @uses apply_filters() To call the 'bp_activity_recurse_comment_count' hook.
    27002700                 *
    27012701                 * @param object $comment Activity comment object.
    … …  
    27422742         * @since BuddyPress (2.0.0)
    27432743         *
    2744          * @return int $depth Depth for the current activity comment
     2744         * @return int $depth Depth for the current activity comment.
    27452745         */
    27462746        function bp_activity_get_comment_depth() {
    … …  
    29912991         * @uses home_url()
    29922992         * @uses bp_get_activity_root_slug()
    2993          * @uses apply_filters() To call the 'bp_get_activity_favorite_link' hook
     2993         * @uses apply_filters() To call the 'bp_get_activity_favorite_link' hook.
    29942994         *
    29952995         * @return string The activity favorite link.
    … …  
    31593159
    31603160/**
    3161  * Output the URL to delete a single activity stream item
     3161 * Output the URL to delete a single activity stream item.
    31623162 *
    31633163 * @since BuddyPress (2.1.0)
    … …  
    31693169}
    31703170        /**
    3171          * Return the URL to delete a single activity item
     3171         * Return the URL to delete a single activity item.
    31723172         *
    31733173         * @since BuddyPress (2.1.0)
    … …  
    32303230         * @uses bp_core_is_user_deleted()
    32313231         * @uses bp_get_user_meta()
    3232          * @uses apply_filters() To call the 'bp_get_activity_latest_update_excerpt' hook
     3232         * @uses apply_filters() To call the 'bp_get_activity_latest_update_excerpt' hook.
    32333233         * @uses bp_create_excerpt()
    32343234         * @uses bp_get_root_domain()
    32353235         * @uses bp_get_activity_root_slug()
    3236          * @uses apply_filters() To call the 'bp_get_activity_latest_update' hook
     3236         * @uses apply_filters() To call the 'bp_get_activity_latest_update' hook.
    32373237         *
    32383238         * @param int $user_id If empty, will fall back on displayed user.
    32393239         *
    32403240         * @return string|bool $latest_update The activity latest update link.
    3241          *                                    False on failure
     3241         *                                    False on failure.
    32423242         */
    32433243        function bp_get_activity_latest_update( $user_id = 0 ) {
    … …  
    35453545         *
    35463546         * @uses bp_activity_total_favorites_for_user()
    3547          * @uses apply_filters() To call the 'bp_get_total_favorite_count_for_user' hook
     3547         * @uses apply_filters() To call the 'bp_get_total_favorite_count_for_user' hook.
    35483548         *
    35493549         * @param int $user_id ID of user being queried. Default: displayed user ID.
    … …  
    36463646         * @uses wp_nonce_url()
    36473647         * @uses bp_get_activity_directory_permalink()
    3648          * @uses apply_filters() To call the 'bp_get_send_public_message_link' hook
     3648         * @uses apply_filters() To call the 'bp_get_send_public_message_link' hook.
    36493649         *
    36503650         * @return string The public message link for the displayed user.
    … …  
    37143714
    37153715        /**
    3716          * Returns the mentioned user display name
     3716         * Returns the mentioned user display name.
    37173717         *
    37183718         * @since BuddyPress (1.2.0)
    … …  
    42944294
    42954295/**
    4296  * Output the activity feed item link
     4296 * Output the activity feed item link.
    42974297 *
    42984298 * @since BuddyPress (1.0.0)
    … …  
    43054305
    43064306        /**
    4307          * Return the activity feed item link
     4307         * Return the activity feed item link.
    43084308         *
    43094309         * @since BuddyPress (1.0.0)
    … …  
    44504450         *
    44514451         * @param string $context The current context. 'activity', 'member',
    4452          *                            'member_groups', 'group'
     4452         *                            'member_groups', 'group'.
    44534453         *
    44544454         * @return string HTML for <option> values.
Note: See TracChangeset for help on using the changeset viewer.