Skip to:
Content

BuddyPress.org

Changeset 10825


Ignore:
Timestamp:
05/29/2016 06:12:08 PM (4 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.

Location:
trunk/src
Files:
65 edited

Legend:

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

    r10551 r10825  
    1818 * @since 1.2.0
    1919 *
    20  * @uses do_action() To call 'bp_register_activity_actions' hook.
    2120 */
    2221function bp_register_activity_actions() {
     
    3534 *
    3635 * @since 1.2.0
    37  *
    38  * @uses bp_is_activity_component()
    39  * @uses bp_is_current_action()
    40  * @uses bp_action_variable()
    41  * @uses bp_activity_get_specific()
    42  * @uses bp_is_active()
    43  * @uses bp_core_get_user_domain()
    44  * @uses groups_get_group()
    45  * @uses bp_get_group_permalink()
    46  * @uses apply_filters_ref_array() To call the 'bp_activity_permalink_redirect_url' hook.
    47  * @uses bp_core_redirect()
    48  * @uses bp_get_root_domain()
    4936 *
    5037 * @return bool False on failure.
     
    123110 * @since 1.1.0
    124111 *
    125  * @uses bp_is_activity_component()
    126  * @uses bp_is_current_action()
    127  * @uses bp_action_variable()
    128  * @uses check_admin_referer()
    129  * @uses bp_activity_user_can_delete()
    130  * @uses do_action() Calls 'bp_activity_before_action_delete_activity' hook to allow actions to be taken before the activity is deleted.
    131  * @uses bp_activity_delete()
    132  * @uses bp_core_add_message()
    133  * @uses do_action() Calls 'bp_activity_action_delete_activity' hook to allow actions to be taken after the activity is deleted.
    134  * @uses bp_core_redirect()
    135  *
    136112 * @param int $activity_id Activity id to be deleted. Defaults to 0.
    137113 * @return bool False on failure.
     
    267243 *
    268244 * @since 1.2.0
    269  *
    270  * @uses is_user_logged_in()
    271  * @uses bp_is_activity_component()
    272  * @uses bp_is_current_action()
    273  * @uses check_admin_referer()
    274  * @uses apply_filters() To call 'bp_activity_post_update_content' hook.
    275  * @uses apply_filters() To call 'bp_activity_post_update_object' hook.
    276  * @uses apply_filters() To call 'bp_activity_post_update_item_id' hook.
    277  * @uses bp_core_add_message()
    278  * @uses bp_core_redirect()
    279  * @uses bp_activity_post_update()
    280  * @uses groups_post_update()
    281  * @uses bp_core_redirect()
    282  * @uses apply_filters() To call 'bp_activity_custom_update' hook.
    283245 *
    284246 * @return bool False on failure.
     
    372334 * @since 1.2.0
    373335 *
    374  * @uses is_user_logged_in()
    375  * @uses bp_is_activity_component()
    376  * @uses bp_is_current_action()
    377  * @uses check_admin_referer()
    378  * @uses apply_filters() To call 'bp_activity_post_comment_activity_id' hook.
    379  * @uses apply_filters() To call 'bp_activity_post_comment_content' hook.
    380  * @uses bp_core_add_message()
    381  * @uses bp_core_redirect()
    382  * @uses bp_activity_new_comment()
    383  * @uses wp_get_referer()
    384  *
    385336 * @return bool False on failure.
    386337 */
     
    436387 * @since 1.2.0
    437388 *
    438  * @uses is_user_logged_in()
    439  * @uses bp_is_activity_component()
    440  * @uses bp_is_current_action()
    441  * @uses check_admin_referer()
    442  * @uses bp_activity_add_user_favorite()
    443  * @uses bp_action_variable()
    444  * @uses bp_core_add_message()
    445  * @uses bp_core_redirect()
    446  * @uses wp_get_referer()
    447  *
    448389 * @return bool False on failure.
    449390 */
     
    470411 * @since 1.2.0
    471412 *
    472  * @uses is_user_logged_in()
    473  * @uses bp_is_activity_component()
    474  * @uses bp_is_current_action()
    475  * @uses check_admin_referer()
    476  * @uses bp_activity_remove_user_favorite()
    477  * @uses bp_action_variable()
    478  * @uses bp_core_add_message()
    479  * @uses bp_core_redirect()
    480  * @uses wp_get_referer()
    481  *
    482413 * @return bool False on failure.
    483414 */
     
    504435 * @since 1.0.0
    505436 *
    506  * @uses bp_is_activity_component()
    507  * @uses bp_is_current_action()
    508  * @uses bp_is_user()
    509  * @uses status_header()
    510  *
    511437 * @return bool False on failure.
    512438 */
     
    536462 * @since 1.0.0
    537463 *
    538  * @uses bp_is_user_activity()
    539  * @uses bp_is_current_action()
    540  * @uses status_header()
    541  *
    542464 * @return bool False on failure.
    543465 */
     
    566488 * @since 1.0.0
    567489 *
    568  * @uses bp_is_active()
    569  * @uses bp_is_user_activity()
    570  * @uses bp_is_current_action()
    571  * @uses bp_get_friends_slug()
    572  * @uses bp_is_action_variable()
    573  * @uses status_header()
    574  *
    575490 * @return bool False on failure.
    576491 */
     
    598513 *
    599514 * @since 1.2.0
    600  *
    601  * @uses bp_is_active()
    602  * @uses bp_is_user_activity()
    603  * @uses bp_is_current_action()
    604  * @uses bp_get_groups_slug()
    605  * @uses bp_is_action_variable()
    606  * @uses status_header()
    607515 *
    608516 * @return bool False on failure.
     
    640548 * @since 1.2.0
    641549 *
    642  * @uses bp_is_user_activity()
    643  * @uses bp_is_current_action()
    644  * @uses bp_is_action_variable()
    645  * @uses status_header()
    646  *
    647550 * @return bool False on failure.
    648551 */
     
    676579 *
    677580 * @since 1.2.0
    678  *
    679  * @uses bp_is_user_activity()
    680  * @uses bp_is_current_action()
    681  * @uses bp_is_action_variable()
    682  * @uses status_header()
    683581 *
    684582 * @return bool False on failure.
  • trunk/src/bp-activity/bp-activity-filters.php

    r10572 r10825  
    179179 *
    180180 * @since 1.1.0
    181  *
    182  * @uses apply_filters() To call the 'bp_activity_allowed_tags' hook.
    183  * @uses wp_kses()
    184181 *
    185182 * @param string $content The activity content.
     
    283280 * @since 1.5.0
    284281 *
    285  * @uses bp_activity_find_mentions()
    286  *
    287282 * @param BP_Activity_Activity $activity Activity Object.
    288283 */
     
    319314 *
    320315 * @since 1.7.0
    321  *
    322  * @uses bp_activity_at_message_notification()
    323  * @uses bp_activity_update_mention_count_for_user()
    324316 *
    325317 * @param BP_Activity_Activity $activity The BP_Activity_Activity object.
     
    397389 * @since 1.5.0
    398390 *
    399  * @uses bp_is_single_activity()
    400  * @uses apply_filters() To call the 'bp_activity_excerpt_append_text' hook.
    401  * @uses apply_filters() To call the 'bp_activity_excerpt_length' hook.
    402  * @uses bp_create_excerpt()
    403  * @uses bp_get_activity_id()
    404  * @uses bp_get_activity_thread_permalink()
    405  * @uses apply_filters() To call the 'bp_activity_truncate_entry' hook.
    406  *
    407391 * @param string $text The original activity entry text.
    408392 * @return string $excerpt The truncated text.
     
    477461 * @since 2.0.0
    478462 *
    479  * @uses bp_activity_do_heartbeat() to check if heartbeat is required.
    480  *
    481463 * @param array $js_handles The original dependencies.
    482464 * @return array $js_handles The new dependencies.
     
    543525 *
    544526 * @since 2.0.0
    545  *
    546  * @uses bp_activity_get_last_updated() to get the recorded date of the last activity.
    547527 *
    548528 * @param array $response Array containing Heartbeat API response.
  • 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 *
  • trunk/src/bp-activity/bp-activity-notifications.php

    r10715 r10825  
    1717 *
    1818 * @since 1.2.0
    19  *
    20  * @uses bp_notifications_add_notification()
    21  * @uses bp_get_user_meta()
    22  * @uses bp_core_get_user_displayname()
    23  * @uses bp_activity_get_permalink()
    24  * @uses bp_core_get_user_domain()
    25  * @uses bp_get_settings_slug()
    26  * @uses bp_activity_filter_kses()
    27  * @uses bp_core_get_core_userdata()
    28  * @uses wp_specialchars_decode()
    29  * @uses get_blog_option()
    30  * @uses bp_is_active()
    31  * @uses bp_is_group()
    32  * @uses bp_get_current_group_name()
    33  * @uses apply_filters() To call the 'bp_activity_at_message_notification_to' hook.
    34  * @uses apply_filters() To call the 'bp_activity_at_message_notification_subject' hook.
    35  * @uses apply_filters() To call the 'bp_activity_at_message_notification_message' hook.
    36  * @uses wp_mail()
    37  * @uses do_action() To call the 'bp_activity_sent_mention_email' hook.
    3819 *
    3920 * @param int $activity_id      The ID of the activity update.
     
    10889 * @since 1.2.0
    10990 * @since 2.5.0 Updated to use new email APIs.
    110  *
    111  * @uses bp_get_user_meta()
    112  * @uses bp_core_get_user_displayname()
    113  * @uses bp_activity_get_permalink()
    114  * @uses bp_core_get_user_domain()
    115  * @uses bp_get_settings_slug()
    116  * @uses bp_activity_filter_kses()
    117  * @uses bp_core_get_core_userdata()
    118  * @uses wp_specialchars_decode()
    119  * @uses get_blog_option()
    120  * @uses bp_get_root_blog_id()
    121  * @uses apply_filters() To call the 'bp_activity_new_comment_notification_to' hook.
    122  * @uses apply_filters() To call the 'bp_activity_new_comment_notification_subject' hook.
    123  * @uses apply_filters() To call the 'bp_activity_new_comment_notification_message' hook.
    124  * @uses wp_mail()
    125  * @uses do_action() To call the 'bp_activity_sent_reply_to_update_email' hook.
    126  * @uses apply_filters() To call the 'bp_activity_new_comment_notification_comment_author_to' hook.
    127  * @uses apply_filters() To call the 'bp_activity_new_comment_notification_comment_author_subject' hook.
    128  * @uses apply_filters() To call the 'bp_activity_new_comment_notification_comment_author_message' hook.
    129  * @uses do_action() To call the 'bp_activity_sent_reply_to_reply_email' hook.
    13091 *
    13192 * @param int   $comment_id   The comment id.
     
    243204 * @since 1.5.0
    244205 *
    245  * @uses bp_loggedin_user_domain()
    246  * @uses bp_get_activity_slug()
    247  * @uses bp_core_get_user_displayname()
    248  * @uses apply_filters() To call the 'bp_activity_multiple_at_mentions_notification' hook.
    249  * @uses apply_filters() To call the 'bp_activity_single_at_mentions_notification' hook.
    250  * @uses do_action() To call 'activity_format_notifications' hook.
    251  *
    252206 * @param string $action            The type of activity item. Just 'new_at_mention' for now.
    253207 * @param int    $item_id           The activity ID.
     
    454408 *
    455409 * @param int $user_id The id of the user whose notifications are marked as read.
    456  * @uses bp_notifications_mark_all_notifications_by_type()
    457410 */
    458411function bp_activity_remove_screen_notifications( $user_id = 0 ) {
  • trunk/src/bp-activity/bp-activity-screens.php

    r10652 r10825  
    2424 * @since 1.5.0
    2525 *
    26  * @uses bp_displayed_user_id()
    27  * @uses bp_is_activity_component()
    28  * @uses bp_current_action()
    29  * @uses bp_update_is_directory()
    30  * @uses do_action() To call the 'bp_activity_screen_index' hook.
    31  * @uses bp_core_load_template()
    32  * @uses apply_filters() To call the 'bp_activity_screen_index' hook.
    3326 */
    3427function bp_activity_screen_index() {
     
    6053 * @since 1.0.0
    6154 *
    62  * @uses do_action() To call the 'bp_activity_screen_my_activity' hook.
    63  * @uses bp_core_load_template()
    64  * @uses apply_filters() To call the 'bp_activity_template_my_activity' hook.
    6555 */
    6656function bp_activity_screen_my_activity() {
     
    8878 * @since 1.0.0
    8979 *
    90  * @uses bp_is_active()
    91  * @uses bp_update_is_item_admin()
    92  * @uses bp_current_user_can()
    93  * @uses do_action() To call the 'bp_activity_screen_friends' hook.
    94  * @uses bp_core_load_template()
    95  * @uses apply_filters() To call the 'bp_activity_template_friends_activity' hook.
    9680 */
    9781function bp_activity_screen_friends() {
     
    123107 * @since 1.2.0
    124108 *
    125  * @uses bp_is_active()
    126  * @uses bp_update_is_item_admin()
    127  * @uses bp_current_user_can()
    128  * @uses do_action() To call the 'bp_activity_screen_groups' hook.
    129  * @uses bp_core_load_template()
    130  * @uses apply_filters() To call the 'bp_activity_template_groups_activity' hook.
    131109 */
    132110function bp_activity_screen_groups() {
     
    158136 * @since 1.2.0
    159137 *
    160  * @uses bp_update_is_item_admin()
    161  * @uses bp_current_user_can()
    162  * @uses do_action() To call the 'bp_activity_screen_favorites' hook.
    163  * @uses bp_core_load_template()
    164  * @uses apply_filters() To call the 'bp_activity_template_favorite_activity' hook.
    165138 */
    166139function bp_activity_screen_favorites() {
     
    189162 * @since 1.2.0
    190163 *
    191  * @uses bp_update_is_item_admin()
    192  * @uses bp_current_user_can()
    193  * @uses do_action() To call the 'bp_activity_screen_mentions' hook.
    194  * @uses bp_core_load_template()
    195  * @uses apply_filters() To call the 'bp_activity_template_mention_activity' hook.
    196164 */
    197165function bp_activity_screen_mentions() {
     
    220188 * @since 1.5.0
    221189 *
    222  * @uses bp_is_my_profile()
    223  * @uses bp_activity_clear_new_mentions()
    224  * @uses bp_loggedin_user_id()
    225190 */
    226191function bp_activity_reset_my_new_mentions() {
     
    235200 * @since 1.2.0
    236201 *
    237  * @uses bp_is_activity_component()
    238  * @uses bp_activity_get_specific()
    239  * @uses bp_current_action()
    240  * @uses bp_action_variables()
    241  * @uses bp_do_404()
    242  * @uses bp_is_active()
    243  * @uses groups_get_group()
    244  * @uses groups_is_user_member()
    245  * @uses apply_filters_ref_array() To call the 'bp_activity_permalink_access' hook.
    246  * @uses do_action() To call the 'bp_activity_screen_single_activity_permalink' hook.
    247  * @uses bp_core_add_message()
    248  * @uses is_user_logged_in()
    249  * @uses bp_core_redirect()
    250  * @uses site_url()
    251  * @uses esc_url()
    252  * @uses bp_get_root_domain()
    253  * @uses bp_get_activity_root_slug()
    254  * @uses bp_core_load_template()
    255  * @uses apply_filters() To call the 'bp_activity_template_profile_activity_permalink' hook.
    256202 */
    257203function bp_activity_screen_single_activity_permalink() {
     
    359305 * @since 1.2.0
    360306 *
    361  * @uses bp_get_user_meta()
    362  * @uses bp_core_get_username()
    363  * @uses do_action() To call the 'bp_activity_screen_notification_settings' hook.
    364307 */
    365308function bp_activity_screen_notification_settings() {
  • 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 = '' ) {
  • trunk/src/bp-activity/classes/class-bp-activity-component.php

    r10722 r10825  
    133133     *
    134134     * @see BP_Component::setup_nav() for a description of arguments.
    135      * @uses bp_is_active()
    136      * @uses is_user_logged_in()
    137      * @uses bp_get_friends_slug()
    138      * @uses bp_get_groups_slug()
    139135     *
    140136     * @param array $main_nav Optional. See BP_Component::setup_nav() for description.
     
    242238     * @see BP_Component::setup_nav() for a description of the $wp_admin_nav
    243239     *      parameter array.
    244      * @uses is_user_logged_in()
    245      * @uses trailingslashit()
    246      * @uses bp_get_total_mention_count_for_user()
    247      * @uses bp_loggedin_user_id()
    248      * @uses bp_is_active()
    249      * @uses bp_get_friends_slug()
    250      * @uses bp_get_groups_slug()
    251240     *
    252241     * @param array $wp_admin_nav See BP_Component::setup_admin_bar() for a
     
    345334     * @since 1.5.0
    346335     *
    347      * @uses bp_is_activity_component()
    348      * @uses bp_is_my_profile()
    349      * @uses bp_core_fetch_avatar()
    350336     */
    351337    public function setup_title() {
  • trunk/src/bp-blogs/bp-blogs-filters.php

    r10544 r10825  
    2626 * @since 1.6.0
    2727 *
    28  * @uses apply_filters() Filter 'bp_blogs_creation_location' to alter the
    2928 *       returned value.
    3029 *
  • trunk/src/bp-blogs/bp-blogs-functions.php

    r10815 r10825  
    241241 * @since 1.7.0
    242242 *
    243  * @uses apply_filters()
    244  *
    245243 * @param int $blog_id ID of the blog being checked.
    246244 * @param int $user_id Optional. ID of the user for whom access is being checked.
     
    272270 * @since 1.7.0
    273271 *
    274  * @uses bp_blogs_is_blog_recordable
    275  * @uses apply_filters()
    276  *
    277272 * @param int $blog_id ID of the blog being checked.
    278273 * @param int $user_id Optional. ID of the user for whom access is being checked.
     
    300295 *
    301296 * @since 1.0.0
    302  *
    303  * @uses BP_Blogs_Blog
    304297 *
    305298 * @param int  $blog_id     ID of the blog being recorded.
  • trunk/src/bp-blogs/bp-blogs-template.php

    r10785 r10825  
    2020 * @since 1.5.0
    2121 *
    22  * @uses bp_get_blogs_slug()
    2322 */
    2423function bp_blogs_slug() {
     
    4948 * @since 1.5.0
    5049 *
    51  * @uses bp_get_blogs_root_slug()
    5250 */
    5351function bp_blogs_root_slug() {
     
    7876 * @since 1.5.0
    7977 *
    80  * @uses bp_get_blogs_directory_permalink()
    8178 */
    8279function bp_blogs_directory_permalink() {
     
    8885     * @since 1.5.0
    8986     *
    90      * @uses apply_filters()
    91      * @uses trailingslashit()
    92      * @uses bp_get_root_domain()
    93      * @uses bp_get_blogs_root_slug()
    9487     *
    9588     * @return string The URL of the Blogs directory.
     
    719712 * @since 1.7.0
    720713 *
    721  * @uses bp_get_blog_latest_post_content()
    722714 */
    723715function bp_blog_latest_post_content() {
     
    13421334 * @since 2.2.0
    13431335 *
    1344  * @uses bp_blog_create_nav_item() to output the Create a Site nav item.
    1345  *
    13461336 * @return string HTML Output
    13471337 */
     
    14241414 * @since 2.0.0
    14251415 *
    1426  * @uses bp_blogs_admin_get_profile_stats() to get the stats.
    1427  *
    14281416 * @param array|string $args Before|after|user_id.
    14291417 */
  • trunk/src/bp-core/admin/bp-core-admin-actions.php

    r10430 r10825  
    107107 * @since 1.7.0
    108108 *
    109  * @uses do_action() Calls 'bp_admin_init'.
    110109 */
    111110function bp_admin_init() {
     
    124123 * @since 1.7.0
    125124 *
    126  * @uses do_action() Calls 'bp_admin_menu'.
    127125 */
    128126function bp_admin_menu() {
     
    141139 * @since 1.7.0
    142140 *
    143  * @uses do_action() Calls 'bp_admin_head'.
    144141 */
    145142function bp_admin_head() {
     
    158155 * @since 1.7.0
    159156 *
    160  * @uses do_action() Calls 'bp_admin_notices'.
    161157 */
    162158function bp_admin_notices() {
     
    174170 *
    175171 * @since 1.7.0
    176  *
    177  * @uses do_action() Calls 'bp_admin_enqueue_scripts'.
    178172 *
    179173 * @param string $hook_suffix The current admin page, passed to
     
    197191 * @since 1.7.0
    198192 *
    199  * @uses do_action() Calls 'bp_admin_notices'.
    200193 */
    201194function bp_register_importers() {
     
    216209 * @since 1.7.0
    217210 *
    218  * @uses do_action() Calls 'bp_admin_notices'.
    219211 */
    220212function bp_register_admin_style() {
     
    233225 * @since 1.7.0
    234226 *
    235  * @uses do_action() Calls 'bp_register_admin_settings'.
    236227 */
    237228function bp_register_admin_settings() {
  • trunk/src/bp-core/admin/bp-core-admin-components.php

    r10739 r10825  
    1616 * @since 1.6.0
    1717 *
    18  * @uses bp_core_admin_component_options()
    1918 */
    2019function bp_core_admin_components_settings() {
  • trunk/src/bp-core/admin/bp-core-admin-functions.php

    r10751 r10825  
    1616 * Initializes the wp-admin area "BuddyPress" menus and sub menus.
    1717 *
    18  * @uses bp_current_user_can() returns true if the current user is a site admin, false if not.
    1918 */
    2019function bp_core_admin_menu_init() {
     
    124123 * @since 1.5.0
    125124 *
    126  * @uses bp_current_user_can() to check current user permissions before showing the notices.
    127  * @uses bp_is_root_blog()
    128125 */
    129126function bp_core_print_admin_notices() {
     
    354351 * @internal Used internally to redirect BuddyPress to the about page on activation.
    355352 *
    356  * @uses get_transient() To see if transient to redirect exists.
    357  * @uses delete_transient() To delete the transient if it exists.
    358  * @uses is_network_admin() To bail if being network activated.
    359  * @uses wp_safe_redirect() To redirect.
    360  * @uses add_query_arg() To help build the URL to redirect to.
    361  * @uses admin_url() To get the admin URL to index.php.
    362353 */
    363354function bp_do_activation_redirect() {
     
    617608 * @since 1.7.0
    618609 *
    619  * @uses bp_current_user_can() To check users capability on root blog.
    620610 */
    621611function bp_admin_separator() {
     
    652642 * @since 1.7.0
    653643 *
    654  * @uses bp_current_user_can() To check users capability on root blog.
    655  *
    656644 * @param bool $menu_order Menu order.
    657645 * @return bool Always true.
     
    671659 *
    672660 * @since 1.7.0
    673  *
    674  * @uses bp_current_user_can() To check users capability on root blog.
    675661 *
    676662 * @param array $menu_order Menu Order.
  • trunk/src/bp-core/admin/bp-core-admin-schema.php

    r10647 r10825  
    9191 * @since 1.0.0
    9292 *
    93  * @uses bp_core_set_charset()
    94  * @uses bp_core_get_table_prefix()
    95  * @uses dbDelta()
    9693 */
    9794function bp_core_install_notifications() {
     
    135132 * @since 1.0.0
    136133 *
    137  * @uses bp_core_set_charset()
    138  * @uses bp_core_get_table_prefix()
    139  * @uses dbDelta()
    140134 */
    141135function bp_core_install_activity_streams() {
     
    188182 * @since 1.0.0
    189183 *
    190  * @uses bp_core_set_charset()
    191  * @uses bp_core_get_table_prefix()
    192  * @uses dbDelta()
    193184 */
    194185function bp_core_install_friends() {
     
    216207 * @since 1.0.0
    217208 *
    218  * @uses bp_core_set_charset()
    219  * @uses bp_core_get_table_prefix()
    220  * @uses dbDelta()
    221209 */
    222210function bp_core_install_groups() {
     
    276264 * @since 1.0.0
    277265 *
    278  * @uses bp_core_set_charset()
    279  * @uses bp_core_get_table_prefix()
    280  * @uses dbDelta()
    281266 */
    282267function bp_core_install_private_messaging() {
     
    336321 * @since 1.0.0
    337322 *
    338  * @uses bp_core_set_charset()
    339  * @uses bp_core_get_table_prefix()
    340  * @uses dbDelta()
    341323 */
    342324function bp_core_install_extended_profiles() {
     
    426408 * @since 1.0.0
    427409 *
    428  * @uses bp_core_set_charset()
    429  * @uses bp_core_get_table_prefix()
    430  * @uses dbDelta()
    431410 */
    432411function bp_core_install_blog_tracking() {
     
    463442 *
    464443 * @global $wpdb
    465  * @uses wp_get_db_schema() to get WordPress ms_global schema
    466444 */
    467445function bp_core_install_signups() {
  • trunk/src/bp-core/admin/bp-core-admin-settings.php

    r10565 r10825  
    2323 * @since 1.6.0
    2424 *
    25  * @uses bp_form_option() To output the option value.
    2625 */
    2726function bp_admin_setting_callback_admin_bar() {
     
    3938 * @since 1.6.0
    4039 *
    41  * @uses checked() To display the checked attribute.
    4240 */
    4341function bp_admin_setting_callback_account_deletion() {
     
    6462 * @since 1.6.0
    6563 *
    66  * @uses checked() To display the checked attribute.
    6764 */
    6865function bp_admin_setting_callback_activity_akismet() {
     
    133130 * @since 1.6.0
    134131 *
    135  * @uses bp_form_option() To output the option value.
    136132 */
    137133function bp_admin_setting_callback_profile_sync() {
     
    149145 * @since 1.6.0
    150146 *
    151  * @uses checked() To display the checked attribute.
    152147 */
    153148function bp_admin_setting_callback_avatar_uploads() {
     
    186181 * @since 1.6.0
    187182 *
    188  * @uses checked() To display the checked attribute.
    189183 */
    190184function bp_admin_setting_callback_group_creation() {
     
    236230 * @since 1.6.0
    237231 *
    238  * @uses checked() To display the checked attribute.
    239  * @uses bp_get_option() To get the config location.
    240  * @uses bp_form_option() To get the sanitized form option.
    241232 */
    242233function bp_admin_setting_callback_bbpress_configuration() {
     
    266257 * @since 1.6.0
    267258 *
    268  * @uses settings_fields() To output the hidden fields for the form.
    269  * @uses do_settings_sections() To output the settings sections.
    270259 */
    271260function bp_core_admin_settings() {
     
    351340 * @since 1.6.0
    352341 *
    353  * @uses bp_get_bp_form_option()
    354  *
    355342 * @param string $option  Form option to echo.
    356343 * @param string $default Form option default.
     
    365352     * @since 1.6.0
    366353     *
    367      * @uses bp_get_option()
    368      * @uses esc_attr()
    369      * @uses apply_filters()
    370354     *
    371355     * @param string $option  Form option to return.
  • trunk/src/bp-core/admin/bp-core-admin-slugs.php

    r10559 r10825  
    1616 * @since 1.6.0
    1717 * @todo Use settings API
    18  * @uses bp_core_admin_component_options()
    1918 */
    2019function bp_core_admin_slugs_settings() {
  • trunk/src/bp-core/bp-core-admin.php

    r10652 r10825  
    2020 * @since 1.6.0
    2121 *
    22  * @uses BP_Admin
    2322 */
    2423function bp_admin() {
  • trunk/src/bp-core/bp-core-adminbar.php

    r10417 r10825  
    5656 *
    5757 * @global string $wp_version
    58  * @uses bp_get_option()
    59  * @uses is_user_logged_in()
    60  * @uses bp_use_wp_admin_bar()
    61  * @uses show_admin_bar()
    62  * @uses add_action() To hook 'bp_adminbar_logo' to 'bp_adminbar_logo'.
    63  * @uses add_action() To hook 'bp_adminbar_login_menu' to 'bp_adminbar_menus'.
    64  * @uses add_action() To hook 'bp_adminbar_account_menu' to 'bp_adminbar_menus'.
    65  * @uses add_action() To hook 'bp_adminbar_thisblog_menu' to 'bp_adminbar_menus'.
    66  * @uses add_action() To hook 'bp_adminbar_random_menu' to 'bp_adminbar_menus'.
    67  * @uses add_action() To hook 'bp_core_admin_bar' to 'wp_footer'.
    68  * @uses add_action() To hook 'bp_core_admin_bar' to 'admin_footer'.
    6958 */
    7059function bp_core_load_admin_bar() {
  • trunk/src/bp-core/bp-core-avatars.php

    r10757 r10825  
    16411641 * @since 1.2.0
    16421642 *
    1643  * @uses bp_core_get_upload_dir() To get upload directory info.
    1644  *
    16451643 * @return string Absolute path to WP upload directory.
    16461644 */
     
    16611659 *
    16621660 * @since 1.2.0
    1663  *
    1664  * @uses bp_core_get_upload_dir() To get upload directory info.
    16651661 *
    16661662 * @return string Full URL to current upload location.
     
    19501946 * @since  2.2.0
    19511947 *
    1952  * @uses   bp_is_group_create()
    1953  * @uses   bp_is_group_admin_page()
    1954  * @uses   bp_is_group_admin_screen() to check for a group admin screen
    1955  * @uses   bp_action_variable() to check for the group's avatar creation step
    1956  * @uses   bp_is_user_change_avatar() to check for the user's change profile screen
    1957  *
    19581948 * @param WP_Query|null $posts_query The main query object.
    19591949 */
  • trunk/src/bp-core/bp-core-buddybar.php

    r10745 r10825  
    904904 * @since 1.5.0
    905905 *
    906  * @uses get_user_option()
    907  *
    908906 * @param string $context Context of this preference check. 'admin' or 'front'.
    909907 * @param int    $user    Optional. ID of the user to check. Default: 0 (which falls back to the logged-in user's ID).
  • trunk/src/bp-core/bp-core-caps.php

    r10497 r10825  
    5858 * @since 1.6.0
    5959 *
    60  * @uses get_role() To get the administrator, default and moderator roles.
    61  * @uses WP_Role::add_cap() To add various capabilities.
    62  * @uses do_action() Calls 'bp_add_caps'.
    6360 */
    6461function bp_add_caps() {
     
    9491 * @since 1.6.0
    9592 *
    96  * @uses get_role() To get the administrator and default roles.
    97  * @uses WP_Role::remove_cap() To remove various capabilities.
    98  * @uses do_action() Calls 'bp_remove_caps'.
    9993 */
    10094function bp_remove_caps() {
     
    130124 * @see WP_User::has_cap() for description of the arguments passed to the
    131125 *      'map_meta_cap' filter.
    132  * @uses apply_filters() Calls 'bp_map_meta_caps' with caps, cap, user ID and
    133126 *       args.
    134127 *
     
    159152 * @since 1.6.0
    160153 *
    161  * @uses apply_filters() Calls 'bp_get_community_caps' with the capabilities.
    162  *
    163154 * @return array Community capabilities.
    164155 */
     
    182173 *
    183174 * @since 1.6.0
    184  *
    185  * @uses apply_filters() Allow return value to be filtered.
    186175 *
    187176 * @param string $role The role for which you're loading caps.
     
    233222 * @global BuddyPress $bp Global BuddyPress settings object.
    234223 *
    235  * @uses is_multisite()
    236  * @uses bp_allow_global_access()
    237  * @uses bp_is_user_inactive()
    238  * @uses is_user_logged_in()
    239  * @uses current_user_can()
    240  * @uses WP_User::set_role()
    241224 */
    242225function bp_set_current_user_default_role() {
  • trunk/src/bp-core/bp-core-catchuri.php

    r10791 r10825  
    726726 *      $bp->canonical_stack['base_url'] and ['component'] may be set.
    727727 * @see bp_core_new_nav_item() where $bp->canonical_stack['action'] may be set.
    728  * @uses bp_get_canonical_url()
    729  * @uses bp_get_requested_url()
    730728 */
    731729function bp_redirect_canonical() {
     
    796794 *
    797795 * @since 1.6.0
    798  *
    799  * @uses apply_filters() Filter bp_get_canonical_url to modify return value.
    800796 *
    801797 * @param array $args {
     
    934930 * @since 1.6.0
    935931 *
    936  * @uses bp_is_blog_page()
    937932 */
    938933function _bp_maybe_remove_redirect_canonical() {
  • trunk/src/bp-core/bp-core-cssjs.php

    r10643 r10825  
    340340 * @since 2.0.0
    341341 *
    342  * @uses apply_filters() to allow other component to load extra dependencies.
    343  *
    344342 * @return array The JavaScript dependencies.
    345343 */
  • trunk/src/bp-core/bp-core-dependency.php

    r10823 r10825  
    217217 * @link https://core.trac.wordpress.org/ticket/24169
    218218 *
    219  * @uses did_action() To make sure the user isn't loaded out of order.
    220  * @uses do_action() Calls 'bp_setup_current_user'.
    221219 */
    222220function bp_setup_current_user() {
     
    410408 * @since 1.6.0
    411409 *
    412  * @uses do_action()
    413410 */
    414411function bp_template_redirect() {
     
    431428 * @since 1.5.0
    432429 *
    433  * @uses do_action()
    434430 */
    435431function bp_register_theme_directory() {
     
    452448 * @since 1.7.0
    453449 *
    454  * @uses do_action()
    455450 */
    456451function bp_register_theme_packages() {
     
    469464 * @since 1.6.0
    470465 *
    471  * @uses do_action() Calls 'bp_enqueue_scripts'.
    472466 */
    473467function bp_enqueue_scripts() {
     
    486480 * @since 1.8.0
    487481 *
    488  * @uses do_action() Calls 'bp_add_rewrite_tags'.
    489482 */
    490483function bp_add_rewrite_tags() {
     
    503496 * @since 1.9.0
    504497 *
    505  * @uses do_action() Calls 'bp_add_rewrite_rules'.
    506498 */
    507499function bp_add_rewrite_rules() {
     
    520512 * @since 1.9.0
    521513 *
    522  * @uses do_action() Calls 'bp_add_permastructs'.
    523514 */
    524515function bp_add_permastructs() {
     
    540531 * @since 1.6.0
    541532 *
    542  * @uses do_action() Calls 'bp_setup_theme'.
    543533 */
    544534function bp_setup_theme() {
     
    564554 * @since 1.6.0
    565555 *
    566  * @uses do_action() Calls 'bp_after_setup_theme'.
    567556 */
    568557function bp_after_setup_theme() {
     
    631620 * @since 1.6.0
    632621 *
    633  * @uses apply_filters()
    634  *
    635622 * @param string $template See 'template_include'.
    636623 * @return string Template file to use.
     
    653640 * @since 1.7.0
    654641 *
    655  * @uses do_action() Calls 'bp_generate_rewrite_rules' with {@link WP_Rewrite}.
    656  *
    657642 * @param WP_Rewrite $wp_rewrite See 'generate_rewrite_rules'.
    658643 */
     
    675660 *
    676661 * @since 1.7.0
    677  *
    678  * @uses apply_filters() Calls 'bp_allowed_themes' with the allowed themes list.
    679662 *
    680663 * @param array $themes The path of the template to include.
     
    700683 * @since 1.9.0
    701684 *
    702  * @uses do_action()
    703685 */
    704686function bp_post_request() {
     
    744726 * @since 1.9.0
    745727 *
    746  * @uses do_action()
    747728 */
    748729function bp_get_request() {
  • trunk/src/bp-core/bp-core-filters.php

    r10761 r10825  
    8181 * @since 1.5.0
    8282 *
    83  * @uses bp_is_active() checks if a BuddyPress component is active.
    84  *
    8583 * @param array $pages List of excluded page IDs, as passed to the
    8684 *                     'wp_list_pages_excludes' filter.
     
    119117 *
    120118 * @since 2.0.0
    121  *
    122  * @uses bp_is_root_blog() checks if current blog is root blog.
    123  * @uses buddypress() gets BuddyPress main instance
    124119 *
    125120 * @param object|null $object The post type object used in the meta box.
     
    287282 * @since 1.2.0
    288283 *
    289  * @uses apply_filters() Filter 'bp_core_login_redirect' to modify where users
    290284 *       are redirected to on login.
    291285 *
  • trunk/src/bp-core/bp-core-functions.php

    r10763 r10825  
    1818 * @since 1.6.0
    1919 *
    20  * @uses bp_get_version() To get the BuddyPress version.
    2120 */
    2221function bp_version() {
     
    3938 * @since 1.6.0
    4039 *
    41  * @uses bp_get_db_version() To get the BuddyPress database version.
    4240 */
    4341function bp_db_version() {
     
    6058 * @since 1.6.0
    6159 *
    62  * @uses bp_get_db_version_raw() To get the current database BuddyPress version.
    6360 */
    6461function bp_db_version_raw() {
     
    359356 * @since 1.5.0
    360357 *
    361  * @uses apply_filters() Filter 'bp_is_username_compatibility_mode' to alter.
    362358 * @todo Move to members component?
    363359 *
     
    384380 *
    385381 * @since 1.5.0
    386  *
    387  * @uses apply_filters() Filter 'bp_use_wp_admin_bar' to alter.
    388382 *
    389383 * @return bool Default: true. False when WP Toolbar support is disabled.
     
    924918 * @since 1.0.0
    925919 *
    926  * @uses get_blog_option() WordPress function to fetch blog meta.
    927  *
    928920 * @return string The domain URL for the blog.
    929921 */
     
    946938 *
    947939 * @since 1.0.0
    948  *
    949  * @uses wp_safe_redirect()
    950940 *
    951941 * @param string $location The redirect URL.
     
    10771067 *
    10781068 * @since 1.0.0
    1079  *
    1080  * @uses apply_filters() Filter 'bp_core_time_since_pre' to bypass BP's calculations.
    1081  * @uses apply_filters() Filter 'bp_core_time_since' to modify BP's calculations.
    10821069 *
    10831070 * @param int|string $older_date The earlier time from which you're calculating
     
    13171304 * @since 1.1.0
    13181305 *
    1319  * @uses setcookie() Sets a cookie value for the user.
    13201306 */
    13211307function bp_core_setup_message() {
     
    14011387 * @since 1.0.0
    14021388 *
    1403  * @uses bp_update_user_meta() BP function to update user metadata in the
    14041389 *       usermeta table.
    14051390 *
     
    14591444 * @since 1.0.0
    14601445 *
    1461  * @uses bp_core_time_since() This function will return an English
    14621446 *       representation of the time elapsed.
    14631447 *
     
    15101494 * @since 1.5.0
    15111495 *
    1512  * @uses apply_filters() Filter 'bp_get_user_meta_key' to modify keys individually.
    1513  *
    15141496 * @param string|bool $key The usermeta meta_key.
    15151497 * @return string $key The usermeta meta_key.
     
    15371519 *
    15381520 * @see get_user_meta() For complete details about parameters and return values.
    1539  * @uses bp_get_user_meta_key() For a filterable version of the meta key.
    15401521 *
    15411522 * @param int    $user_id The ID of the user whose meta you're fetching.
     
    15591540 *
    15601541 * @see update_user_meta() For complete details about parameters and return values.
    1561  * @uses bp_get_user_meta_key() For a filterable version of the meta key.
    15621542 *
    15631543 * @param int    $user_id    The ID of the user whose meta you're setting.
     
    15811561 *
    15821562 * @see delete_user_meta() For complete details about parameters and return values.
    1583  * @uses bp_get_user_meta_key() For a filterable version of the meta key.
    15841563 *
    15851564 * @param int    $user_id The ID of the user whose meta you're deleting.
     
    17101689     * @since 1.5.0
    17111690     *
    1712      * @uses bp_core_do_network_admin()
    1713      * @uses network_admin_url()
    1714      * @uses admin_url()
    17151691     *
    17161692     * @param string $path   Optional. The sub-path under /wp-admin to be
     
    17441720 * @since 1.5.0
    17451721 *
    1746  * @uses bp_is_network_activated()
    1747  * @uses bp_is_multiblog_mode()
    1748  *
    17491722 * @return bool True if the BP admin screen should appear in the Network Admin,
    17501723 *              otherwise false.
     
    18791852 * @since 1.5.0
    18801853 *
    1881  * @uses apply_filters() Filter 'bp_is_multiblog_mode' to alter.
    1882  *
    18831854 * @return bool False when multiblog mode is disabled; true when enabled.
    18841855 *              Default: false.
     
    20672038 *
    20682039 * @since 1.6.0
    2069  *
    2070  * @uses do_action() Calls 'bp_verify_nonce_request' on $action.
    20712040 *
    20722041 * @param string $action    Action nonce.
     
    26912660 * @since 2.3.0
    26922661 *
    2693  * @uses  is_multisite()
    2694  * @uses  bp_is_root_blog()
    2695  * @uses  switch_to_blog()
    2696  * @uses  wp_upload_dir()
    2697  * @uses  restore_current_blog()
    2698  *
    26992662 * @return string
    27002663 */
  • trunk/src/bp-core/bp-core-moderation.php

    r10356 r10825  
    2020 *
    2121 * @since 1.6.0
    22  *
    23  * @uses current_user_can() To check if the current user can throttle.
    24  * @uses bp_get_option() To get the throttle time.
    25  * @uses get_transient() To get the last posted transient of the ip.
    26  * @uses get_user_meta() To get the last posted meta of the user.
    2722 *
    2823 * @param int $user_id User id to check for flood.
     
    5348 *
    5449 * @since 1.6.0
    55  *
    56  * @uses bp_current_author_ip() To get current user IP address.
    57  * @uses bp_current_author_ua() To get current user agent.
    58  * @uses bp_current_user_can() Allow super admins to bypass blacklist.
    5950 *
    6051 * @param int    $user_id Topic or reply author ID.
     
    191182 * @since 1.6.0
    192183 *
    193  * @uses bp_current_author_ip() To get current user IP address.
    194  * @uses bp_current_author_ua() To get current user agent.
    195  * @uses bp_current_user_can() Allow super admins to bypass blacklist.
    196  *
    197184 * @param int    $user_id Topic or reply author ID.
    198185 * @param string $title   The title of the content.
  • trunk/src/bp-core/bp-core-options.php

    r10497 r10825  
    127127 * @since 1.6.0
    128128 *
    129  * @uses bp_get_default_options() To get default options.
    130  * @uses add_option() Adds default options.
    131  * @uses do_action() Calls 'bp_add_options'.
    132129 */
    133130function bp_add_options() {
     
    161158 * @since 1.6.0
    162159 *
    163  * @uses bp_get_default_options() To get default options.
    164  * @uses delete_option() Removes default options.
    165  * @uses do_action() Calls 'bp_delete_options'.
    166160 */
    167161function bp_delete_options() {
     
    192186 * @since 1.6.0
    193187 *
    194  * @uses bp_get_default_options() To get default options.
    195  * @uses add_filter() To add filters to 'pre_option_{$key}'.
    196  * @uses do_action() Calls 'bp_add_option_filters'.
    197188 */
    198189function bp_setup_option_filters() {
     
    253244 *
    254245 * @since 1.2.0
    255  *
    256  * @uses bp_get_root_blog_id()
    257246 *
    258247 * @param string $option_name The option to be retrieved.
     
    299288 * @since 1.5.0
    300289 *
    301  * @uses bp_get_root_blog_id()
    302  *
    303290 * @param string $option_name The option key to be set.
    304291 * @param string $value       The value to be set.
     
    317304 *
    318305 * @since 1.5.0
    319  *
    320  * @uses bp_get_root_blog_id()
    321306 *
    322307 * @param string $option_name The option key to be deleted.
     
    530515 * @since 1.6.0
    531516 *
    532  * @uses bp_get_option() To get the profile sync option.
    533  *
    534517 * @param bool $default Optional. Fallback value if not found in the database.
    535518 *                      Default: true.
     
    552535 *
    553536 * @since 1.6.0
    554  *
    555  * @uses bp_get_option() To get the logged out Toolbar option.
    556537 *
    557538 * @param bool $default Optional. Fallback value if not found in the database.
     
    577558 * @since 1.6.0
    578559 *
    579  * @uses bp_get_option() To get the avatar uploads option.
    580  *
    581560 * @param bool $default Optional. Fallback value if not found in the database.
    582561 *                      Default: true.
     
    599578 *
    600579 * @since 2.4.0
    601  *
    602  * @uses bp_get_option() To get the cover image uploads option.
    603580 *
    604581 * @param bool $default Optional. Fallback value if not found in the database.
     
    657634 * @since 2.4.0
    658635 *
    659  * @uses bp_get_option() To get the group cover image uploads option.
    660  *
    661636 * @param bool $default Optional. Fallback value if not found in the database.
    662637 *                      Default: false.
     
    679654 *
    680655 * @since 1.6.0
    681  *
    682  * @uses bp_get_option() To get the account deletion option.
    683656 *
    684657 * @param bool $default Optional. Fallback value if not found in the database.
     
    705678 *
    706679 * @todo split and move into blog and forum components.
    707  * @uses bp_get_option() To get the blog/forum comments option.
    708680 *
    709681 * @param bool $default Optional. Fallback value if not found in the database.
     
    730702 *
    731703 * @todo Move into groups component.
    732  * @uses bp_get_option() To get the group creation.
    733704 *
    734705 * @param bool $default Optional. Fallback value if not found in the database.
     
    753724 * @since 1.6.0
    754725 *
    755  * @uses bp_get_option() To get the BuddyBar option.
    756  *
    757726 * @param bool $default Optional. Fallback value if not found in the database.
    758727 *                      Default: true.
     
    786755     * @since 1.6.0
    787756     *
    788      * @uses bp_get_option() To get the root forum ID from the database.
    789757     *
    790758     * @param bool|string $default Optional. Default: '0'.
     
    808776 * @since 1.6.0
    809777 *
    810  * @uses bp_get_option() To get the group forums option.
    811  *
    812778 * @param bool $default Optional. Fallback value if not found in the database.
    813779 *                      Default: true.
     
    831797 * @since 1.6.0
    832798 *
    833  * @uses bp_get_option() To get the Akismet option.
    834  *
    835799 * @param bool $default Optional. Fallback value if not found in the database.
    836800 *                      Default: true.
     
    854818 * @since 2.0.0
    855819 *
    856  * @uses bp_get_option() To get the Heartbeat option.
    857  *
    858820 * @param bool $default Optional. Fallback value if not found in the database.
    859821 *                      Default: true.
     
    876838 *
    877839 * @since 1.7.0
    878  *
    879  * @uses get_option() To get the theme package option.
    880840 *
    881841 * @param string $default Optional. Fallback value if not found in the database.
  • trunk/src/bp-core/bp-core-template-loader.php

    r10746 r10825  
    1919 *
    2020 * @since 1.7.0
    21  *
    22  * @uses bp_locate_template()
    23  * @uses load_template()
    24  * @uses get_template_part()
    2521 *
    2622 * @param string      $slug Template part slug. Used to generate filenames,
     
    300296 * @since 1.7.0
    301297 *
    302  * @uses bp_set_theme_compat_templates()
    303  * @uses bp_locate_template()
    304  * @uses bp_set_theme_compat_template()
    305  *
    306298 * @param string $type      Filename without extension.
    307299 * @param array  $templates An optional list of template candidates.
     
    514506 *
    515507 * @global string $pagenow
    516  * @uses bp_locate_template()
    517508 */
    518509function bp_load_theme_functions() {
  • trunk/src/bp-core/bp-core-template.php

    r10774 r10825  
    2727 * @since 1.0.0
    2828 *
    29  * @uses bp_get_user_nav() Renders the navigation for a profile of a currently
    3029 *       viewed user.
    3130 *
     
    14841483 * @since 1.5.0
    14851484 *
    1486  * @uses bp_get_search_slug()
    14871485 */
    14881486function bp_search_slug() {
     
    15131511 * @since 1.0.0
    15141512 *
    1515  * @uses apply_filters() Filter 'bp_displayed_user_id' to change this value.
    1516  *
    15171513 * @return int $id ID of the currently displayed user.
    15181514 */
     
    15371533 *
    15381534 * @since 1.0.0
    1539  *
    1540  * @uses apply_filters() Filter 'bp_loggedin_user_id' to change this value.
    15411535 *
    15421536 * @return int ID of the logged-in user.
  • trunk/src/bp-core/bp-core-theme-compatibility.php

    r10652 r10825  
    5858 * @since 1.7.0
    5959 *
    60  * @uses apply_filters()
    61  *
    6260 * @return string ID of the theme package in use.
    6361 */
     
    8280 * @since 1.7.0
    8381 *
    84  * @uses apply_filters()
    85  *
    8682 * @return string Name of the theme package currently in use.
    8783 */
     
    106102 * @since 1.7.0
    107103 *
    108  * @uses apply_filters()
    109  *
    110104 * @return string The version string of the theme package currently in use.
    111105 */
     
    129123 *
    130124 * @since 1.7.0
    131  *
    132  * @uses apply_filters()
    133125 *
    134126 * @return string The absolute path of the theme package currently in use.
     
    155147 * @since 1.7.0
    156148 *
    157  * @uses apply_filters()
    158  *
    159149 * @return string URL of the theme package currently in use.
    160150 */
     
    178168 *
    179169 * @since 1.9.0
    180  *
    181  * @uses bp_detect_theme_compat_with_current_theme()
    182170 *
    183171 * @return bool True if the current theme needs theme compatibility.
     
    679667 * @since 1.7.0
    680668 *
    681  * @uses bp_is_single_user() To check if page is single user.
    682  * @uses bp_get_single_user_template() To get user template.
    683  * @uses bp_is_single_user_edit() To check if page is single user edit.
    684  * @uses bp_get_single_user_edit_template() To get user edit template.
    685  * @uses bp_is_single_view() To check if page is single view.
    686  * @uses bp_get_single_view_template() To get view template.
    687  * @uses bp_is_forum_edit() To check if page is forum edit.
    688  * @uses bp_get_forum_edit_template() To get forum edit template.
    689  * @uses bp_is_topic_merge() To check if page is topic merge.
    690  * @uses bp_get_topic_merge_template() To get topic merge template.
    691  * @uses bp_is_topic_split() To check if page is topic split.
    692  * @uses bp_get_topic_split_template() To get topic split template.
    693  * @uses bp_is_topic_edit() To check if page is topic edit.
    694  * @uses bp_get_topic_edit_template() To get topic edit template.
    695  * @uses bp_is_reply_edit() To check if page is reply edit.
    696  * @uses bp_get_reply_edit_template() To get reply edit template.
    697  * @uses bp_set_theme_compat_template() To set the global theme compat template.
    698  *
    699669 * @param string $template Template name.
    700670 * @return string $template Template name.
  • trunk/src/bp-core/bp-core-update.php

    r10582 r10825  
    1717 *
    1818 * @since 1.7.0
    19  *
    20  * @uses get_option()
    21  * @uses bp_get_db_version() To get BuddyPress's database version.
    2219 *
    2320 * @return bool True if this is a fresh BP install, otherwise false.
     
    3633 * @since 1.6.0
    3734 *
    38  * @uses get_option()
    39  * @uses bp_get_db_version() To get BuddyPress's database version.
    40  *
    4135 * @return bool True if update, otherwise false.
    4236 */
     
    5852 *
    5953 * @since 1.6.0
    60  *
    61  * @uses buddypress()
    6254 *
    6355 * @param string $basename BuddyPress basename.
     
    10597 * @since 1.6.0
    10698 *
    107  * @uses buddypress()
    108  *
    10999 * @param string $basename BuddyPress basename.
    110100 * @return bool True if deactivating BuddyPress, false if not.
     
    151141 * @since 1.6.0
    152142 *
    153  * @uses bp_get_db_version() To get BuddyPress's database version.
    154  * @uses bp_update_option() To update BuddyPress's database version.
    155143 */
    156144function bp_version_bump() {
     
    520508 *
    521509 * @global $wpdb
    522  * @uses   buddypress()
    523510 */
    524511function bp_migrate_new_member_activity_component() {
     
    554541 * @since 2.2.0
    555542 *
    556  * @uses bp_activity_delete() to delete the corresponding friendship activities.
    557543 */
    558544function bp_cleanup_friendship_activities() {
     
    571557 * @internal Used internally to redirect BuddyPress to the about page on activation.
    572558 *
    573  * @uses set_transient() To drop the activation transient for 30 seconds.
    574559 */
    575560function bp_add_activation_redirect() {
     
    641626 * @since 1.6.0
    642627 *
    643  * @uses do_action() Calls 'bp_activation' hook.
    644628 */
    645629function bp_activation() {
     
    671655 * @since 1.6.0
    672656 *
    673  * @uses do_action() Calls 'bp_deactivation' hook.
    674657 */
    675658function bp_deactivation() {
     
    706689 * @since 1.6.0
    707690 *
    708  * @uses do_action() Calls 'bp_uninstall' hook.
    709691 */
    710692function bp_uninstall() {
  • trunk/src/bp-core/classes/class-bp-admin.php

    r10750 r10825  
    8383     * @since 1.6.0
    8484     *
    85      * @uses BP_Admin::setup_globals() Setup the globals needed.
    86      * @uses BP_Admin::includes() Include the required files.
    87      * @uses BP_Admin::setup_actions() Setup the hooks and actions.
    8885     */
    8986    public function __construct() {
     
    138135     * @since 1.6.0
    139136     *
    140      * @uses add_action() To add various actions.
    141      * @uses add_filter() To add various filters.
    142137     */
    143138    private function setup_actions() {
     
    200195     * @since 1.6.0
    201196     *
    202      * @uses add_management_page() To add the Recount page in Tools section.
    203      * @uses add_options_page() To add the Forums settings page in Settings
    204197     *       section.
    205198     */
     
    382375     * @since 1.6.0
    383376     *
    384      * @uses add_settings_section() To add our own settings section.
    385      * @uses add_settings_field() To add various settings fields.
    386      * @uses register_setting() To register various settings.
    387377     */
    388378    public function register_admin_settings() {
  • trunk/src/bp-core/classes/class-bp-attachment-avatar.php

    r10800 r10825  
    2626     *
    2727     * @see  BP_Attachment::__construct() for list of parameters
    28      * @uses bp_core_avatar_original_max_filesize()
    29      * @uses BP_Attachment::__construct()
    3028     */
    3129    public function __construct() {
     
    6563     * @since 2.3.0
    6664     *
    67      * @uses bp_core_avatar_upload_path()
    68      * @uses bp_core_avatar_url()
    69      * @uses bp_upload_dir()
    70      * @uses BP_Attachment::set_upload_dir()
    7165     */
    7266    public function set_upload_dir() {
     
    8882     * @since 2.3.0
    8983     *
    90      * @uses   bp_core_check_avatar_size()
    91      * @uses   bp_core_check_avatar_type()
    9284     *
    9385     * @param  array $file the temporary file attributes (before it has been moved).
     
    119111     * @since 2.4.0 Add the $ui_available_width parameter, to inform about the Avatar UI width.
    120112     *
    121      * @uses  bp_core_avatar_original_max_width()
    122113     *
    123114     * @param string $file               The absolute path to the file.
     
    185176     * @since 2.3.0
    186177     *
    187      * @uses  bp_core_avatar_full_width()
    188      * @uses  bp_core_avatar_full_height()
    189178     *
    190179     * @param string $file the absolute path to the file.
     
    209198     *
    210199     * @see  BP_Attachment::crop for the list of parameters
    211      * @uses bp_core_fetch_avatar()
    212      * @uses bp_core_delete_existing_avatar()
    213      * @uses bp_core_avatar_full_width()
    214      * @uses bp_core_avatar_full_height()
    215      * @uses bp_core_avatar_dimension()
    216      * @uses BP_Attachment::crop
    217200     *
    218201     * @param array $args Array of arguments for the cropping.
  • trunk/src/bp-core/classes/class-bp-attachment.php

    r10417 r10825  
    5151     * @since 2.3.0
    5252     * @since 2.4.0 Add the $upload_dir_filter_args argument to the $arguments array
    53      * @uses                                    sanitize_key()
    54      * @uses                                    wp_max_upload_size()
    55      * @uses                                    bp_parse_args()
    56      * @uses                                    BP_Attachment->set_upload_error_strings()
    57      * @uses                                    BP_Attachment->set_upload_dir()
    5853     *
    5954     * @param array|string $args {
     
    116111     * @since 2.3.0
    117112     *
    118      * @uses bp_upload_dir()
    119113     */
    120114    public function set_upload_dir() {
     
    204198     * @since 2.3.0
    205199     *
    206      * @uses   wp_handle_upload()        To upload the file
    207      * @uses   add_filter()              To temporarly overrides WordPress uploads data
    208      * @uses   remove_filter()           To stop overriding WordPress uploads data
    209      * @uses   apply_filters()           Call 'bp_attachment_upload_overrides' to include specific upload overrides
    210200     *
    211201     * @param  array       $file              The appropriate entry the from $_FILES superglobal.
     
    304294     * @since 2.3.0
    305295     *
    306      * @uses get_allowed_mime_types()
    307296     */
    308297    protected function validate_mime_types() {
     
    355344     * @since 2.4.0 Add the $upload_dir parameter to the method
    356345     *
    357      * @uses apply_filters() call 'bp_attachment_upload_dir' to eventually override the upload location
    358346     *       regarding to context
    359347     *
     
    390378     * @since 2.3.0
    391379     *
    392      * @uses wp_mkdir_p()
    393380     */
    394381    public function create_dir() {
     
    427414     *     @type string $dst_file      Optional. The destination file to write to.
    428415     * }
    429      * @uses wp_crop_image()
    430416     *
    431417     * @return string|WP_Error New filepath on success, WP_Error on failure.
  • trunk/src/bp-core/classes/class-bp-component.php

    r10745 r10825  
    207207     * @since 1.5.0
    208208     *
    209      * @uses apply_filters() Calls 'bp_{@link bp_Component::name}_id'.
    210      * @uses apply_filters() Calls 'bp_{@link bp_Component::name}_slug'.
    211209     *
    212210     * @param array $args {
     
    351349     * @since 1.5.0
    352350     *
    353      * @uses do_action() Calls 'bp_{@link bp_Component::name}includes'.
    354351     *
    355352     * @param array $includes An array of file names, or file name chunks,
     
    402399     * @since 1.5.0
    403400     *
    404      * @uses add_action() To add various actions.
    405      * @uses do_action() Calls 'bp_{@link BP_Component::name}setup_actions'.
    406401     */
    407402    public function setup_actions() {
     
    599594     * @since 1.5.0
    600595     *
    601      * @uses do_action() Calls 'bp_{@link bp_Component::name}_setup_title'.
    602596     */
    603597    public function setup_title() {
     
    618612     * @since 2.2.0
    619613     *
    620      * @uses do_action() Calls 'bp_setup_{@link bp_Component::name}_cache_groups'.
    621614     */
    622615    public function setup_cache_groups() {
     
    724717     * @since 1.5.0
    725718     *
    726      * @uses do_action() Calls 'bp_{@link bp_Component::name}_register_post_types'.
    727719     */
    728720    public function register_post_types() {
     
    743735     * @since 1.5.0
    744736     *
    745      * @uses do_action() Calls 'bp_{@link bp_Component::name}_register_taxonomies'.
    746737     */
    747738    public function register_taxonomies() {
     
    762753     * @since 1.5.0
    763754     *
    764      * @uses do_action() Calls 'bp_{@link bp_Component::name}_add_rewrite_tags'.
    765755     */
    766756    public function add_rewrite_tags() {
     
    781771     * @since 1.9.0
    782772     *
    783      * @uses do_action() Calls 'bp_{@link bp_Component::name}_add_rewrite_rules'.
    784773     */
    785774    public function add_rewrite_rules() {
     
    800789     * @since 1.9.0
    801790     *
    802      * @uses do_action() Calls 'bp_{@link bp_Component::name}_add_permastruct'.
    803791     */
    804792    public function add_permastructs() {
     
    819807     * @since 1.9.0
    820808     *
    821      * @uses do_action() Calls 'bp_{@link bp_Component::name}_parse_query'.
    822809     *
    823810     * @param object $query The main WP_Query.
     
    842829     * @since 1.5.0
    843830     *
    844      * @uses do_action() Calls 'bp_{@link bp_Component::name}_generate_rewrite_rules'.
    845831     */
    846832    public function generate_rewrite_rules() {
  • trunk/src/bp-core/classes/class-bp-core-user.php

    r10749 r10825  
    147147    /**
    148148     * Populate the instantiated class with data based on the User ID provided.
    149      *
    150      * @uses bp_core_get_userurl() Returns the URL with no HTML markup for
    151      *       a user based on their user id.
    152      * @uses bp_core_get_userlink() Returns a HTML formatted link for a
    153      *       user with the user's full name as the link text.
    154      * @uses bp_core_get_user_email() Returns the email address for the
    155      *       user based on user ID.
    156      * @uses bp_get_user_meta() BP function returns the value of passed
    157      *       usermeta name from usermeta table.
    158      * @uses bp_core_fetch_avatar() Returns HTML formatted avatar for a user
    159      * @uses bp_profile_last_updated_date() Returns the last updated date
    160      *       for a user.
    161149     */
    162150    public function populate() {
  • trunk/src/bp-core/classes/class-bp-core.php

    r10745 r10825  
    2525     * @since 1.5.0
    2626     *
    27      * @uses BP_Core::bootstrap()
    2827     */
    2928    public function __construct() {
  • trunk/src/bp-core/classes/class-bp-embed.php

    r10548 r10825  
    7676     * for oEmbed parsing.
    7777     *
    78      * @uses wp_parse_args()
    79      * @uses wp_embed_defaults()
    80      * @uses current_user_can()
    81      * @uses _wp_oembed_get_object()
    82      * @uses WP_Embed::maybe_make_link()
    8378     *
    8479     * @param array  $attr Shortcode attributes.
     
    175170     * View an example to add support in {@link bp_activity_embed()}.
    176171     *
    177      * @uses apply_filters() Filters cache.
    178      * @uses do_action() To save cache.
    179      * @uses wp_oembed_get() Connects to oEmbed provider and returns HTML
    180172     *       on success.
    181      * @uses WP_Embed::maybe_make_link() Process URL for hyperlinking on
    182173     *       oEmbed failure.
    183174     *
  • trunk/src/bp-core/deprecated/1.2.php

    r10108 r10825  
    1616 *
    1717 * @param array $args
    18  *
    19  * @uses BP_Activity_Activity::get() {@link BP_Activity_Activity}
    2018 *
    2119 * @return object $activity The activity/activities object
  • trunk/src/bp-core/deprecated/1.7.php

    r10108 r10825  
    1616 * @since 1.6.0
    1717 * @deprecated 1.7.0
    18  * @uses bp_get_maintenance_mode() To get the BuddyPress maintenance mode
    1918 */
    2019function bp_maintenance_mode() {
  • trunk/src/bp-forums/bp-forums-template.php

    r10821 r10825  
    1616 * @since 1.5.0
    1717 *
    18  * @uses bp_get_forums_slug()
    1918 */
    2019function bp_forums_slug() {
     
    4443 * @since 1.5.0
    4544 *
    46  * @uses bp_get_forums_root_slug()
    4745 */
    4846function bp_forums_root_slug() {
     
    7270 * @since 1.5.0
    7371 *
    74  * @uses bp_get_forums_directory_permalink()
    7572 */
    7673function bp_forums_directory_permalink() {
     
    8279     * @since 1.5.0
    8380     *
    84      * @uses apply_filters()
    85      * @uses trailingslashit()
    86      * @uses bp_get_root_domain()
    87      * @uses bp_get_forums_root_slug()
    8881     *
    8982     * @return string The permalink for the forums component directory.
     
    481474 * @since 1.1.0
    482475 *
    483  * @uses apply_filters() Filter 'bp_has_topics' to manipulate the
    484476 *       $forums_template global before it's rendered, or to modify the value
    485477 *       of has_topics().
     
    19511943     * @since 1.5.0
    19521944     *
    1953      * @uses apply_filters() Filter bp_get_forum_topic_new_reply_link to
    19541945     *       modify.
    19551946     *
  • trunk/src/bp-friends/bp-friends-template.php

    r10782 r10825  
    1616 * @since 1.5.0
    1717 *
    18  * @uses bp_get_friends_slug()
    1918 */
    2019function bp_friends_slug() {
     
    4544 * @since 1.5.0
    4645 *
    47  * @uses bp_get_friends_root_slug()
    4846 */
    4947function bp_friends_root_slug() {
     
    685683 * @since 2.0.0
    686684 *
    687  * @uses bp_friends_get_profile_stats() to get the stats.
    688  *
    689685 * @param array|string $args before|after|user_id.
    690686 */
  • trunk/src/bp-groups/bp-groups-template.php

    r10775 r10825  
    34153415 * @since 2.2.0
    34163416 *
    3417  * @uses bp_group_create_nav_item() to output the create a Group nav item.
    3418  *
    34193417 * @return string HTML Output
    34203418 */
     
    42994297 * @since 1.5.0
    43004298 *
    4301  * @uses apply_filters() To call 'bp_user_can_create_groups'.
    4302  * @uses bp_get_option() To retrieve value of 'bp_restrict_group_creation'. Defaults to 0.
    4303  * @uses bp_current_user_can() To determine if current user if super admin.
    43044299 * @return bool True if user can create groups. False otherwise.
    43054300 */
     
    47824777     * @since 1.6.0
    47834778     *
    4784      * @uses apply_filters() Filter bp_get_groups_current_create_step to modify.
    47854779     *
    47864780     * @return string $current_create_step
     
    50625056     * @since 1.6.0
    50635057     *
    5064      * @uses apply_filters() Filter bp_get_current_group_admin_tab to modify return value.
    50655058     *
    50665059     * @return string $tab The current tab's slug.
     
    50895082 *
    50905083 * @since 1.0.0
    5091  *
    5092  * @uses bp_get_group_current_avatar() to get the avatar of the current group.
    50935084 *
    50945085 * @param string $type Thumb or full.
     
    57885779     *
    57895780     * @since 1.5.0
    5790      * @uses apply_filters() Filter bp_get_current_group_id to modify this output.
    57915781     *
    57925782     * @return int $current_group_id The id of the current group, if there is one.
     
    58195809     *
    58205810     * @since 1.5.0
    5821      * @uses apply_filters() Filter bp_get_current_group_slug to modify this output.
    58225811     *
    58235812     * @return string $current_group_slug The slug of the current group, if there is one.
     
    58505839     *
    58515840     * @since 1.5.0
    5852      * @uses apply_filters() Filter bp_get_current_group_name to modify this output.
    58535841     *
    58545842     * @return string The name of the current group, if there is one.
     
    58815869     *
    58825870     * @since 2.1.0
    5883      * @uses apply_filters() Filter bp_get_current_group_description to modify
    58845871     *                       this output.
    58855872     *
     
    59875974 * @param array|string $args before|after|user_id
    59885975 *
    5989  * @uses bp_groups_get_profile_stats() to get the stats.
    59905976 */
    59915977function bp_groups_profile_stats( $args = '' ) {
  • trunk/src/bp-loader.php

    r10745 r10825  
    140140     *
    141141     * @static object $instance
    142      * @uses BuddyPress::constants() Setup the constants (mostly deprecated).
    143      * @uses BuddyPress::setup_globals() Setup the globals needed.
    144      * @uses BuddyPress::legacy_constants() Setup the legacy constants (deprecated).
    145      * @uses BuddyPress::includes() Include the required files.
    146      * @uses BuddyPress::setup_actions() Setup the hooks and actions.
    147142     * @see buddypress()
    148143     *
     
    255250     * @since 1.6.0
    256251     *
    257      * @uses is_multisite()
    258      * @uses get_current_site()
    259      * @uses get_current_blog_id()
    260      * @uses plugin_dir_path()
    261      * @uses plugin_dir_url()
    262252     */
    263253    private function constants() {
     
    336326     * @since 1.6.0
    337327     *
    338      * @uses plugin_dir_path() To generate BuddyPress plugin path.
    339      * @uses plugin_dir_url() To generate BuddyPress plugin url.
    340      * @uses apply_filters() Calls various filters.
    341328     */
    342329    private function setup_globals() {
     
    477464     * @since 1.6.0
    478465     *
    479      * @uses is_admin() If in WordPress admin, load additional file.
    480466     */
    481467    private function includes() {
     
    640626     * @since 1.6.0
    641627     *
    642      * @uses register_activation_hook() To register the activation hook.
    643      * @uses register_deactivation_hook() To register the deactivation hook.
    644      * @uses add_action() To add various actions.
    645628     */
    646629    private function setup_actions() {
  • trunk/src/bp-members/bp-members-activity.php

    r10711 r10825  
    1616 * @since 2.2.0
    1717 *
    18  * @uses bp_activity_set_action()
    19  * @uses buddypress()
    2018 */
    2119function bp_members_register_activity_actions() {
  • trunk/src/bp-members/bp-members-functions.php

    r10800 r10825  
    10781078 * @since 1.6.0
    10791079 *
    1080  * @uses is_user_logged_in() To check if user is logged in
    1081  * @uses bp_loggedin_user_id() To get current user ID
    1082  * @uses bp_is_user_spammer() To check if user is spammer
    1083  * @uses bp_is_user_deleted() To check if user is deleted
    1084  *
    10851080 * @param int $user_id The user ID to check.
    10861081 * @return bool True if active, otherwise false.
     
    11191114 * @todo No need for the user fallback checks, since they're done in
    11201115 *       bp_is_user_active().
    1121  *
    1122  * @uses is_user_logged_in() To check if user is logged in.
    1123  * @uses bp_get_displayed_user_id() To get current user ID.
    1124  * @uses bp_is_user_active() To check if user is active.
    11251116 *
    11261117 * @param int $user_id The user ID to check.
  • trunk/src/bp-members/bp-members-template.php

    r10796 r10825  
    2222 * @since 2.4.0
    2323 *
    24  * @uses bp_get_profile_slug()
    2524 */
    2625function bp_profile_slug() {
     
    5150 * @since 1.5.0
    5251 *
    53  * @uses bp_get_members_slug()
    5452 */
    5553function bp_members_slug() {
     
    8078 * @since 1.5.0
    8179 *
    82  * @uses bp_get_members_root_slug()
    8380 */
    8481function bp_members_root_slug() {
     
    139136 * @since 1.5.0
    140137 *
    141  * @uses bp_get_members_directory_permalink()
    142138 */
    143139function bp_members_directory_permalink() {
     
    167163 *
    168164 * @since 2.5.0
    169  *
    170  * @uses bp_get_member_type_directory_permalink()
    171165 *
    172166 * @param string $member_type Optional. Member type.
     
    216210 * @since 1.5.0
    217211 *
    218  * @uses bp_get_signup_slug()
    219212 */
    220213function bp_signup_slug() {
     
    254247 * @since 1.5.0
    255248 *
    256  * @uses bp_get_activate_slug()
    257249 */
    258250function bp_activate_slug() {
     
    559551 * @since 1.2.0
    560552 *
    561  * @uses bp_get_member_user_id()
    562553 */
    563554function bp_member_user_id() {
     
    19951986 * @since 1.5.0
    19961987 *
    1997  * @uses bp_get_signup_slug() To make sure there is a slug assigned to the page.
    1998  * @uses bp_locate_template() To make sure a template exists to provide output.
    1999  *
    20001988 * @return bool True if page and template exist, false if not.
    20011989 */
     
    20452033 *
    20462034 * @since 1.5.0
    2047  *
    2048  * @uses bp_get_activate_slug() To make sure there is a slug assigned to the page.
    2049  * @uses bp_locate_template() To make sure a template exists to provide output.
    20502035 *
    20512036 * @return boolean True if page and template exist, false if not.
  • trunk/src/bp-members/classes/class-bp-core-members-widget.php

    r10809 r10825  
    245245     * @since 2.3.0
    246246     *
    247      * @uses bp_parse_args() To merge widget settings into defaults.
    248247     *
    249248     * @param array $instance Widget instance settings.
  • trunk/src/bp-members/classes/class-bp-core-recently-active-widget.php

    r10793 r10825  
    163163     * @since 2.3.0
    164164     *
    165      * @uses bp_parse_args() To merge widget settings into defaults.
    166165     *
    167166     * @param array $instance Widget instance settings.
  • trunk/src/bp-members/classes/class-bp-core-whos-online-widget.php

    r10793 r10825  
    163163     * @since 2.3.0
    164164     *
    165      * @uses bp_parse_args() To merge widget settings into defaults.
    166165     *
    167166     * @param array $instance Widget instance settings.
  • trunk/src/bp-members/classes/class-bp-members-admin.php

    r10739 r10825  
    6666     * @since 2.0.0
    6767     *
    68      * @uses buddypress() to get BuddyPress main instance.
    6968     */
    7069    public static function register_members_admin() {
     
    369368     * @since 2.1.0
    370369     *
    371      * @uses add_submenu_page() To add the Edit Profile page in Profile section.
    372370     */
    373371    public function user_profile_menu() {
     
    407405     * @since 2.0.0
    408406     *
    409      * @uses add_submenu_page() To add the Edit Profile page in Users/Profile section.
    410407     */
    411408    public function admin_menus() {
     
    12291226     * @since 2.1.0
    12301227     *
    1231      * @uses  user_admin_url()
    12321228     *
    12331229     * @param string $profile_link Profile Link for admin bar.
  • trunk/src/bp-messages/bp-messages-template.php

    r10785 r10825  
    10081008 * @since 1.0.0
    10091009 * @deprecated 1.6.0
    1010  * @uses bp_get_message_is_active_notice()
    10111010 * @return bool
    10121011 */
     
    10221021     * @since 1.0.0
    10231022     * @deprecated 1.6.0
    1024      * @uses bp_messages_is_active_notice()
    10251023     */
    10261024    function bp_get_message_is_active_notice() {
     
    12191217 * @since 1.5.0
    12201218 *
    1221  * @uses bp_get_messages_slug()
    12221219 */
    12231220function bp_messages_slug() {
     
    13081305 * @since 1.2.6
    13091306 *
    1310  * @uses bp_get_send_message_button()
    13111307 */
    13121308function bp_send_private_message_button() {
     
    19551951     * @since 2.1.0
    19561952     *
    1957      * @uses strtotime() To convert the message string into a usable timestamp.
    19581953     *
    19591954     * @return int
  • trunk/src/bp-notifications/bp-notifications-functions.php

    r10816 r10825  
    717717 * @since 2.3.0
    718718 *
    719  * @uses apply_filters() To call the 'bp_notifications_get_meta' hook.
    720  *
    721719 * @param int    $notification_id ID of the notification item whose metadata is being requested.
    722720 * @param string $meta_key        Optional. If present, only the metadata matching
  • trunk/src/bp-settings/bp-settings-template.php

    r10716 r10825  
    1616 * @since 1.5.0
    1717 *
    18  * @uses bp_get_settings_slug()
    1918 */
    2019function bp_settings_slug() {
     
    4544 * @since 1.5.0
    4645 *
    47  * @uses bp_get_settings_root_slug()
    4846 */
    4947function bp_settings_root_slug() {
  • trunk/src/bp-templates/bp-legacy/buddypress-functions.php

    r10820 r10825  
    4242     * @since 1.7.0
    4343     *
    44      * @uses BP_Legacy::setup_globals()
    45      * @uses BP_Legacy::setup_actions()
    4644     */
    4745    public function __construct() {
     
    7169     * @since 1.7.0
    7270     *
    73      * @uses add_filter() To add various filters
    74      * @uses add_action() To add various actions
    7571     */
    7672    protected function setup_actions() {
     
    211207     * @since 2.3.0 Support custom CSS file named after the current theme or parent theme.
    212208     *
    213      * @uses wp_enqueue_style() To enqueue the styles
    214209     */
    215210    public function enqueue_styles() {
     
    514509     *
    515510     * @param  array $templates Array of templates.
    516      * @uses   apply_filters() call 'bp_legacy_theme_compat_page_templates_directory_only' and return false
    517511     *                         to use the defined page template for component's directory and its single items
    518512     * @return array
     
    607601 * @since 2.2.0
    608602 *
    609  * @uses   bp_group_create_nav_item() to output the create a Group nav item.
    610603 */
    611604function bp_legacy_theme_group_create_nav() {
     
    637630 * @since 2.2.0
    638631 *
    639  * @uses   bp_blog_create_nav_item() to output the Create a Site nav item
    640632 */
    641633function bp_legacy_theme_blog_create_nav() {
  • trunk/src/bp-xprofile/bp-xprofile-actions.php

    r10740 r10825  
    2323 * @since 1.0.0
    2424 *
    25  * @uses bp_core_delete_avatar() Deletes the active avatar for the logged in user.
    26  * @uses add_action() Runs a specific function for an action when it fires.
    2725 */
    2826function xprofile_action_delete_avatar() {
  • trunk/src/bp-xprofile/bp-xprofile-activity.php

    r10434 r10825  
    1919 * @since 1.0.0
    2020 *
    21  * @uses bp_activity_set_action() To setup the individual actions.
    2221 */
    2322function xprofile_register_activity_actions() {
     
    114113 *
    115114 * @since 1.0.0
    116  *
    117  * @uses bp_activity_add() Adds an entry to the activity component tables for a specific activity.
    118115 *
    119116 * @param array|string $args String containing all variables used after bp_parse_args() call.
     
    150147 * @since 1.0.0
    151148 *
    152  * @uses bp_activity_delete() Deletes an entry to the activity component tables
    153149 *                            for a specific activity.
    154150 *
     
    206202 * @since 2.3.4 Add new parameter to get the user id the avatar was set for.
    207203 *
    208  * @uses bp_activity_add() Adds an entry to the activity component tables for a
    209204 *                         specific activity
    210205 *
  • trunk/src/bp-xprofile/bp-xprofile-admin.php

    r10740 r10825  
    2020 *
    2121 * @since 1.0.0
    22  *
    23  * @uses bp_current_user_can() returns true if the current user is a site admin, false if not.
    24  * @uses add_users_page() Adds a submenu tab to a top level tab in the admin area.
    2522 *
    2623 * @return bool
  • trunk/src/bp-xprofile/bp-xprofile-caps.php

    r10434 r10825  
    2121 * @param mixed  $args    Arguments.
    2222 *
    23  * @uses get_post() To get the post.
    24  * @uses get_post_type_object() To get the post type object.
    25  * @uses apply_filters() Calls 'bp_map_meta_caps' with caps, cap, user id and args.
    2623 * @return array Actual capabilities for meta capability.
    2724 */
  • trunk/src/bp-xprofile/bp-xprofile-functions.php

    r10740 r10825  
    328328 * @since 1.0.0
    329329 *
    330  * @uses BP_XProfile_ProfileData::get_value_byid() Fetches the value based on the params passed.
    331  *
    332330 * @param mixed  $field        The ID of the field, or the $name of the field.
    333331 * @param int    $user_id      The ID of the user.
     
    390388 * @since 1.0.0
    391389 *
    392  * @uses xprofile_get_field_id_from_name() Gets the ID from the field based on the name.
    393  *
    394390 * @param int|string $field       The ID of the field, or the $name of the field.
    395391 * @param int        $user_id     The ID of the user.
     
    604600 * @global object     $wpdb         WordPress DB access object.
    605601 * @global object     $current_user WordPress global variable containing current logged in user information.
    606  * @uses xprofile_format_profile_field() Formats profile field data so it is suitable for display.
    607602 *
    608603 * @param int  $user_id          User ID of the user to get random data for.
     
    11601155 *
    11611156 * @see BP_XProfile_Group::get()
    1162  * @uses apply_filters() Filter bp_xprofile_get_hidden_fields_for_user to modify visibility levels,
    11631157 *   or if you have added your own custom levels.
    11641158 *
  • trunk/src/bp-xprofile/bp-xprofile-screens.php

    r10740 r10825  
    2020 * @since 1.0.0
    2121 *
    22  * @uses bp_core_load_template() Looks for and loads a template file within the current member theme (folder/filename).
    2322 */
    2423function xprofile_screen_display_profile() {
     
    5049 * @since 1.0.0
    5150 *
    52  * @uses bp_is_my_profile() Checks to make sure the current user being viewed equals the logged in user.
    53  * @uses bp_core_load_template() Looks for and loads a template file within the current member theme (folder/filename).
    5451 */
    5552function xprofile_screen_edit_profile() {
     
    210207 * @since 1.0.0
    211208 *
    212  * @uses bp_is_my_profile() Checks to make sure the current user being viewed equals the logged in user.
    213  * @uses bp_core_load_template() Looks for and loads a template file within the current member theme (folder/filename).
    214209 */
    215210function xprofile_screen_change_avatar() {
  • trunk/src/bp-xprofile/bp-xprofile-settings.php

    r10434 r10825  
    4242 * @since 2.0.0
    4343 *
    44  * @uses bp_core_add_message()
    45  * @uses bp_is_my_profile()
    4644 */
    4745function bp_xprofile_settings_add_feedback_message() {
  • trunk/src/bp-xprofile/bp-xprofile-template.php

    r10785 r10825  
    721721 * @since 1.1.0
    722722 *
    723  * @uses bp_get_the_profile_field_options()
    724  *
    725723 * @param array $args Specify type for datebox. Allowed 'day', 'month', 'year'.
    726724 */
     
    733731     * @since 1.1.0
    734732     *
    735      * @uses BP_XProfile_Field::get_children()
    736      * @uses BP_XProfile_ProfileData::get_value_byid()
    737733     *
    738734     * @param array $args {
  • trunk/src/bp-xprofile/classes/class-bp-xprofile-user-admin.php

    r10822 r10825  
    2424     * @since 2.0.0
    2525     *
    26      * @uses buddypress() to get BuddyPress main instance.
    2726     */
    2827    public static function register_xprofile_user_admin() {
Note: See TracChangeset for help on using the changeset viewer.