Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
05/29/2016 06:12:08 PM (6 years ago)
Author:
djpaul
Message:

Remove redundant @uses PHPDoc tag from inline documentation.

Per WordPress' inline documentation standards, the @uses tag is not recommended to be used to indicate a used-by relationship, as this information can be derived through other means. These tags also are very likely to become out-of-date as our functions change over time.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-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 */
Note: See TracChangeset for help on using the changeset viewer.