Skip to:
Content

BuddyPress.org

Changeset 8530


Ignore:
Timestamp:
06/15/2014 06:22:12 PM (5 years ago)
Author:
boonebgorges
Message:

Improved formatting for docblocks in bp-activity-functions.php

See #5022

File:
1 edited

Legend:

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

    r8529 r8530  
    1616 * Check whether the $bp global lists an activity directory page.
    1717 *
    18  * @since BuddyPress (1.5)
     18 * @since BuddyPress (1.5.0)
    1919 *
    2020 * @global object $bp BuddyPress global settings
     
    4343 *   add_filter( 'bp_activity_do_mentions', '__return_false' );
    4444 *
    45  * @since BuddyPress (1.8)
     45 * @since BuddyPress (1.8.0)
    4646 *
    4747 * @uses apply_filters() To call 'bp_activity_do_mentions' hook.
     
    5656 * Locate usernames in an activity content string, as designated by an @ sign.
    5757 *
    58  * @since BuddyPress (1.5)
    59  *
    60  * @param string $content The content of the activity, usually found in $activity->content.
    61  * @return array|bool Associative array with user ID as key and username as value. Boolean false if no mentions found.
     58 * @since BuddyPress (1.5.0)
     59 *
     60 * @param string $content The content of the activity, usually found in
     61 *        $activity->content.
     62 * @return array|bool Associative array with user ID as key and username as
     63 *         value. Boolean false if no mentions found.
    6264 */
    6365function bp_activity_find_mentions( $content ) {
     
    9092 * Reset a user's unread mentions list and count.
    9193 *
    92  * @since BuddyPress (1.5)
     94 * @since BuddyPress (1.5.0)
    9395 *
    9496 * @uses bp_delete_user_meta()
     
    109111 * Currently, only used in {@link bp_activity_delete()}.
    110112 *
    111  * @since BuddyPress (1.5)
     113 * @since BuddyPress (1.5.0)
    112114 *
    113115 * @uses bp_activity_find_mentions()
     
    143145 * for @mentions.
    144146 *
    145  * @since BuddyPress (1.7)
     147 * @since BuddyPress (1.7.0)
    146148 *
    147149 * @uses bp_get_user_meta()
     
    318320 * Retreive the current action from a component and key.
    319321 *
    320  * @since BuddyPress (1.1)
     322 * @since BuddyPress (1.1.0)
    321323 *
    322324 * @global object $bp BuddyPress global settings.
     
    340342 * Fetch details of all registered activity types.
    341343 *
    342  * @since BuddyPress (1.7)
     344 * @since BuddyPress (1.7.0)
    343345 *
    344346 * @return array array( type => description ), ...
     
    366368 * Get a users favorite activity stream items.
    367369 *
    368  * @since BuddyPress (1.2)
     370 * @since BuddyPress (1.2.0)
    369371 *
    370372 * @uses bp_get_user_meta()
     
    389391 * Add an activity stream item as a favorite for a user.
    390392 *
    391  * @since BuddyPress (1.2)
     393 * @since BuddyPress (1.2.0)
    392394 *
    393395 * @uses is_user_logged_in()
     
    454456 * Remove an activity stream item as a favorite for a user.
    455457 *
    456  * @since BuddyPress (1.2)
     458 * @since BuddyPress (1.2.0)
    457459 *
    458460 * @uses is_user_logged_in()
     
    523525 * Check whether an activity item exists with a given content string.
    524526 *
    525  * @since BuddyPress (1.1)
     527 * @since BuddyPress (1.1.0)
    526528 *
    527529 * @uses BP_Activity_Activity::check_exists_by_content() {@link BP_Activity_Activity}
     
    538540 * Retrieve the last time activity was updated.
    539541 *
    540  * @since BuddyPress (1.0)
     542 * @since BuddyPress (1.0.0)
    541543 *
    542544 * @uses BP_Activity_Activity::get_last_updated() {@link BP_Activity_Activity}
     
    552554 * Retrieve the number of favorite activity stream items a user has.
    553555 *
    554  * @since BuddyPress (1.2)
     556 * @since BuddyPress (1.2.0)
    555557 *
    556558 * @uses BP_Activity_Activity::total_favorite_count() {@link BP_Activity_Activity}
     
    618620 * Get metadata for a given activity item.
    619621 *
    620  * @since BuddyPress (1.2)
     622 * @since BuddyPress (1.2.0)
    621623 *
    622624 * @uses apply_filters() To call the 'bp_activity_get_meta' hook.
     
    643645 * Update a piece of activity meta.
    644646 *
    645  * @since BuddyPress (1.2)
     647 * @since BuddyPress (1.2.0)
    646648 *
    647649 * @param int $activity_id ID of the activity item whose metadata is being
     
    690692 * Completely remove a user's activity data.
    691693 *
    692  * @since BuddyPress (1.5)
     694 * @since BuddyPress (1.5.0)
    693695 *
    694696 * @uses is_user_logged_in()
     
    725727 * Mark all of the user's activity as spam.
    726728 *
    727  * @since BuddyPress (1.6)
     729 * @since BuddyPress (1.6.0)
    728730 *
    729731 * @global object $wpdb WordPress database access object.
     
    778780 * Mark all of the user's activity as ham (not spam).
    779781 *
    780  * @since BuddyPress (1.6)
     782 * @since BuddyPress (1.6.0)
    781783 *
    782784 * @global object $wpdb WordPress database access object.
     
    831833 * Register the activity stream actions for updates
    832834 *
    833  * @since BuddyPress (1.6)
     835 * @since BuddyPress (1.6.0)
    834836 *
    835837 * @global object $bp BuddyPress global settings.
     
    936938 *   - 'per_page' (false)
    937939 *
    938  * @since BuddyPress (1.2)
     940 * @since BuddyPress (1.2.0)
    939941 *
    940942 * @see BP_Activity_Activity::get() For more information on accepted arguments
     
    10261028 * Fetch specific activity items.
    10271029 *
    1028  * @since BuddyPress (1.2)
     1030 * @since BuddyPress (1.2.0)
    10291031 *
    10301032 * @see BP_Activity_Activity::get() For more information on accepted arguments
     
    10721074 * Add an activity item.
    10731075 *
    1074  * @since BuddyPress (1.1)
     1076 * @since BuddyPress (1.1.0)
    10751077 *
    10761078 * @uses wp_parse_args()
     
    11711173 * Post an activity update.
    11721174 *
    1173  * @since BuddyPress (1.2)
     1175 * @since BuddyPress (1.2.0)
    11741176 *
    11751177 * @global object $bp BuddyPress global settings.
     
    12331235 * Add an activity comment.
    12341236 *
    1235  * @since BuddyPress (1.2)
     1237 * @since BuddyPress (1.2.0)
    12361238 *
    12371239 * @global object $bp BuddyPress global settings.
     
    12481250 *     @type string $content The content of the comment.
    12491251 *     @type int $user_id Optional. The ID of the user making the comment.
    1250  *                        Defaults to the ID of the logged-in user.
     1252 *           Defaults to the ID of the logged-in user.
    12511253 *     @type int $activity_id The ID of the "root" activity item, ie the oldest
    1252  *                            ancestor of the comment.
     1254 *           ancestor of the comment.
    12531255 *     @type int $parent_id Optional. The ID of the parent activity item, ie the
    1254  *                          item to which the comment is an immediate reply. If
    1255  *                          not provided, this value defaults to the $activity_id.
     1256 *           item to which the comment is an immediate reply. If not provided,
     1257 *           this value defaults to the $activity_id.
    12561258 * }
    12571259 * @return int|bool The ID of the comment on success, otherwise false.
     
    13151317 * Fetch the activity_id for an existing activity entry in the DB.
    13161318 *
    1317  * @since BuddyPress (1.2)
     1319 * @since BuddyPress (1.2.0)
    13181320 *
    13191321 * @see BP_Activity_Activity::get() For more information on accepted arguments.
     
    13551357 * If you are deleting an activity comment please use bp_activity_delete_comment();
    13561358 *
    1357  * @since BuddyPress (1.0)
     1359 * @since BuddyPress (1.0.0)
    13581360 *
    13591361 * @see BP_Activity_Activity::get() For more information on accepted arguments.
     
    14271429     * You should use bp_activity_delete() instead.
    14281430     *
    1429      * @since BuddyPress (1.1)
     1431     * @since BuddyPress (1.1.0)
    14301432     * @deprecated BuddyPress (1.2)
    14311433     *
     
    14551457     * Delete an activity item by activity id.
    14561458     *
    1457      * @since BuddyPress (1.1)
     1459     * @since BuddyPress (1.1.0)
    14581460     *
    14591461     * @uses bp_activity_delete()
     
    14711473     * You should use bp_activity_delete() instead.
    14721474     *
    1473      * @since BuddyPress (1.1)
     1475     * @since BuddyPress (1.1.0)
    14741476     * @deprecated BuddyPress (1.2)
    14751477     *
     
    14911493     * You should use bp_activity_delete() instead.
    14921494     *
    1493      * @since BuddyPress (1.1)
     1495     * @since BuddyPress (1.1.0)
    14941496     * @deprecated BuddyPress (1.2)
    14951497     *
     
    15071509 * Delete an activity comment.
    15081510 *
    1509  * @since BuddyPress (1.2)
     1511 * @since BuddyPress (1.2.0)
    15101512 *
    15111513 * @uses apply_filters() To call the 'bp_activity_delete_comment_pre' hook.
     
    15501552     * Delete an activity comment's children.
    15511553     *
    1552      * @since BuddyPress (1.2)
     1554     * @since BuddyPress (1.2.0)
    15531555     *
    15541556     * @uses BP_Activity_Activity::get_child_comments() {@link BP_Activity_Activity}
     
    15571559     *
    15581560     * @param int $activity_id The ID of the "root" activity, ie the
    1559      *                         comment's oldest ancestor.
     1561     *        comment's oldest ancestor.
    15601562     * @param int $comment_id The ID of the comment to be deleted.
    15611563     */
     
    15781580 * have it available.
    15791581 *
    1580  * @since BuddyPress (1.2)
     1582 * @since BuddyPress (1.2.0)
    15811583 *
    15821584 * @uses bp_get_root_domain()
     
    16131615 * Hide a user's activity.
    16141616 *
    1615  * @since BuddyPress (1.2)
     1617 * @since BuddyPress (1.2.0)
    16161618 *
    16171619 * @uses BP_Activity_Activity::hide_all_for_user() {@link BP_Activity_Activity}
     
    16341636 * and removes the rest of the images from the string.
    16351637 *
    1636  * @since BuddyPress (1.2)
     1638 * @since BuddyPress (1.2.0)
    16371639 *
    16381640 * @uses esc_attr()
     
    16411643 * @param string $content The content of the activity item.
    16421644 * @param string $link Optional. The unescaped URL that the image should link
    1643  *                               to. If absent, the image will not be a link.
     1645 *        to. If absent, the image will not be a link.
    16441646 * @param array $activity_args Optional. The args passed to the activity
    1645  *                             creation function (eg bp_blogs_record_activity()).
     1647 *        creation function (eg bp_blogs_record_activity()).
    16461648 * @return string $content The content with images stripped and replaced with a
    1647  *                         single thumb.
     1649 *         single thumb.
    16481650 */
    16491651function bp_activity_thumbnail_content_images( $content, $link = false, $args = false ) {
     
    16911693 * Fetch whether the current user is allowed to mark items as spam.
    16921694 *
    1693  * @since BuddyPress (1.6)
     1695 * @since BuddyPress (1.6.0)
    16941696 *
    16951697 * @return bool True if user is allowed to mark activity items as spam.
     
    17021704 * Mark an activity item as spam.
    17031705 *
    1704  * @since BuddyPress (1.6)
     1706 * @since BuddyPress (1.6.0)
    17051707 *
    17061708 * @global object $bp BuddyPress global settings.
     
    17081710 * @param BP_Activity_Activity $activity The activity item to be spammed.
    17091711 * @param string $source Optional. Default is "by_a_person" (ie, a person has
    1710  *                       manually marked the activity as spam). BP core also
    1711  *                       accepts 'by_akismet'.
     1712 *        manually marked the activity as spam). BP core also accepts
     1713 *        'by_akismet'.
    17121714 */
    17131715function bp_activity_mark_as_spam( &$activity, $source = 'by_a_person' ) {
     
    17421744 * Mark an activity item as ham.
    17431745 *
    1744  * @since BuddyPress (1.6)
     1746 * @since BuddyPress (1.6.0)
    17451747 *
    17461748 * @global object $bp BuddyPress global settings.
     
    17481750 * @param BP_Activity_Activity $activity The activity item to be hammed.
    17491751 * @param string $source Optional. Default is "by_a_person" (ie, a person has
    1750  *                       manually marked the activity as spam). BP core also
    1751  *                       accepts 'by_akismet'.
     1752 *        manually marked the activity as spam). BP core also accepts
     1753 *        'by_akismet'.
    17521754 */
    17531755function bp_activity_mark_as_ham( &$activity, $source = 'by_a_person' ) {
     
    17921794 * For that, see {@link bp_activity_comment_embed()}.
    17931795 *
    1794  * @since BuddyPress (1.5)
     1796 * @since BuddyPress (1.5.0)
    17951797 *
    17961798 * @see BP_Embed
     
    18161818 * the cache if they are not there yet.
    18171819 *
    1818  * @since BuddyPress (1.5)
     1820 * @since BuddyPress (1.5.0)
    18191821 *
    18201822 * @see BP_Embed
     
    18351837 * When a user clicks on a "Read More" item, make sure embeds are correctly parsed and shown for the expanded content.
    18361838 *
    1837  * @since BuddyPress (1.5)
     1839 * @since BuddyPress (1.5.0)
    18381840 *
    18391841 * @see BP_Embed
     
    18631865 * once the comments are done being processed.
    18641866 *
    1865  * @since BuddyPress (1.5)
     1867 * @since BuddyPress (1.5.0)
    18661868 *
    18671869 * @see bp_activity_comment_embed()
     
    18781880 * Used during {@link BP_Embed::parse_oembed()} via {@link bp_activity_embed()}.
    18791881 *
    1880  * @since BuddyPress (1.5)
     1882 * @since BuddyPress (1.5.0)
    18811883 *
    18821884 * @see BP_Embed::parse_oembed()
     
    18841886 *
    18851887 * @param string $cache An empty string passed by BP_Embed::parse_oembed() for
    1886  *                      functions like this one to filter.
     1888 *        functions like this one to filter.
    18871889 * @param int $id The ID of the activity item.
    18881890 * @param string $cachekey The cache key generated in BP_Embed::parse_oembed().
     
    18981900 * Used during {@link BP_Embed::parse_oembed()} via {@link bp_activity_embed()}.
    18991901 *
    1900  * @since BuddyPress (1.5)
     1902 * @since BuddyPress (1.5.0)
    19011903 *
    19021904 * @see BP_Embed::parse_oembed()
     
    19041906 *
    19051907 * @param string $cache An empty string passed by BP_Embed::parse_oembed() for
    1906  *                      functions like this one to filter.
     1908 *        functions like this one to filter.
    19071909 * @param int $id The ID of the activity item.
    19081910 * @param string $cachekey The cache key generated in BP_Embed::parse_oembed().
Note: See TracChangeset for help on using the changeset viewer.