Skip to:
Content

bbPress.org


Ignore:
Timestamp:
06/16/2017 09:20:52 PM (7 years ago)
Author:
johnjamesjacoby
Message:

Documentation: Remove all @uses usages.

Per the 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/includes/users/engagements.php

    r6544 r6573  
    2424 * @param bool   $unique    Whether meta key should be unique to the object
    2525 *
    26  * @uses add_metadata() To add the user to an object
    27  *
    2826 * @return bool Returns true on success, false on failure
    2927 */
    … …  
    4543 * @param string $meta_type The relationship type (usually 'post')
    4644 *
    47  * @uses delete_metadata() To remove a user from an objects
    48  *
    4945 * @return bool Returns true on success, false on failure
    5046 */
    … …  
    6460 * @param string $meta_key  The relationship key
    6561 * @param string $meta_type The relationship type (usually 'post')
    66  *
    67  * @uses delete_metadata() To remove user from all objects
    6862 *
    6963 * @return bool Returns true on success, false on failure
    … …  
    8680 * @param string $meta_type The relationship type (usually 'post')
    8781 *
    88  * @uses delete_metadata() To remove all user from an object
    89  *
    9082 * @return bool Returns true on success, false on failure
    9183 */
    … …  
    10496 * @param string $meta_key  The relationship key
    10597 * @param string $meta_type The relationship type (usually 'post')
    106  *
    107  * @uses delete_metadata() To remove users from objects
    10898 *
    10999 * @return bool Returns true on success, false on failure
    … …  
    124114 * @param string $meta_key  The key used to index this relationship
    125115 * @param string $meta_type The type of meta to look in
    126  *
    127  * @uses get_metadata() To get the users of an object
    128116 *
    129117 * @return array Returns ids of users
    … …  
    147135 * @param string $meta_type The relationship type (usually 'post')
    148136 *
    149  * @uses bbp_get_users_for_object() To get all users of an object
    150  *
    151137 * @return bool Returns true if object has a user, false if not
    152138 */
    … …  
    167153 *
    168154 * @param int $topic_id Optional. Topic id
    169  * @uses bbp_get_users_for_object() To get user ids who engaged
    170  * @uses apply_filters() Calls 'bbp_get_topic_engagements' with the users and
    171  *                        topic id
     155 *
    172156 * @return array|bool Results if the topic has any engagements, otherwise false
    173157 */
    … …  
    227211 *
    228212 * @param int $user_id Optional. User id
    229  * @uses bbp_has_topics() To get the topics
    230  * @uses apply_filters() Calls 'bbp_get_user_engagements' with the topic query and
    231  *                        user id
     213 *
    232214 * @return array|bool Results if user has engaged, otherwise false
    233215 */
    … …  
    254236 *
    255237 * @param int $user_id Optional. User id
    256  * @uses bbp_get_user_id() To get the user id
    257  * @uses bbp_get_topic_post_type() To get the topic post type
    258  * @uses apply_filters() Calls 'bbp_get_user_engaged_topic_ids' with
    259  *                        the engaged topics and user id
     238 *
    260239 * @return array Topic ids if user has engaged, otherwise empty array
    261240 */
    … …  
    285264 * @param int $user_id Optional. User id
    286265 * @param int $topic_id Optional. Topic id
    287  * @uses bbp_get_user_id() To get the user id
    288  * @uses bbp_get_topic_id() To get the topic id
    289  * @uses bbp_is_object_of_user() To check if the user has engaged
    290  * @uses apply_filters() Calls 'bbp_is_user_engaged' with the bool, user id,
    291  *                        topic id and engagements
     266 *
    292267 * @return bool True if the topic is in user's engagements, otherwise false
    293268 */
    … …  
    313288 * @param int $user_id Optional. User id
    314289 * @param int $topic_id Optional. Topic id
    315  * @uses bbp_is_user_engaged() To check if the user is engaged in a topic
    316  * @uses do_action() Calls 'bbp_add_user_engagement' with the user id and topic id
     290 *
    317291 * @return bool Always true
    318292 */
    … …  
    346320 * @param int $user_id Optional. User id
    347321 * @param int $topic_id Optional. Topic id
    348  * @uses bbp_is_user_engaged() To check if the user is engaged in a topic
    349  * @uses do_action() Calls 'bbp_remove_user_engagement' with the user & topic id
     322 *
    350323 * @return bool True if the topic was removed from user's engagements, otherwise
    351324 *               false
    … …  
    478451 *
    479452 * @param int $topic_id Optional. Topic id
    480  * @uses bbp_get_users_for_object() To get user IDs who favorited
    481  * @uses apply_filters() Calls 'bbp_get_topic_favoriters' with the users and
    482  *                        topic id
     453 *
    483454 * @return array|bool Results if the topic has any favoriters, otherwise false
    484455 */
    … …  
    497468 *
    498469 * @param int $user_id Optional. User id
    499  * @uses bbp_has_topics() To get the topics
    500  * @uses apply_filters() Calls 'bbp_get_user_favorites' with the topic query and
    501  *                        user id
     470 *
    502471 * @return array|bool Results if user has favorites, otherwise false
    503472 */
    … …  
    525494 * @param int $user_id Optional. User id
    526495 * @param int $topic_id Optional. Topic id
    527  * @uses bbp_get_user_id() To get the user id
    528  * @uses bbp_get_topic() To get the topic
    529  * @uses bbp_get_topic_id() To get the topic id
    530  * @uses bbp_is_object_of_user() To check if the user has a favorite
    531  * @uses apply_filters() Calls 'bbp_is_user_favorite' with the bool, user id,
    532  *                        topic id and favorites
     496 *
    533497 * @return bool True if the topic is in user's favorites, otherwise false
    534498 */
    … …  
    552516 * @param int $user_id Optional. User id
    553517 * @param int $topic_id Optional. Topic id
    554  * @uses bbp_is_user_favorite() To check if the topic is a user favorite
    555  * @uses do_action() Calls 'bbp_add_user_favorite' with the user id and topic id
     518 *
    556519 * @return bool Always true
    557520 */
    … …  
    587550 * @param int $user_id Optional. User id
    588551 * @param int $topic_id Optional. Topic id
    589  * @uses bbp_is_user_favorite() To check if the topic is a user favorite
    590  * @uses do_action() Calls 'bbp_remove_user_favorite' with the user & topic id
    591  * @return bool True if the topic was removed from user's favorites, otherwise
    592  *               false
     552 *
     553 * @return bool True if the topic was removed from user's favorites, or false
    593554 */
    594555function bbp_remove_user_favorite( $user_id, $topic_id ) {
    … …  
    620581 *
    621582 * @param string $action The requested action to compare this function to
    622  * @uses bbp_get_user_id() To get the user id
    623  * @uses bbp_verify_nonce_request() To verify the nonce and check the request
    624  * @uses current_user_can() To check if the current user can edit the user
    625  * @uses bbPress:errors:add() To log the error messages
    626  * @uses bbp_is_user_favorite() To check if the topic is in user's favorites
    627  * @uses bbp_remove_user_favorite() To remove the user favorite
    628  * @uses bbp_add_user_favorite() To add the user favorite
    629  * @uses do_action() Calls 'bbp_favorites_handler' with success, user id, topic
    630  *                    id and action
    631  * @uses bbp_is_favorites() To check if it's the favorites page
    632  * @uses bbp_get_topic_permalink() To get the topic permalink
    633  * @uses bbp_redirect() To redirect to the url
    634583 */
    635584function bbp_favorites_handler( $action = '' ) {
    … …  
    730679 *
    731680 * @param int $object_id Optional. ID of forum, topic, or something else
    732  * @uses bbp_get_users_for_object() To get the subscribers
    733  * @uses apply_filters() Calls 'bbp_get_subscribers' with the subscribers
    734  * @return array|bool Results if subscribers, otherwise false
    735681 */
    736682function bbp_get_subscribers( $object_id = 0, $type = 'post' ) {
    … …  
    747693 *
    748694 * @param int $user_id Optional. User id
    749  * @uses bbp_has_topics() To get the topics
    750  * @uses apply_filters() Calls 'bbp_get_user_subscriptions' with the topic query
    751  *                        and user id
     695 *
    752696 * @return array|bool Results if user has subscriptions, otherwise false
    753697 */
    … …  
    774718 *
    775719 * @param int $user_id Optional. User id
    776  * @uses bbp_has_forums() To get the forums
    777  * @uses apply_filters() Calls 'bbp_get_user_forum_subscriptions' with the forum
    778  *                        query and user id
     720 *
    779721 * @return array|bool Results if user has subscriptions, otherwise false
    780722 */
    … …  
    802744 * @param int $user_id Optional. User id
    803745 * @param int $object_id Optional. Topic id
    804  * @uses get_post() To get the post object
    805  * @uses bbp_get_user_subscribed_forum_ids() To get the user's forum subscriptions
    806  * @uses bbp_get_user_subscribed_topic_ids() To get the user's topic subscriptions
    807  * @uses bbp_get_forum_post_type() To get the forum post type
    808  * @uses bbp_get_topic_post_type() To get the topic post type
    809  * @uses apply_filters() Calls 'bbp_is_user_subscribed' with the bool, user id,
    810  *                        forum/topic id and subscriptions
     746 *
    811747 * @return bool True if the forum or topic is in user's subscriptions, otherwise false
    812748 */
    … …  
    828764 * @param string $type      Optional. Type of object being subscribed to
    829765 *
    830  * @uses do_action() Calls 'bbp_add_user_subscription' with the user & object id
    831766 * @return bool Always true
    832767 */
    … …  
    863798 * @param string $type      Optional. Type of object being subscribed to
    864799 *
    865  * @uses bbp_is_user_subscribed() To check if the user is already subscribed
    866  * @uses do_action() Calls 'bbp_remove_user_subscription' with the user id and
    867  *                    topic id
    868800 * @return bool True if the topic was removed from user's subscriptions,
    869801 *               otherwise false
    … …  
    898830 *
    899831 * @param string $action The requested action to compare this function to
    900  * @uses bbp_is_subscriptions_active() To check if the subscriptions are active
    901  * @uses bbp_get_user_id() To get the user id
    902  * @uses bbp_verify_nonce_request() To verify the nonce and check the request
    903  * @uses current_user_can() To check if the current user can edit the user
    904  * @uses bbPress:errors:add() To log the error messages
    905  * @uses bbp_is_user_subscribed() To check if the object is in user's
    906  *                                 subscriptions
    907  * @uses bbp_remove_user_subscription() To remove the user subscription
    908  * @uses bbp_add_user_subscription() To add the user subscription
    909  * @uses do_action() Calls 'bbp_subscriptions_handler' with success, user id,
    910  *                    object id and action
    911  * @uses bbp_is_subscription() To check if it's the subscription page
    912  * @uses bbp_redirect() To redirect to the url
    913832 */
    914833function bbp_subscriptions_handler( $action = '' ) {
    … …  
    1014933 *
    1015934 * @param int $user_id Optional. User id
    1016  * @uses bbp_get_user_id() To get the user id
    1017  * @uses bbp_get_topic_post_type() To get the topic post type
    1018  * @uses apply_filters() Calls 'bbp_get_user_favorites_topic_ids' with
    1019  *                        the favorites and user id
     935 *
    1020936 * @return array|bool Results if user has favorites, otherwise null
    1021937 */
    … …  
    1045961 *
    1046962 * @param int $user_id Optional. User id
    1047  * @uses bbp_get_user_id() To get the user id
    1048  * @uses bbp_get_forum_post_type() To get the forum post type
    1049  * @uses apply_filters() Calls 'bbp_get_user_subscribed_forum_ids' with
    1050  *                        the subscriptions and user id
     963 *
    1051964 * @return array|bool Results if user has subscriptions, otherwise null
    1052965 */
    … …  
    1075988 *
    1076989 * @param int $user_id Optional. User id
    1077  * @uses bbp_get_user_id() To get the user id
    1078  * @uses bbp_get_topic_post_type() To get the topic post type
    1079  * @uses apply_filters() Calls 'bbp_get_user_subscribed_topic_ids' with
    1080  *                        the subscriptions and user id
     990 *
    1081991 * @return array|bool Results if user has subscriptions, otherwise null
    1082992 */
Note: See TracChangeset for help on using the changeset viewer.