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-functions.php

    r10741 r10825  
    4141 * @since 1.8.0
    4242 *
    43  * @uses apply_filters() To call 'bp_activity_do_mentions' hook.
    44  *
    4543 * @return bool $retval True to enable mentions, false to disable.
    4644 */
     
    134132 * @since 1.5.0
    135133 *
    136  * @uses bp_delete_user_meta()
    137  *
    138134 * @param int $user_id The id of the user whose unread mentions are being reset.
    139135 */
     
    162158 * @since 1.5.0
    163159 *
    164  * @uses bp_activity_find_mentions()
    165  * @uses bp_activity_update_mention_count_for_user()
    166  *
    167160 * @param int    $activity_id The unique id for the activity item.
    168161 * @param string $action      Can be 'delete' or 'add'. Defaults to 'add'.
     
    200193 *
    201194 * @since 1.7.0
    202  *
    203  * @uses bp_get_user_meta()
    204  * @uses bp_update_user_meta()
    205195 *
    206196 * @param int    $user_id     The user ID.
     
    788778 * @since 1.1.0
    789779 *
    790  * @uses apply_filters() To call the 'bp_activity_get_action' hook.
    791  *
    792780 * @param string $component_id The unique string ID of the component.
    793781 * @param string $key          The action key.
     
    859847 * @since 1.2.0
    860848 *
    861  * @uses bp_get_user_meta()
    862  * @uses apply_filters() To call the 'bp_activity_get_user_favorites' hook.
    863  *
    864849 * @param int $user_id ID of the user whose favorites are being queried.
    865850 * @return array IDs of the user's favorite activity items.
     
    889874 *
    890875 * @since 1.2.0
    891  *
    892  * @uses is_user_logged_in()
    893  * @uses bp_get_user_meta()
    894  * @uses bp_activity_get_meta()
    895  * @uses bp_update_user_meta()
    896  * @uses bp_activity_update_meta()
    897  * @uses do_action() To call the 'bp_activity_add_user_favorite' hook.
    898  * @uses do_action() To call the 'bp_activity_add_user_favorite_fail' hook.
    899876 *
    900877 * @param int $activity_id ID of the activity item being favorited.
     
    972949 * @since 1.2.0
    973950 *
    974  * @uses is_user_logged_in()
    975  * @uses bp_get_user_meta()
    976  * @uses bp_activity_get_meta()
    977  * @uses bp_activity_update_meta()
    978  * @uses bp_update_user_meta()
    979  * @uses do_action() To call the 'bp_activity_remove_user_favorite' hook.
    980  *
    981951 * @param int $activity_id ID of the activity item being unfavorited.
    982952 * @param int $user_id     ID of the user unfavoriting the activity item.
     
    10511021 * @since 1.1.0
    10521022 *
    1053  * @uses BP_Activity_Activity::check_exists_by_content() {@link BP_Activity_Activity}
    1054  * @uses apply_filters() To call the 'bp_activity_check_exists_by_content' hook.
    1055  *
    10561023 * @param string $content The content to filter by.
    10571024 * @return int|null The ID of the located activity item. Null if none is found.
     
    10741041 * @since 1.0.0
    10751042 *
    1076  * @uses BP_Activity_Activity::get_last_updated() {@link BP_Activity_Activity}
    1077  * @uses apply_filters() To call the 'bp_activity_get_last_updated' hook.
    1078  *
    10791043 * @return string Date last updated.
    10801044 */
     
    10951059 *
    10961060 * @since 1.2.0
    1097  *
    1098  * @uses BP_Activity_Activity::total_favorite_count() {@link BP_Activity_Activity}
    10991061 *
    11001062 * @param int $user_id ID of the user whose favorite count is being requested.
     
    11611123 * @since 1.2.0
    11621124 *
    1163  * @uses apply_filters() To call the 'bp_activity_get_meta' hook.
    1164  *
    11651125 * @param int    $activity_id ID of the activity item whose metadata is being requested.
    11661126 * @param string $meta_key    Optional. If present, only the metadata matching
     
    12391199 *
    12401200 * @since 1.5.0
    1241  *
    1242  * @uses is_user_logged_in()
    1243  * @uses bp_activity_delete()
    1244  * @uses bp_delete_user_meta()
    1245  * @uses do_action() To call the 'bp_activity_remove_data' hook.
    1246  * @uses do_action() To call the 'bp_activity_remove_all_user_data' hook.
    12471201 *
    12481202 * @param int $user_id ID of the user whose activity is being deleted.
     
    16721626 * @see BP_Activity_Activity::get() For more information on accepted arguments
    16731627 *      and the format of the returned value.
    1674  * @uses wp_parse_args()
    1675  * @uses wp_cache_get()
    1676  * @uses wp_cache_set()
    1677  * @uses BP_Activity_Activity::get() {@link BP_Activity_Activity}
    1678  * @uses apply_filters_ref_array() To call the 'bp_activity_get' hook.
    16791628 *
    16801629 * @param array|string $args See BP_Activity_Activity::get() for description.
     
    17831732 *
    17841733 * @see BP_Activity_Activity::get() For more information on accepted arguments.
    1785  * @uses wp_parse_args()
    1786  * @uses apply_filters() To call the 'bp_activity_get_specific' hook.
    1787  * @uses BP_Activity_Activity::get() {@link BP_Activity_Activity}
    17881734 *
    17891735 * @param array|string $args {
     
    18371783 *
    18381784 * @since 1.1.0
    1839  *
    1840  * @uses wp_parse_args()
    1841  * @uses BP_Activity_Activity::save() {@link BP_Activity_Activity}
    1842  * @uses BP_Activity_Activity::rebuild_activity_comment_tree() {@link BP_Activity_Activity}
    1843  * @uses wp_cache_delete()
    1844  * @uses do_action() To call the 'bp_activity_add' hook.
    18451785 *
    18461786 * @param array|string $args {
     
    19501890 * @since 1.2.0
    19511891 *
    1952  * @uses wp_parse_args()
    1953  * @uses bp_is_user_inactive()
    1954  * @uses bp_core_get_userlink()
    1955  * @uses bp_activity_add()
    1956  * @uses apply_filters() To call the 'bp_activity_new_update_action' hook.
    1957  * @uses apply_filters() To call the 'bp_activity_new_update_content' hook.
    1958  * @uses apply_filters() To call the 'bp_activity_new_update_primary_link' hook.
    1959  * @uses bp_update_user_meta()
    1960  * @uses wp_filter_kses()
    1961  * @uses do_action() To call the 'bp_activity_posted_update' hook.
    1962  *
    19631892 * @param array|string $args {
    19641893 *     @type string $content The content of the activity update.
     
    25632492 * @since 2.5.0 Add a new possible parameter $skip_notification for the array of arguments.
    25642493 *              Add the $primary_link parameter for the array of arguments.
    2565  *
    2566  * @uses wp_parse_args()
    2567  * @uses bp_activity_add()
    2568  * @uses apply_filters() To call the 'bp_activity_comment_action' hook.
    2569  * @uses apply_filters() To call the 'bp_activity_comment_content' hook.
    2570  * @uses wp_cache_delete()
    2571  * @uses do_action() To call the 'bp_activity_comment_posted' hook.
    25722494 *
    25732495 * @param array|string $args {
     
    27112633 *
    27122634 * @see BP_Activity_Activity::get() For more information on accepted arguments.
    2713  * @uses wp_parse_args()
    2714  * @uses apply_filters() To call the 'bp_activity_get_activity_id' hook.
    2715  * @uses BP_Activity_Activity::save() {@link BP_Activity_Activity}
    27162635 *
    27172636 * @param array|string $args See BP_Activity_Activity::get() for description.
     
    27692688 *
    27702689 * @see BP_Activity_Activity::get() For more information on accepted arguments.
    2771  * @uses wp_parse_args()
    2772  * @uses bp_activity_adjust_mention_count()
    2773  * @uses BP_Activity_Activity::delete() {@link BP_Activity_Activity}
    2774  * @uses do_action() To call the 'bp_before_activity_delete' hook.
    2775  * @uses bp_get_user_meta()
    2776  * @uses bp_delete_user_meta()
    2777  * @uses do_action() To call the 'bp_activity_delete' hook.
    2778  * @uses do_action() To call the 'bp_activity_deleted_activities' hook.
    2779  * @uses wp_cache_delete()
    27802690 *
    27812691 * @param array|string $args To delete specific activity items, use
     
    28632773     * @deprecated 1.2.0
    28642774     *
    2865      * @uses wp_parse_args()
    2866      * @uses bp_activity_delete()
    28672775     *
    28682776     * @param array|string $args See BP_Activity_Activity::get for a
     
    28882796     * @since 1.1.0
    28892797     *
    2890      * @uses bp_activity_delete()
    28912798     *
    28922799     * @param int $activity_id ID of the activity item to be deleted.
     
    29052812     * @deprecated 1.2.0
    29062813     *
    2907      * @uses bp_activity_delete()
    29082814     *
    29092815     * @param int    $user_id   The user id.
     
    29302836     * @deprecated 1.2.0
    29312837     *
    2932      * @uses bp_activity_delete()
    29332838     *
    29342839     * @param int    $user_id   The user id.
     
    29482853 * @since 1.2.0
    29492854 *
    2950  * @uses apply_filters() To call the 'bp_activity_delete_comment_pre' hook.
    2951  * @uses bp_activity_delete_children()
    2952  * @uses bp_activity_delete()
    2953  * @uses BP_Activity_Activity::rebuild_activity_comment_tree() {@link BP_Activity_Activity}
    2954  * @uses do_action() To call the 'bp_activity_delete_comment' hook.
    29552855 * @todo Why is an activity id required? We could look this up.
    29562856 * @todo Why do we encourage users to call this function directly? We could just
     
    30182918     * @since 1.2.0
    30192919     *
    3020      * @uses BP_Activity_Activity::get_child_comments() {@link BP_Activity_Activity}
    3021      * @uses bp_activity_delete_children()
    3022      * @uses bp_activity_delete()
    30232920     *
    30242921     * @param int $activity_id The ID of the "root" activity, ie the
     
    30552952 *
    30562953 * @since 1.2.0
    3057  *
    3058  * @uses bp_get_root_domain()
    3059  * @uses bp_get_activity_root_slug()
    3060  * @uses apply_filters_ref_array() To call the 'bp_activity_get_permalink' hook.
    30612954 *
    30622955 * @param int         $activity_id  The unique id of the activity object.
     
    31113004 * @since 1.2.0
    31123005 *
    3113  * @uses BP_Activity_Activity::hide_all_for_user() {@link BP_Activity_Activity}
    3114  *
    31153006 * @param int $user_id The ID of the user whose activity is being hidden.
    31163007 * @return bool True on success, false on failure.
     
    31333024 *
    31343025 * @since 1.2.0
    3135  *
    3136  * @uses esc_attr()
    3137  * @uses apply_filters() To call the 'bp_activity_thumbnail_content_images' hook.
    31383026 *
    31393027 * @param string      $content The content of the activity item.
     
    34953383 * @see bp_embed_activity_save_cache()
    34963384 *
    3497  * @uses add_filter() To attach 'bp_get_activity_id' to 'embed_post_id'.
    3498  * @uses add_filter() To attach 'bp_embed_activity_cache' to 'bp_embed_get_cache'.
    3499  * @uses add_action() To attach 'bp_embed_activity_save_cache' to 'bp_embed_update_cache'.
    35003385 */
    35013386function bp_activity_embed() {
     
    35203405 * @see bp_embed_activity_save_cache()
    35213406 *
    3522  * @uses add_filter() To attach 'bp_get_activity_comment_id' to 'embed_post_id'.
    3523  * @uses add_filter() To attach 'bp_embed_activity_cache' to 'bp_embed_get_cache'.
    3524  * @uses add_action() To attach 'bp_embed_activity_save_cache' to 'bp_embed_update_cache'.
    35253407 */
    35263408function bp_activity_comment_embed() {
     
    35373419 *
    35383420 * @see BP_Embed
    3539  * @uses add_filter() To attach create_function() to 'embed_post_id'.
    3540  * @uses add_filter() To attach 'bp_embed_activity_cache' to 'bp_embed_get_cache'.
    3541  * @uses add_action() To attach 'bp_embed_activity_save_cache' to 'bp_embed_update_cache'.
    35423421 *
    35433422 * @param object $activity The activity that is being expanded.
     
    35623441 *
    35633442 * @see bp_activity_comment_embed()
    3564  * @uses remove_filter() To remove 'bp_get_activity_comment_id' from 'embed_post_id'.
    35653443 */
    35663444function bp_activity_comment_embed_after_recurse() {
     
    35773455 *
    35783456 * @see BP_Embed::parse_oembed()
    3579  * @uses bp_activity_get_meta()
    35803457 *
    35813458 * @param string $cache    An empty string passed by BP_Embed::parse_oembed() for
     
    35973474 *
    35983475 * @see BP_Embed::parse_oembed()
    3599  * @uses bp_activity_update_meta()
    36003476 *
    36013477 * @param string $cache    An empty string passed by BP_Embed::parse_oembed() for
     
    36133489 * @since 2.0.0
    36143490 *
    3615  * @uses bp_is_activity_heartbeat_active() to check if heartbeat setting is on.
    3616  * @uses bp_is_activity_directory() to check if the current page is the activity
    36173491 *       directory.
    3618  * @uses bp_is_group_activity() to check if on a single group, the current page
    36193492 *       is the group activities.
    36203493 *
Note: See TracChangeset for help on using the changeset viewer.