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

    r6534 r6573  
    1818 *
    1919 * @since 2.0.0 bbPress (r3349)
    20  *
    21  * @uses bbp_parse_args()
    22  * @uses bbp_get_reply_post_type()
    23  * @uses wp_insert_post()
    24  * @uses update_post_meta()
    2520 *
    2621 * @param array $reply_data Forum post data
     
    9792 * @param int $forum_id The forum id.
    9893 *
    99  * @uses bbp_get_reply_status() To get the reply status
    100  * @uses bbp_get_public_status_id() To get the public status id
    101  * @uses bbp_increase_topic_reply_count() To bump the topics reply count by 1
    102  * @uses bbp_increase_forum_reply_count() To bump the forums reply count by 1
    103  * @uses bbp_increase_topic_reply_count_hidden() To bump the topics hidden reply
    104  *                                               count by 1
    105  *
    10694 * @return void
    10795 */
     
    127115 *
    128116 * @param string $action The requested action to compare this function to
    129  * @uses bbp_add_error() To add an error message
    130  * @uses bbp_verify_nonce_request() To verify the nonce and check the request
    131  * @uses bbp_is_anonymous() To check if an anonymous post is being made
    132  * @uses current_user_can() To check if the current user can publish replies
    133  * @uses bbp_get_current_user_id() To get the current user id
    134  * @uses bbp_filter_anonymous_post_data() To filter anonymous data
    135  * @uses is_wp_error() To check if the value retrieved is a {@link WP_Error}
    136  * @uses remove_filter() To remove kses filters if needed
    137  * @uses bbp_check_for_flood() To check for flooding
    138  * @uses bbp_check_for_duplicate() To check for duplicates
    139  * @uses apply_filters() Calls 'bbp_new_reply_pre_title' with the title
    140  * @uses apply_filters() Calls 'bbp_new_reply_pre_content' with the content
    141  * @uses bbp_get_reply_post_type() To get the reply post type
    142  * @uses wp_set_post_terms() To set the topic tags
    143  * @uses wp_insert_post() To insert the reply
    144  * @uses do_action() Calls 'bbp_new_reply' with the reply id, topic id, forum
    145117 *                    id, anonymous data, reply author, edit (false), and
    146118 *                    the reply to id
    147  * @uses bbp_get_reply_url() To get the paginated url to the reply
    148  * @uses bbp_redirect() To redirect to the reply url
    149  * @uses bbPress::errors::get_error_message() To get the {@link WP_Error} error
    150  *                                              message
    151119 */
    152120function bbp_new_reply_handler( $action = '' ) {
     
    506474 *
    507475 * @param string $action The requested action to compare this function to
    508  * @uses bbp_add_error() To add an error message
    509  * @uses bbp_get_reply() To get the reply
    510  * @uses bbp_verify_nonce_request() To verify the nonce and check the request
    511  * @uses bbp_is_reply_anonymous() To check if the reply was by an anonymous user
    512  * @uses current_user_can() To check if the current user can edit that reply
    513  * @uses bbp_filter_anonymous_post_data() To filter anonymous data
    514  * @uses is_wp_error() To check if the value retrieved is a {@link WP_Error}
    515  * @uses remove_filter() To remove kses filters if needed
    516  * @uses apply_filters() Calls 'bbp_edit_reply_pre_title' with the title and id
    517  * @uses apply_filters() Calls 'bbp_edit_reply_pre_content' with the content id
    518  * @uses wp_set_post_terms() To set the topic tags
    519  * @uses bbp_has_errors() To get the {@link WP_Error} errors
    520  * @uses wp_save_post_revision() To save a reply revision
    521  * @uses bbp_update_reply_revision_log() To update the reply revision log
    522  * @uses wp_update_post() To update the reply
    523  * @uses bbp_get_reply_topic_id() To get the reply topic id
    524  * @uses bbp_get_topic_forum_id() To get the topic forum id
    525  * @uses bbp_get_reply_to() To get the reply to id
    526  * @uses do_action() Calls 'bbp_edit_reply' with the reply id, topic id, forum
    527476 *                    id, anonymous data, reply author, bool true (for edit),
    528477 *                    and the reply to id
    529  * @uses bbp_get_reply_url() To get the paginated url to the reply
    530  * @uses bbp_redirect() To redirect to the reply url
    531  * @uses bbPress::errors::get_error_message() To get the {@link WP_Error} error
    532  *                                             message
    533478 */
    534479function bbp_edit_reply_handler( $action = '' ) {
     
    821766 * @param bool $is_edit Optional. Is the post being edited? Defaults to false.
    822767 * @param int $reply_to Optional. Reply to id
    823  * @uses bbp_get_reply_id() To get the reply id
    824  * @uses bbp_get_topic_id() To get the topic id
    825  * @uses bbp_get_forum_id() To get the forum id
    826  * @uses bbp_get_current_user_id() To get the current user id
    827  * @uses bbp_get_reply_topic_id() To get the reply topic id
    828  * @uses bbp_get_topic_forum_id() To get the topic forum id
    829  * @uses update_post_meta() To update the reply metas
    830  * @uses set_transient() To update the flood check transient for the ip
    831  * @uses bbp_update_user_last_posted() To update the users last posted time
    832  * @uses bbp_is_subscriptions_active() To check if the subscriptions feature is
    833  *                                      activated or not
    834  * @uses bbp_is_user_subscribed() To check if the user is subscribed
    835  * @uses bbp_remove_user_subscription() To remove the user's subscription
    836  * @uses bbp_add_user_subscription() To add the user's subscription
    837  * @uses bbp_update_reply_forum_id() To update the reply forum id
    838  * @uses bbp_update_reply_topic_id() To update the reply topic id
    839  * @uses bbp_update_reply_to() To update the reply to id
    840  * @uses bbp_update_reply_walker() To update the ancestor counts of a reply
    841768 */
    842769function bbp_update_reply( $reply_id = 0, $topic_id = 0, $forum_id = 0, $anonymous_data = array(), $author_id = 0, $is_edit = false, $reply_to = 0 ) {
     
    930857 * @param bool $refresh If set to true, unsets all the previous parameters.
    931858 *                       Defaults to true
    932  * @uses bbp_get_reply_id() To get the reply id
    933  * @uses bbp_get_reply_topic_id() To get the reply topic id
    934  * @uses bbp_get_reply_forum_id() To get the reply forum id
    935  * @uses get_post_ancestors() To get the ancestors of the reply
    936  * @uses bbp_is_reply() To check if the ancestor is a reply
    937  * @uses bbp_is_topic() To check if the ancestor is a topic
    938  * @uses bbp_update_topic_last_reply_id() To update the topic last reply id
    939  * @uses bbp_update_topic_last_active_id() To update the topic last active id
    940  * @uses bbp_get_topic_last_active_id() To get the topic last active id
    941  * @uses get_post_field() To get the post date of the last active id
    942  * @uses bbp_update_topic_last_active_time() To update the last active topic meta
    943  * @uses bbp_update_topic_voice_count() To update the topic voice count
    944  * @uses bbp_update_topic_reply_count() To update the topic reply count
    945  * @uses bbp_update_topic_reply_count_hidden() To update the topic hidden reply
    946  *                                              count
    947  * @uses bbp_is_forum() To check if the ancestor is a forum
    948  * @uses bbp_update_forum_last_topic_id() To update the last topic id forum meta
    949  * @uses bbp_update_forum_last_reply_id() To update the last reply id forum meta
    950  * @uses bbp_update_forum_last_active_id() To update the forum last active id
    951  * @uses bbp_get_forum_last_active_id() To get the forum last active id
    952  * @uses bbp_update_forum_last_active_time() To update the forum last active time
    953  * @uses bbp_update_forum_reply_count() To update the forum reply count
    954859 */
    955860function bbp_update_reply_walker( $reply_id, $last_active_time = '', $forum_id = 0, $topic_id = 0, $refresh = true ) {
     
    1055960 * @param int $reply_id Optional. Reply id to update
    1056961 * @param int $forum_id Optional. Forum id
    1057  * @uses bbp_get_reply_id() To get the reply id
    1058  * @uses bbp_get_forum_id() To get the forum id
    1059  * @uses get_post_ancestors() To get the ancestors of a reply
    1060  * @uses get_post_field() To get the post type of the post
    1061  * @uses update_post_meta() To update the reply forum id meta
    1062  * @uses apply_filters() Calls 'bbp_update_reply_forum_id' with the forum id
    1063  *                        and reply id
    1064962 * @return bool The forum id of the reply
    1065963 */
     
    11051003 * @param int $reply_id Optional. Reply id to update
    11061004 * @param int $topic_id Optional. Topic id
    1107  * @uses bbp_get_reply_id() To get the reply id
    1108  * @uses bbp_get_topic_id() To get the topic id
    1109  * @uses get_post_ancestors() To get the ancestors of a reply
    1110  * @uses get_post_field() To get the post type of the post
    1111  * @uses update_post_meta() To update the reply topic id meta
    1112  * @uses apply_filters() Calls 'bbp_update_reply_topic_id' with the topic id
    1113  *                        and reply id
    11141005 * @return bool The topic id of the reply
    11151006 */
     
    11551046 * @param int $reply_id Reply id to update
    11561047 * @param int $reply_to Optional. Reply to id
    1157  * @uses bbp_get_reply_id() To get the reply id
    1158  * @uses update_post_meta() To update the reply to meta
    1159  * @uses apply_filters() Calls 'bbp_update_reply_to' with the reply id and
    1160  *                        and reply to id
    11611048 * @return bool The parent reply id of the reply
    11621049 */
     
    12441131 *  - reason: Reason for editing
    12451132 *  - revision_id: Revision id
    1246  * @uses bbp_get_reply_id() To get the reply id
    1247  * @uses bbp_format_revision_reason() To format the reason
    1248  * @uses bbp_get_reply_raw_revision_log() To get the raw reply revision log
    1249  * @uses update_post_meta() To update the reply revision log meta
    12501133 * @return mixed False on failure, true on success
    12511134 */
     
    12851168 *
    12861169 * @param string $action The requested action to compare this function to
    1287  * @uses bbp_add_error() To add an error message
    1288  * @uses bbp_get_reply() To get the reply
    1289  * @uses bbp_get_topic() To get the topics
    1290  * @uses bbp_verify_nonce_request() To verify the nonce and check the request
    1291  * @uses current_user_can() To check if the current user can edit the reply and topics
    1292  * @uses bbp_get_topic_post_type() To get the topic post type
    1293  * @uses is_wp_error() To check if the value retrieved is a {@link WP_Error}
    1294  * @uses do_action() Calls 'bbp_pre_move_reply' with the from reply id, source
    1295  *                    and destination topic ids
    1296  * @uses bbp_get_reply_post_type() To get the reply post type
    1297  * @uses wp_update_post() To update the replies
    1298  * @uses bbp_update_reply_topic_id() To update the reply topic id
    1299  * @uses bbp_get_topic_forum_id() To get the topic forum id
    1300  * @uses bbp_update_reply_forum_id() To update the reply forum id
    1301  * @uses do_action() Calls 'bbp_split_topic_reply' with the reply id and
    1302  *                    destination topic id
    1303  * @uses bbp_update_topic_last_reply_id() To update the topic last reply id
    1304  * @uses bbp_update_topic_last_active_time() To update the topic last active meta
    1305  * @uses do_action() Calls 'bbp_post_split_topic' with the destination and
    1306  *                    source topic ids and source topic's forum id
    1307  * @uses bbp_get_topic_permalink() To get the topic permalink
    1308  * @uses bbp_redirect() To redirect to the topic link
    13091170 */
    13101171function bbp_move_reply_handler( $action = '' ) {
     
    15431404 * @param int $source_topic_id Source topic id
    15441405 * @param int $destination_topic_id Destination topic id
    1545  * @uses bbp_update_forum_topic_count() To update the forum topic counts
    1546  * @uses bbp_update_forum_reply_count() To update the forum reply counts
    1547  * @uses bbp_update_topic_reply_count() To update the topic reply counts
    1548  * @uses bbp_update_topic_voice_count() To update the topic voice counts
    1549  * @uses bbp_update_topic_reply_count_hidden() To update the topic hidden reply
    1550  *                                              count
    1551  * @uses do_action() Calls 'bbp_move_reply_count' with the move reply id,
    1552  *                    source topic id & destination topic id
    15531406 */
    15541407function bbp_move_reply_count( $move_reply_id, $source_topic_id, $destination_topic_id ) {
     
    15841437 *
    15851438 * @param string $action The requested action to compare this function to
    1586  * @uses bbp_get_reply() To get the reply
    1587  * @uses current_user_can() To check if the user is capable of editing or
    1588  *                           deleting the reply
    1589  * @uses check_ajax_referer() To verify the nonce and check the referer
    1590  * @uses bbp_get_reply_post_type() To get the reply post type
    1591  * @uses bbp_is_reply_spam() To check if the reply is marked as spam
    1592  * @uses bbp_spam_reply() To make the reply as spam
    1593  * @uses bbp_unspam_reply() To unmark the reply as spam
    1594  * @uses wp_trash_post() To trash the reply
    1595  * @uses wp_untrash_post() To untrash the reply
    1596  * @uses wp_delete_post() To delete the reply
    1597  * @uses do_action() Calls 'bbp_toggle_reply_handler' with success, post data
    1598  *                    and action
    1599  * @uses bbp_get_reply_url() To get the reply url
    1600  * @uses bbp_redirect() To redirect to the reply
    1601  * @uses bbPress::errors:add() To log the error messages
    16021439 */
    16031440function bbp_toggle_reply_handler( $action = '' ) {
     
    18121649 *
    18131650 * @param int $reply_id Reply id
    1814  * @uses bbp_get_reply() To get the reply
    1815  * @uses do_action() Calls 'bbp_spam_reply' with the reply ID
    1816  * @uses add_post_meta() To add the previous status to a meta
    1817  * @uses wp_update_post() To insert the updated post
    1818  * @uses do_action() Calls 'bbp_spammed_reply' with the reply ID
    18191651 * @return mixed False or {@link WP_Error} on failure, reply id on success
    18201652 */
     
    18601692 *
    18611693 * @param int $reply_id Reply id
    1862  * @uses bbp_get_reply() To get the reply
    1863  * @uses do_action() Calls 'bbp_unspam_reply' with the reply ID
    1864  * @uses get_post_meta() To get the previous status meta
    1865  * @uses delete_post_meta() To delete the previous status meta
    1866  * @uses wp_update_post() To insert the updated post
    1867  * @uses do_action() Calls 'bbp_unspammed_reply' with the reply ID
    18681694 * @return mixed False or {@link WP_Error} on failure, reply id on success
    18691695 */
     
    19141740 *
    19151741 * @param int $reply_id Reply id
    1916  * @uses bbp_get_reply() To get the reply
    1917  * @uses bbp_get_pending_status_id() To get the pending status id
    1918  * @uses do_action() Calls 'bbp_approve_reply' with the reply id
    1919  * @uses bbp_get_public_status_id() To get the public status id
    1920  * @uses remove_action() To remove the auto save post revision action
    1921  * @uses wp_update_post() To update the reply with the new status
    1922  * @uses do_action() Calls 'bbp_approved_reply' with the reply id
    19231742 * @return mixed False or {@link WP_Error} on failure, reply id on success
    19241743 */
     
    19611780 *
    19621781 * @param int $reply_id Reply id
    1963  * @uses bbp_get_reply() To get the reply
    1964  * @uses bbp_get_pending_status_id() To get the pending status id
    1965  * @uses do_action() Calls 'bbp_unapprove_reply' with the reply id
    1966  * @uses remove_action() To remove the auto save post revision action
    1967  * @uses wp_update_post() To update the reply with the new status
    1968  * @uses do_action() Calls 'bbp_unapproved_reply' with the reply id
    19691782 * @return mixed False or {@link WP_Error} on failure, reply id on success
    19701783 */
     
    20051818/**
    20061819 * Called before deleting a reply
    2007  *
    2008  * @uses bbp_get_reply_id() To get the reply id
    2009  * @uses bbp_is_reply() To check if the passed id is a reply
    2010  * @uses do_action() Calls 'bbp_delete_reply' with the reply id
    20111820 */
    20121821function bbp_delete_reply( $reply_id = 0 ) {
     
    20221831/**
    20231832 * Called before trashing a reply
    2024  *
    2025  * @uses bbp_get_reply_id() To get the reply id
    2026  * @uses bbp_is_reply() To check if the passed id is a reply
    2027  * @uses do_action() Calls 'bbp_trash_reply' with the reply id
    20281833 */
    20291834function bbp_trash_reply( $reply_id = 0 ) {
     
    20391844/**
    20401845 * Called before untrashing (restoring) a reply
    2041  *
    2042  * @uses bbp_get_reply_id() To get the reply id
    2043  * @uses bbp_is_reply() To check if the passed id is a reply
    2044  * @uses do_action() Calls 'bbp_unstrash_reply' with the reply id
    20451846 */
    20461847function bbp_untrash_reply( $reply_id = 0 ) {
     
    20601861 *
    20611862 * @since 2.0.0 bbPress (r2993)
    2062  *
    2063  * @uses bbp_get_reply_id() To get the reply id
    2064  * @uses bbp_is_reply() To check if the passed id is a reply
    2065  * @uses do_action() Calls 'bbp_deleted_reply' with the reply id
    20661863 */
    20671864function bbp_deleted_reply( $reply_id = 0 ) {
     
    20791876 *
    20801877 * @since 2.0.0 bbPress (r2993)
    2081  *
    2082  * @uses bbp_get_reply_id() To get the reply id
    2083  * @uses bbp_is_reply() To check if the passed id is a reply
    2084  * @uses do_action() Calls 'bbp_trashed_reply' with the reply id
    20851878 */
    20861879function bbp_trashed_reply( $reply_id = 0 ) {
     
    20981891 *
    20991892 * @since 2.0.0 bbPress (r2993)
    2100  *
    2101  * @uses bbp_get_reply_id() To get the reply id
    2102  * @uses bbp_is_reply() To check if the passed id is a reply
    2103  * @uses do_action() Calls 'bbp_untrashed_reply' with the reply id
    21041893 */
    21051894function bbp_untrashed_reply( $reply_id = 0 ) {
     
    21211910 *
    21221911 * @param int $default Default replies per page (15)
    2123  * @uses get_option() To get the setting
    2124  * @uses apply_filters() To allow the return value to be manipulated
    21251912 * @return int
    21261913 */
     
    21451932 *
    21461933 * @param int $default Default replies per page (25)
    2147  * @uses get_option() To get the setting
    2148  * @uses apply_filters() To allow the return value to be manipulated
    21491934 * @return int
    21501935 */
     
    22542039 *
    22552040 * @since 2.0.0 bbPress (r3171)
    2256  *
    2257  * @uses bbp_version()
    2258  * @uses bbp_is_single_topic()
    2259  * @uses bbp_user_can_view_forum()
    2260  * @uses bbp_get_topic_forum_id()
    2261  * @uses bbp_show_lead_topic()
    2262  * @uses bbp_topic_permalink()
    2263  * @uses bbp_topic_title()
    2264  * @uses bbp_get_topic_reply_count()
    2265  * @uses bbp_topic_content()
    2266  * @uses bbp_has_replies()
    2267  * @uses bbp_replies()
    2268  * @uses bbp_the_reply()
    2269  * @uses bbp_reply_url()
    2270  * @uses bbp_reply_title()
    2271  * @uses bbp_reply_content()
    2272  * @uses get_wp_title_rss()
    2273  * @uses get_bloginfo_rss()
    2274  * @uses get_option()
    2275  * @uses self_link()
    2276  * @uses the_author()
    2277  * @uses get_post_time()
    2278  * @uses rss_enclosure()
    2279  * @uses do_action()
    2280  * @uses apply_filters()
    22812041 *
    22822042 * @param array $replies_query
     
    23932153
    23942154/**
    2395  * Redirect if unathorized user is attempting to edit a reply
     2155 * Redirect if unauthorized user is attempting to edit a reply
    23962156 *
    23972157 * @since 2.1.0 bbPress (r3605)
    2398  *
    2399  * @uses bbp_is_reply_edit()
    2400  * @uses current_user_can()
    2401  * @uses bbp_get_topic_id()
    2402  * @uses bbp_redirect()
    2403  * @uses bbp_get_topic_permalink()
    24042158 */
    24052159function bbp_check_reply_edit() {
     
    25162270 *
    25172271 * @param bool $default Optional. Default value true
    2518  * @uses apply_filters() Calls 'bbp_thread_replies' with the calculated value and
    2519  *                        the thread replies depth
    2520  * @uses get_option() To get thread replies option
     2272 *
    25212273 * @return bool Are replies threaded?
    25222274 */
Note: See TracChangeset for help on using the changeset viewer.