Skip to:
Content

BuddyPress.org

Changeset 9834


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

Punctuation is a key element to complete sentences.

See #6396.

Location:
trunk/src/bp-activity
Files:
11 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-activity/bp-activity-admin.php

    r9833 r9834  
    5454 * @param array $custom_menus The list of top-level BP menu items.
    5555 *
    56  * @return array $custom_menus List of top-level BP menu items, with Activity added
     56 * @return array $custom_menus List of top-level BP menu items, with Activity added.
    5757 */
    5858function bp_activity_admin_menu_order( $custom_menus = array() ) {
    … …  
    192192 * Does the following:
    193193 *   - Register contextual help and screen options for this admin page.
    194  *   - Enqueues scripts and styles
    195  *   - Catches POST and GET requests related to Activity
     194 *   - Enqueues scripts and styles.
     195 *   - Catches POST and GET requests related to Activity.
    196196 *
    197197 * @since BuddyPress (1.6.0)
    … …  
    820820
    821821/**
    822  * Activity type metabox for the Activity admin edit screen
     822 * Activity type metabox for the Activity admin edit screen.
    823823 *
    824824 * @since BuddyPress (1.6.0)
    … …  
    10551055
    10561056    /**
    1057      * If users can comment on blog & forum activity items
     1057     * If users can comment on blog & forum activity items.
    10581058     *
    10591059     * @since BuddyPress (2.2.2)
    … …  
    16421642     *
    16431643     * This method merges functionality from {@link bp_activity_can_comment()} and
    1644      * {@link bp_blogs_disable_activity_commenting()}.  This is done because the activity
     1644     * {@link bp_blogs_disable_activity_commenting()}. This is done because the activity
    16451645     * list table doesn't use a BuddyPress activity loop, which prevents those
    16461646     * functions from working as intended.

  • trunk/src/bp-activity/bp-activity-akismet.php

    r9833 r9834  
    665665
    666666/**
    667  * Delete old spam activity meta data
     667 * Delete old spam activity meta data.
    668668 *
    669669 * This is done as a clean-up mechanism, as _bp_akismet_submission meta can

  • trunk/src/bp-activity/bp-activity-filters.php

    r9833 r9834  
    211211     * @since BuddyPress (1.2.0)
    212212     *
    213      * @param array Array of allowed HTML tags and attributes.
     213     * @param array $value Array of allowed HTML tags and attributes.
    214214     */
    215215    $activity_allowedtags = apply_filters( 'bp_activity_allowed_tags', $activity_allowedtags );
    … …  
    321321 * @uses bp_activity_update_mention_count_for_user()
    322322 *
    323  * @param BP_Activity_Activity $activity The BP_Activity_Activity object
     323 * @param BP_Activity_Activity $activity The BP_Activity_Activity object.
    324324 */
    325325function bp_activity_at_name_send_emails( $activity ) {
    … …  
    379379     * @param array $matches Items matched by preg_replace_callback() in bp_activity_make_nofollow_filter().
    380380     *
    381      * @return string $text Link with rel=nofollow added
     381     * @return string $text Link with rel=nofollow added.
    382382     */
    383383    function bp_activity_make_nofollow_filter_callback( $matches ) {
    … …  
    431431     * @since BuddyPress (1.5.0)
    432432     *
    433      * @param string $read_more Internationalized "Read more" text.
     433     * @param string $value Internationalized "Read more" text.
    434434     */
    435435    $append_text    = apply_filters( 'bp_activity_excerpt_append_text', __( '[Read more]', 'buddypress' ) );
    … …  
    440440     * @since BuddyPress (1.5.0)
    441441     *
    442      * @param int $excerpt_length Number indicating how many words to trim the excerpt down to.
     442     * @param int $value Number indicating how many words to trim the excerpt down to.
    443443     */
    444444    $excerpt_length = apply_filters( 'bp_activity_excerpt_length', 358 );
    … …  
    544544 * @since BuddyPress (2.0.0)
    545545 *
    546  * @uses bp_activity_get_last_updated() to get the recorded date of the last activity
     546 * @uses bp_activity_get_last_updated() to get the recorded date of the last activity.
    547547 *
    548548 * @param array $response
    … …  
    626626     * @since BuddyPress (2.0.0)
    627627     *
    628      * @param array $settings Heartbeat settings array.
     628     * @param array $value Heartbeat settings array.
    629629     */
    630630    $heartbeat_settings = apply_filters( 'heartbeat_settings', array() );
    … …  
    639639     * @since BuddyPress (2.0.0)
    640640     *
    641      * @param int $frequency The frequency in seconds between pulses.
     641     * @param int $value The frequency in seconds between pulses.
    642642     */
    643643    $bp_activity_pulse = apply_filters( 'bp_activity_heartbeat_pulse', 15 );

  • trunk/src/bp-activity/bp-activity-functions.php

    r9833 r9834  
    2929 * The Mentions feature does a number of things, all of which will be turned
    3030 * off if you disable mentions:
    31  *   - Detecting and auto-linking @username in all BP/WP content
     31 *   - Detecting and auto-linking @username in all BP/WP content.
    3232 *   - Sending BP notifications and emails to users when they are mentioned
    33  *     using the @username syntax
    34  *   - The Public Message button on user profiles
     33 *     using the @username syntax.
     34 *   - The Public Message button on user profiles.
    3535 *
    3636 * Mentions are enabled by default. To disable, put the following line in
    … …  
    269269 *
    270270 * @since BuddyPress (1.9.0)
     271 *
     272 * @param string $mentionname Username of user in @-mentions.
    271273 *
    272274 * @return int|bool ID of the user, if one is found. Otherwise false.
    … …  
    329331 * @param  string|bool   $label           String to describe this action in the activity stream filter dropdown.
    330332 * @param  array         $context         Optional. Activity stream contexts where the filter should appear.
    331  *                                        Values: 'activity', 'member', 'member_groups', 'group'
     333 *                                        Values: 'activity', 'member', 'member_groups', 'group'.
    332334 * @param  int           $position        Optional. The position of the action when listed in dropdowns.
    333335 *
    … …  
    407409 *                                              Default: 'bp_activity_format_activity_action_custom_post_type_post'.
    408410 *     @type array    $contexts                 The directory contexts in which the filter will show.
    409  *                                              Default: array( 'activity' ),
     411 *                                              Default: array( 'activity' ).
    410412 *     @type array    $position                 Position of the item in filter dropdowns.
    411413 *     @type string   $singular                 Singular, translatable name of the post type item. If no value is
    … …  
    544546 * @since BuddyPress (2.2.0)
    545547 *
    546  * @return object actions ordered by their position
     548 * @return object Actions ordered by their position.
    547549 */
    548550function bp_activity_get_actions() {
    … …  
    12331235
    12341236/**
    1235  * Register the activity stream actions for updates
     1237 * Register the activity stream actions for updates.
    12361238 *
    12371239 * @since BuddyPress (1.6.0)
    … …  
    15451547 * @since BuddyPress (1.2.0)
    15461548 *
    1547  * @see BP_Activity_Activity::get() For more information on accepted arguments
     1549 * @see BP_Activity_Activity::get() For more information on accepted arguments.
    15481550 * @uses wp_parse_args()
    1549  * @uses apply_filters() To call the 'bp_activity_get_specific' hook
     1551 * @uses apply_filters() To call the 'bp_activity_get_specific' hook.
    15501552 * @uses BP_Activity_Activity::get() {@link BP_Activity_Activity}
    15511553 *
    … …  
    16051607 * @uses BP_Activity_Activity::rebuild_activity_comment_tree() {@link BP_Activity_Activity}
    16061608 * @uses wp_cache_delete()
    1607  * @uses do_action() To call the 'bp_activity_add' hook
     1609 * @uses do_action() To call the 'bp_activity_add' hook.
    16081610 *
    16091611 * @param array|string $args {
    … …  
    17281730 *     @type int    $user_id Optional. Defaults to the logged-in user.
    17291731 * }
    1730  * @return int $activity_id The activity id
     1732 * @return int $activity_id The activity id.
    17311733 */
    17321734function bp_activity_post_update( $args = '' ) {
    … …  
    24472449 * @param int $comment_id  The ID of the comment to be deleted.
    24482450 *
    2449  * @return bool True on success, false on failure
     2451 * @return bool True on success, false on failure.
    24502452 */
    24512453function bp_activity_delete_comment( $activity_id, $comment_id ) {
    … …  
    26182620 *
    26192621 * @uses esc_attr()
    2620  * @uses apply_filters() To call the 'bp_activity_thumbnail_content_images' hook
     2622 * @uses apply_filters() To call the 'bp_activity_thumbnail_content_images' hook.
    26212623 *
    26222624 * @param string      $content The content of the activity item.
    … …  
    26272629 *
    26282630 * @return string $content The content with images stripped and replaced with a
    2629  *         single thumb.
     2631 *                         single thumb.
    26302632 */
    26312633function bp_activity_thumbnail_content_images( $content, $link = false, $args = false ) {
    … …  
    29792981 * @see bp_embed_activity_cache()
    29802982 * @see bp_embed_activity_save_cache()
     2983 *
    29812984 * @uses add_filter() To attach 'bp_get_activity_id' to 'embed_post_id'.
    29822985 * @uses add_filter() To attach 'bp_embed_activity_cache' to 'bp_embed_get_cache'.
    … …  
    30033006 * @see bp_embed_activity_cache()
    30043007 * @see bp_embed_activity_save_cache()
     3008 *
    30053009 * @uses add_filter() To attach 'bp_get_activity_comment_id' to 'embed_post_id'.
    30063010 * @uses add_filter() To attach 'bp_embed_activity_cache' to 'bp_embed_get_cache'.

  • trunk/src/bp-activity/bp-activity-loader.php

    r9833 r9834  
    131131     * @uses bp_get_groups_slug()
    132132     *
    133      * @param array $main_nav Optional. See BP_Component::setup_nav() for
    134      *                        description.
    135      * @param array $sub_nav  Optional. See BP_Component::setup_nav() for
    136      *                        description.
     133     * @param array $main_nav Optional. See BP_Component::setup_nav() for description.
     134     * @param array $sub_nav  Optional. See BP_Component::setup_nav() for description.
    137135     */
    138136    public function setup_nav( $main_nav = array(), $sub_nav = array() ) {
    … …  
    370368
    371369    /**
    372      * Setup cache groups
     370     * Setup cache groups.
    373371     *
    374372     * @since BuddyPress (2.2.0)

  • trunk/src/bp-activity/bp-activity-notifications.php

    r9833 r9834  
    3535 * @uses apply_filters() To call the 'bp_activity_at_message_notification_message' hook.
    3636 * @uses wp_mail()
    37  * @uses do_action() To call the 'bp_activity_sent_mention_email' hook
     37 * @uses do_action() To call the 'bp_activity_sent_mention_email' hook.
    3838 *
    3939 * @param int $activity_id      The ID of the activity update.
    … …  
    164164 * @uses get_blog_option()
    165165 * @uses bp_get_root_blog_id()
    166  * @uses apply_filters() To call the 'bp_activity_new_comment_notification_to' hook
    167  * @uses apply_filters() To call the 'bp_activity_new_comment_notification_subject' hook
    168  * @uses apply_filters() To call the 'bp_activity_new_comment_notification_message' hook
     166 * @uses apply_filters() To call the 'bp_activity_new_comment_notification_to' hook.
     167 * @uses apply_filters() To call the 'bp_activity_new_comment_notification_subject' hook.
     168 * @uses apply_filters() To call the 'bp_activity_new_comment_notification_message' hook.
    169169 * @uses wp_mail()
    170  * @uses do_action() To call the 'bp_activity_sent_reply_to_update_email' hook
    171  * @uses apply_filters() To call the 'bp_activity_new_comment_notification_comment_author_to' hook
    172  * @uses apply_filters() To call the 'bp_activity_new_comment_notification_comment_author_subject' hook
    173  * @uses apply_filters() To call the 'bp_activity_new_comment_notification_comment_author_message' hook
    174  * @uses do_action() To call the 'bp_activity_sent_reply_to_reply_email' hook
     170 * @uses do_action() To call the 'bp_activity_sent_reply_to_update_email' hook.
     171 * @uses apply_filters() To call the 'bp_activity_new_comment_notification_comment_author_to' hook.
     172 * @uses apply_filters() To call the 'bp_activity_new_comment_notification_comment_author_subject' hook.
     173 * @uses apply_filters() To call the 'bp_activity_new_comment_notification_comment_author_message' hook.
     174 * @uses do_action() To call the 'bp_activity_sent_reply_to_reply_email' hook.
    175175 *
    176176 * @param int   $comment_id   The comment id.
    … …  
    357357
    358358/**
    359  * Helper method to map action arguments to function parameters
     359 * Helper method to map action arguments to function parameters.
    360360 *
    361361 * @since BuddyPress (1.9.0)

  • trunk/src/bp-activity/bp-activity-screens.php

    r9833 r9834  
    122122 * @uses bp_update_is_item_admin()
    123123 * @uses bp_current_user_can()
    124  * @uses do_action() To call the 'bp_activity_screen_groups' hook
    125  * @uses bp_core_load_template()
    126  * @uses apply_filters() To call the 'bp_activity_template_groups_activity' hook
     124 * @uses do_action() To call the 'bp_activity_screen_groups' hook.
     125 * @uses bp_core_load_template()
     126 * @uses apply_filters() To call the 'bp_activity_template_groups_activity' hook.
    127127 */
    128128function bp_activity_screen_groups() {
    … …  
    156156 * @uses bp_update_is_item_admin()
    157157 * @uses bp_current_user_can()
    158  * @uses do_action() To call the 'bp_activity_screen_favorites' hook
    159  * @uses bp_core_load_template()
    160  * @uses apply_filters() To call the 'bp_activity_template_favorite_activity' hook
     158 * @uses do_action() To call the 'bp_activity_screen_favorites' hook.
     159 * @uses bp_core_load_template()
     160 * @uses apply_filters() To call the 'bp_activity_template_favorite_activity' hook.
    161161 */
    162162function bp_activity_screen_favorites() {
    … …  
    187187 * @uses bp_update_is_item_admin()
    188188 * @uses bp_current_user_can()
    189  * @uses do_action() To call the 'bp_activity_screen_mentions' hook
    190  * @uses bp_core_load_template()
    191  * @uses apply_filters() To call the 'bp_activity_template_mention_activity' hook
     189 * @uses do_action() To call the 'bp_activity_screen_mentions' hook.
     190 * @uses bp_core_load_template()
     191 * @uses apply_filters() To call the 'bp_activity_template_mention_activity' hook.
    192192 */
    193193function bp_activity_screen_mentions() {
    … …  
    239239 * @uses groups_get_group()
    240240 * @uses groups_is_user_member()
    241  * @uses apply_filters_ref_array() To call the 'bp_activity_permalink_access' hook
    242  * @uses do_action() To call the 'bp_activity_screen_single_activity_permalink' hook
     241 * @uses apply_filters_ref_array() To call the 'bp_activity_permalink_access' hook.
     242 * @uses do_action() To call the 'bp_activity_screen_single_activity_permalink' hook.
    243243 * @uses bp_core_add_message()
    244244 * @uses is_user_logged_in()
    … …  
    249249 * @uses bp_get_activity_root_slug()
    250250 * @uses bp_core_load_template()
    251  * @uses apply_filters() To call the 'bp_activity_template_profile_activity_permalink' hook
     251 * @uses apply_filters() To call the 'bp_activity_template_profile_activity_permalink' hook.
    252252 */
    253253function bp_activity_screen_single_activity_permalink() {

  • 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.

  • trunk/src/bp-activity/classes/class-bp-activity-activity.php

    r9833 r9834  
    7272
    7373    /**
    74      * Description of the activity, eg 'Alex updated his profile.'
     74     * Description of the activity, eg 'Alex updated his profile.'.
    7575     *
    7676     * @var string
    … …  
    259259
    260260    /**
    261      * Get activity items, as specified by parameters
     261     * Get activity items, as specified by parameters.
    262262     *
    263263     * @see BP_Activity_Activity::get_filter_sql() for a description of the
    … …  
    859859     * @since BuddyPress (2.2.0)
    860860     *
    861      * @param  mixed $scope  The activity scope. Accepts string or array of scopes
     861     * @param  mixed $scope  The activity scope. Accepts string or array of scopes.
    862862     * @param  array $r      Current activity arguments. Same as those of BP_Activity_Activity::get(),
    863863     *                       but merged with defaults.
    864864     *
    865      * @return array 'sql' WHERE SQL string and 'override' activity args
     865     * @return array 'sql' WHERE SQL string and 'override' activity args.
    866866     */
    867867    public static function get_scope_query_sql( $scope = false, $r = array() ) {
    … …  
    917917             *     @type array $override Optional. Override existing activity arguments passed by $r.
    918918             * }
    919              * @param array $r Current activity arguments passed in BP_Activity_Activity::get()
     919             * @param array $r Current activity arguments passed in BP_Activity_Activity::get().
    920920             */
    921921            $scope_args = apply_filters( "bp_activity_set_{$scope}_scope_args", array(), $r );
    … …  
    964964     * @deprecated Use BP_Activity_Activity::get() with an 'in' parameter instead.
    965965     *
    966      * @param mixed    $activity_ids     Array or comma-separated string of activity IDs to retrieve
    967      * @param int|bool $max              Maximum number of results to return. (Optional; default is no maximum)
    968      * @param int      $page             The set of results that the user is viewing. Used in pagination. (Optional; default is 1)
    969      * @param int      $per_page         Specifies how many results per page. Used in pagination. (Optional; default is 25)
    970      * @param string   $sort             MySQL column sort; ASC or DESC. (Optional; default is DESC)
    971      * @param bool     $display_comments Retrieve an activity item's associated comments or not. (Optional; default is false)
     966     * @param mixed    $activity_ids     Array or comma-separated string of activity IDs to retrieve.
     967     * @param int|bool $max              Maximum number of results to return. (Optional; default is no maximum).
     968     * @param int      $page             The set of results that the user is viewing. Used in pagination. (Optional; default is 1).
     969     * @param int      $per_page         Specifies how many results per page. Used in pagination. (Optional; default is 25).
     970     * @param string   $sort             MySQL column sort; ASC or DESC. (Optional; default is DESC).
     971     * @param bool     $display_comments Retrieve an activity item's associated comments or not. (Optional; default is false).
     972     *
    972973     * @return array
    973974     */
    … …  
    980981     * Get the first activity ID that matches a set of criteria.
    981982     *
    982      * @param int    $user_id           User ID to filter by
    983      * @param string $component         Component to filter by
    984      * @param string $type              Activity type to filter by
    985      * @param int    $item_id           Associated item to filter by
    986      * @param int    $secondary_item_id Secondary associated item to filter by
    987      * @param string $action            Action to filter by
    988      * @param string $content           Content to filter by
    989      * @param string $date_recorded     Date to filter by
     983     * @param int    $user_id           User ID to filter by.
     984     * @param string $component         Component to filter by.
     985     * @param string $type              Activity type to filter by.
     986     * @param int    $item_id           Associated item to filter by.
     987     * @param int    $secondary_item_id Secondary associated item to filter by.
     988     * @param string $action            Action to filter by.
     989     * @param string $content           Content to filter by.
     990     * @param string $date_recorded     Date to filter by.
    990991     *
    991992     * @todo Should parameters be optional?
    … …  
    11521153
    11531154        /**
    1154          * Action to allow intercepting activity items to be deleted
     1155         * Action to allow intercepting activity items to be deleted.
    11551156         *
    11561157         * @since BuddyPress (2.3.0)
    11571158         *
    1158          * @param array $activities Array of activities
    1159          * @param array $r          Array of parsed arguments
     1159         * @param array $activities Array of activities.
     1160         * @param array $r          Array of parsed arguments.
    11601161         */
    11611162        do_action_ref_array( 'bp_activity_before_delete', array( $activities, $r ) );
    … …  
    11701171
    11711172        /**
    1172          * Action to allow intercepting activity items just deleted
     1173         * Action to allow intercepting activity items just deleted.
    11731174         *
    11741175         * @since BuddyPress (2.3.0)
    11751176         *
    1176          * @param array $activities Array of activities
    1177          * @param array $r          Array of parsed arguments
     1177         * @param array $activities Array of activities.
     1178         * @param array $r          Array of parsed arguments.
    11781179         */
    11791180        do_action_ref_array( 'bp_activity_after_delete', array( $activities, $r ) );
    … …  
    12731274     * @since BuddyPress (1.2.0)
    12741275     *
    1275      * @global wpdb $wpdb WordPress database object
     1276     * @global wpdb $wpdb WordPress database object.
    12761277     *
    12771278     * @param array  $activities Activities to fetch comments for.
    … …  
    14591460     * @since BuddyPress (1.2.0)
    14601461     *
    1461      * @global wpdb $wpdb WordPress database object
    1462      *
    1463      * @param  int $parent_id ID of an activity or activity comment
    1464      * @param  int $left      Node boundary start for activity or activity comment
    1465      * @return int Right      Node boundary of activity or activity comment
     1462     * @global wpdb $wpdb WordPress database object.
     1463     *
     1464     * @param  int $parent_id ID of an activity or activity comment.
     1465     * @param  int $left      Node boundary start for activity or activity comment.
     1466     * @return int Right      Node boundary of activity or activity comment.
    14661467     */
    14671468    public static function rebuild_activity_comment_tree( $parent_id, $left = 1 ) {
    … …  
    17601761     * @see http://php.net/manual/en/function.array-replace-recursive.php#109390
    17611762     *
    1762      * @param  array $base         Array with keys needing to be replaced
    1763      * @param  array $replacements Array with the replaced keys
     1763     * @param  array $base         Array with keys needing to be replaced.
     1764     * @param  array $replacements Array with the replaced keys.
    17641765     *
    17651766     * @return array

  • trunk/src/bp-activity/classes/class-bp-activity-feed.php

    r9833 r9834  
    4141     * updated using PHP 5.2+ methods.
    4242     *
    43      * @see BP_Feed::__construct() This is where $data is added
     43     * @see BP_Feed::__construct() This is where $data is added.
    4444     * @var array
    4545     */
    … …  
    6767     * Constructor.
    6868     *
    69      * @param array $args Optional
     69     * @param array $args Optional.
    7070     */
    7171    public function __construct( $args = array() ) {

  • trunk/src/bp-activity/classes/class-bp-activity-query.php

    r9833 r9834  
    6767     *         @type string $compare  Optional. The comparison operator. Default '='.
    6868     *                                Accepts '=', '!=', '>', '>=', '<', '<=', 'IN', 'NOT IN', 'LIKE',
    69      *                                'NOT LIKE', BETWEEN', 'NOT BETWEEN', 'REGEXP', 'NOT REGEXP', 'RLIKE'
     69     *                                'NOT LIKE', BETWEEN', 'NOT BETWEEN', 'REGEXP', 'NOT REGEXP', 'RLIKE'.
    7070     *         @type string $relation Optional. The boolean relationship between the activity queries.
    7171     *                                Accepts 'OR', 'AND'. Default 'AND'.
Note: See TracChangeset for help on using the changeset viewer.