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

    r6544 r6573  
    1818 *
    1919 * @since 2.0.0 bbPress (r3349)
    20  *
    21  * @uses bbp_parse_args()
    22  * @uses bbp_get_topic_post_type()
    23  * @uses wp_insert_post()
    24  * @uses update_post_meta()
    2520 *
    2621 * @param array $topic_data Forum post data
     
    9893 *
    9994 * @param string $action The requested action to compare this function to
    100  * @uses bbp_add_error() To add an error message
    101  * @uses bbp_verify_nonce_request() To verify the nonce and check the referer
    102  * @uses bbp_is_anonymous() To check if an anonymous post is being made
    103  * @uses current_user_can() To check if the current user can publish topic
    104  * @uses bbp_get_current_user_id() To get the current user id
    105  * @uses bbp_filter_anonymous_post_data() To filter anonymous data
    106  * @uses is_wp_error() To check if the value retrieved is a {@link WP_Error}
    107  * @uses bbp_is_forum_category() To check if the forum is a category
    108  * @uses bbp_is_forum_closed() To check if the forum is closed
    109  * @uses bbp_is_forum_private() To check if the forum is private
    110  * @uses bbp_check_for_flood() To check for flooding
    111  * @uses bbp_check_for_duplicate() To check for duplicates
    112  * @uses bbp_get_topic_post_type() To get the topic post type
    113  * @uses remove_filter() To remove kses filters if needed
    114  * @uses apply_filters() Calls 'bbp_new_topic_pre_title' with the content
    115  * @uses apply_filters() Calls 'bbp_new_topic_pre_content' with the content
    116  * @uses bbPress::errors::get_error_codes() To get the {@link WP_Error} errors
    117  * @uses wp_insert_post() To insert the topic
    118  * @uses get_post_field() To get the post status
    119  * @uses bbp_get_closed_status_id() To get the closed status id
    120  * @uses bbp_close_topic() To close topics
    121  * @uses bbp_get_trash_status_id() To get the trash status id
    122  * @uses wp_trash_post() To trash topics
    123  * @uses bbp_get_spam_status_id() To get the spam status id
    124  * @uses add_post_meta() To add spam status meta to spam topics
    125  * @uses do_action() Calls 'bbp_new_topic' with the topic id, forum id,
    126  *                    anonymous data and reply author
    127  * @uses bbp_get_topic_permalink() To get the topic permalink
    128  * @uses bbp_redirect() To redirect to the topic link
    129  * @uses bbPress::errors::get_error_messages() To get the {@link WP_Error} error
    130  *                                              messages
    13195 */
    13296function bbp_new_topic_handler( $action = '' ) {
     
    441405 *
    442406 * @param string $action The requested action to compare this function to
    443  * @uses bbp_add_error() To add an error message
    444  * @uses bbp_get_topic() To get the topic
    445  * @uses bbp_verify_nonce_request() To verify the nonce and check the request
    446  * @uses bbp_is_topic_anonymous() To check if topic is by an anonymous user
    447  * @uses current_user_can() To check if the current user can edit the topic
    448  * @uses bbp_filter_anonymous_post_data() To filter anonymous data
    449  * @uses is_wp_error() To check if the value retrieved is a {@link WP_Error}
    450  * @uses bbp_is_forum_category() To check if the forum is a category
    451  * @uses bbp_is_forum_closed() To check if the forum is closed
    452  * @uses bbp_is_forum_private() To check if the forum is private
    453  * @uses remove_filter() To remove kses filters if needed
    454  * @uses apply_filters() Calls 'bbp_edit_topic_pre_title' with the title and
    455  *                        topic id
    456  * @uses apply_filters() Calls 'bbp_edit_topic_pre_content' with the content
    457  *                        and topic id
    458  * @uses bbPress::errors::get_error_codes() To get the {@link WP_Error} errors
    459  * @uses wp_save_post_revision() To save a topic revision
    460  * @uses bbp_update_topic_revision_log() To update the topic revision log
    461  * @uses bbp_stick_topic() To stick or super stick the topic
    462  * @uses bbp_unstick_topic() To unstick the topic
    463  * @uses wp_update_post() To update the topic
    464  * @uses do_action() Calls 'bbp_edit_topic' with the topic id, forum id,
    465  *                    anonymous data and reply author
    466  * @uses bbp_move_topic_handler() To handle movement of a topic from one forum
    467  *                                 to another
    468  * @uses bbp_get_topic_permalink() To get the topic permalink
    469  * @uses bbp_redirect() To redirect to the topic link
    470  * @uses bbPress::errors::get_error_messages() To get the {@link WP_Error} error
    471  *                                              messages
    472407 */
    473408function bbp_edit_topic_handler( $action = '' ) {
     
    783718 * @param int $author_id Author id
    784719 * @param bool $is_edit Optional. Is the post being edited? Defaults to false.
    785  * @uses bbp_get_topic_id() To get the topic id
    786  * @uses bbp_get_forum_id() To get the forum id
    787  * @uses bbp_get_current_user_id() To get the current user id
    788  * @uses bbp_get_topic_forum_id() To get the topic forum id
    789  * @uses update_post_meta() To update the topic metas
    790  * @uses set_transient() To update the flood check transient for the ip
    791  * @uses bbp_update_user_last_posted() To update the users last posted time
    792  * @uses bbp_is_subscriptions_active() To check if the subscriptions feature is
    793  *                                      activated or not
    794  * @uses bbp_is_user_subscribed() To check if the user is subscribed
    795  * @uses bbp_remove_user_subscription() To remove the user's subscription
    796  * @uses bbp_add_user_subscription() To add the user's subscription
    797  * @uses bbp_update_topic_forum_id() To update the topic's forum id
    798  * @uses bbp_update_topic_topic_id() To update the topic's topic id
    799  * @uses bbp_update_topic_last_reply_id() To update the last reply id topic meta
    800  * @uses bbp_update_topic_last_active_id() To update the topic last active id
    801  * @uses bbp_update_topic_last_active_time() To update the last active topic meta
    802  * @uses bbp_update_topic_reply_count() To update the topic reply count
    803  * @uses bbp_update_topic_reply_count_hidden() To udpate the topic hidden reply count
    804  * @uses bbp_update_topic_voice_count() To update the topic voice count
    805  * @uses bbp_update_topic_walker() To udpate the topic's ancestors
    806720 */
    807721function bbp_update_topic( $topic_id = 0, $forum_id = 0, $anonymous_data = array(), $author_id = 0, $is_edit = false ) {
     
    924838 * @param int $reply_id Optional. Reply id
    925839 * @param bool $refresh Reset all the previous parameters? Defaults to true.
    926  * @uses bbp_get_topic_id() To get the topic id
    927  * @uses bbp_get_topic_forum_id() To get the topic forum id
    928  * @uses get_post_ancestors() To get the topic's ancestors
    929  * @uses bbp_is_forum() To check if the ancestor is a forum
    930  * @uses bbp_update_forum() To update the forum
    931840 */
    932841function bbp_update_topic_walker( $topic_id, $last_active_time = '', $forum_id = 0, $reply_id = 0, $refresh = true ) {
     
    992901 * @param int $old_forum_id Old forum id.
    993902 * @param int $new_forum_id New forum id.
    994  * @uses bbp_get_topic_id() To get the topic id
    995  * @uses bbp_get_forum_id() To get the forum id
    996  * @uses bbp_clean_post_cache() To clean the old and new forum post caches
    997  * @uses bbp_update_topic_forum_id() To update the topic forum id
    998  * @uses wp_update_post() To update the topic post parent`
    999  * @uses bbp_get_stickies() To get the old forums sticky topics
    1000  * @uses delete_post_meta() To delete the forum sticky meta
    1001  * @uses update_post_meta() To update the old forum sticky meta
    1002  * @uses bbp_stick_topic() To stick the topic in the new forum
    1003  * @uses bbp_get_reply_post_type() To get the reply post type
    1004  * @uses bbp_get_all_child_ids() To get all the child ids
    1005  * @uses bbp_update_reply_forum_id() To update the reply forum id
    1006  * @uses get_post_ancestors() To get the topic's ancestors
    1007  * @uses bbp_get_public_child_ids() To get all the public child ids
    1008  * @uses get_post_field() To get the topic's post status
    1009  * @uses bbp_get_public_status_id() To get the public status id
    1010  * @uses bbp_decrease_forum_topic_count() To bump the forum topic count by -1
    1011  * @uses bbp_bump_forum_reply_count() To bump the forum reply count
    1012  * @uses bbp_increase_forum_topic_count() To bump the forum topic count by 1
    1013  * @uses bbp_decrease_forum_topic_count_hidden() To bump the forum topic hidden count by -1
    1014  * @uses bbp_increase_forum_topic_count_hidden() To bump the forum topic hidden count by 1
    1015  * @uses bbp_is_forum() To check if the ancestor is a forum
    1016  * @uses bbp_update_forum() To update the forum
    1017903 */
    1018904function bbp_move_topic_handler( $topic_id, $old_forum_id, $new_forum_id ) {
     
    11551041 *
    11561042 * @param string $action The requested action to compare this function to
    1157  * @uses bbp_add_error() To add an error message
    1158  * @uses bbp_get_topic() To get the topics
    1159  * @uses bbp_verify_nonce_request() To verify the nonce and check the request
    1160  * @uses current_user_can() To check if the current user can edit the topics
    1161  * @uses is_wp_error() To check if the value retrieved is a {@link WP_Error}
    1162  * @uses do_action() Calls 'bbp_merge_topic' with the destination and source
    1163  *                    topic ids
    1164  * @uses bbp_get_topic_subscribers() To get the source topic subscribers
    1165  * @uses bbp_add_user_subscription() To add the user subscription
    1166  * @uses bbp_remove_user_subscription() To remove the user subscription
    1167  * @uses bbp_get_topic_favoriters() To get the source topic favoriters
    1168  * @uses bbp_add_user_favorite() To add the user favorite
    1169  * @uses bbp_remove_user_favorite() To remove the user favorite
    1170  * @uses wp_get_post_terms() To get the source topic tags
    1171  * @uses wp_set_post_terms() To set the topic tags
    1172  * @uses wp_delete_object_term_relationships() To delete the topic tags
    1173  * @uses bbp_open_topic() To open the topic
    1174  * @uses bbp_unstick_topic() To unstick the topic
    1175  * @uses bbp_get_reply_post_type() To get the reply post type
    1176  * @uses get_posts() To get the replies
    1177  * @uses wp_update_post() To update the topic
    1178  * @uses bbp_update_reply_topic_id() To update the reply topic id
    1179  * @uses bbp_get_topic_forum_id() To get the topic forum id
    1180  * @uses bbp_update_reply_forum_id() To update the reply forum id
    1181  * @uses do_action() Calls 'bbp_merged_topic_reply' with the reply id and
    1182  *                    destination topic id
    1183  * @uses do_action() Calls 'bbp_merged_topic' with the destination and source
    1184  *                    topic ids and source topic's forum id
    1185  * @uses bbp_get_topic_permalink() To get the topic permalink
    1186  * @uses bbp_redirect() To redirect to the topic link
    11871043 */
    11881044function bbp_merge_topic_handler( $action = '' ) {
     
    14101266 * @param int $source_topic_id Source topic id
    14111267 * @param int $source_topic_forum_id Source topic's forum id
    1412  * @uses bbp_update_forum_topic_count() To update the forum topic counts
    1413  * @uses bbp_update_forum_reply_count() To update the forum reply counts
    1414  * @uses bbp_update_topic_reply_count() To update the topic reply counts
    1415  * @uses bbp_update_topic_voice_count() To update the topic voice counts
    1416  * @uses bbp_update_topic_reply_count_hidden() To update the topic hidden reply
    1417  *                                              count
    1418  * @uses do_action() Calls 'bbp_merge_topic_count' with the destination topic
    1419  *                    id, source topic id & source topic forum id
    14201268 */
    14211269function bbp_merge_topic_count( $destination_topic_id, $source_topic_id, $source_topic_forum_id ) {
     
    14511299 *
    14521300 * @param string $action The requested action to compare this function to
    1453  * @uses bbp_add_error() To add an error message
    1454  * @uses bbp_get_reply() To get the reply
    1455  * @uses bbp_get_topic() To get the topics
    1456  * @uses bbp_verify_nonce_request() To verify the nonce and check the request
    1457  * @uses current_user_can() To check if the current user can edit the topics
    1458  * @uses bbp_get_topic_post_type() To get the topic post type
    1459  * @uses is_wp_error() To check if the value retrieved is a {@link WP_Error}
    1460  * @uses do_action() Calls 'bbp_pre_split_topic' with the from reply id, source
    1461  *                    and destination topic ids
    1462  * @uses bbp_get_topic_subscribers() To get the source topic subscribers
    1463  * @uses bbp_add_user_subscription() To add the user subscription
    1464  * @uses bbp_get_topic_favoriters() To get the source topic favoriters
    1465  * @uses bbp_add_user_favorite() To add the user favorite
    1466  * @uses wp_get_post_terms() To get the source topic tags
    1467  * @uses wp_set_post_terms() To set the topic tags
    1468  * @uses bbp_get_reply_post_type() To get the reply post type
    1469  * @uses wpdb::prepare() To prepare our database query
    1470  * @uses wpdb::get_results() To execute the database query and get results
    1471  * @uses wp_update_post() To update the replies
    1472  * @uses bbp_update_reply_topic_id() To update the reply topic id
    1473  * @uses bbp_get_topic_forum_id() To get the topic forum id
    1474  * @uses bbp_update_reply_forum_id() To update the reply forum id
    1475  * @uses do_action() Calls 'bbp_split_topic_reply' with the reply id and
    1476  *                    destination topic id
    1477  * @uses bbp_update_topic_last_reply_id() To update the topic last reply id
    1478  * @uses bbp_update_topic_last_active_time() To update the topic last active meta
    1479  * @uses do_action() Calls 'bbp_post_split_topic' with the destination and
    1480  *                    source topic ids and source topic's forum id
    1481  * @uses bbp_get_topic_permalink() To get the topic permalink
    1482  * @uses bbp_redirect() To redirect to the topic link
    14831301 */
    14841302function bbp_split_topic_handler( $action = '' ) {
     
    17901608 * @param int $source_topic_id Source topic id
    17911609 * @param int $destination_topic_id Destination topic id
    1792  * @uses bbp_update_forum_topic_count() To update the forum topic counts
    1793  * @uses bbp_update_forum_reply_count() To update the forum reply counts
    1794  * @uses bbp_update_topic_reply_count() To update the topic reply counts
    1795  * @uses bbp_update_topic_voice_count() To update the topic voice counts
    1796  * @uses bbp_update_topic_reply_count_hidden() To update the topic hidden reply
    1797  *                                              count
    1798  * @uses do_action() Calls 'bbp_split_topic_count' with the from reply id,
    1799  *                    source topic id & destination topic id
    18001610 */
    18011611function bbp_split_topic_count( $from_reply_id, $source_topic_id, $destination_topic_id ) {
     
    18281638 *
    18291639 * @param string $action The requested action to compare this function to
    1830  * @uses bbp_verify_nonce_request() To verify the nonce and check the request
    1831  * @uses current_user_can() To check if the current user can edit/delete tags
    1832  * @uses bbp_add_error() To add an error message
    1833  * @uses wp_update_term() To update the topic tag
    1834  * @uses get_term_link() To get the topic tag url
    1835  * @uses term_exists() To check if the topic tag already exists
    1836  * @uses wp_insert_term() To insert a topic tag
    1837  * @uses wp_delete_term() To delete the topic tag
    1838  * @uses home_url() To get the blog's home page url
    1839  * @uses do_action() Calls actions based on the actions with associated args
    1840  * @uses is_wp_error() To check if the value retrieved is a {@link WP_Error}
    1841  * @uses bbp_redirect() To redirect to the url
    18421640 */
    18431641function bbp_edit_topic_tag_handler( $action = '' ) {
     
    20821880 *
    20831881 * @param int $forum_id Optional. If not passed, super stickies are returned.
    2084  * @uses bbp_get_super_stickies() To get the super stickies
    2085  * @uses get_post_meta() To get the forum stickies
    2086  * @uses apply_filters() Calls 'bbp_get_stickies' with the stickies and forum id
    20871882 * @return array IDs of sticky topics of a forum or super stickies
    20881883 */
     
    21081903 * @since 2.0.0 bbPress (r2592)
    21091904 *
    2110  * @uses get_option() To get super sticky topics
    2111  * @uses apply_filters() Calls 'bbp_get_super_stickies' with the stickies
    21121905 * @return array IDs of super sticky topics
    21131906 */
     
    21351928 *
    21361929 * @param string $action The requested action to compare this function to
    2137  * @uses bbp_get_topic() To get the topic
    2138  * @uses current_user_can() To check if the user is capable of editing or
    2139  *                           deleting the topic
    2140  * @uses bbp_get_topic_post_type() To get the topic post type
    2141  * @uses check_ajax_referer() To verify the nonce and check the referer
    2142  * @uses bbp_is_topic_open() To check if the topic is open
    2143  * @uses bbp_close_topic() To close the topic
    2144  * @uses bbp_open_topic() To open the topic
    2145  * @uses bbp_is_topic_sticky() To check if the topic is a sticky
    2146  * @uses bbp_unstick_topic() To unstick the topic
    2147  * @uses bbp_stick_topic() To stick the topic
    2148  * @uses bbp_is_topic_spam() To check if the topic is marked as spam
    2149  * @uses bbp_spam_topic() To make the topic as spam
    2150  * @uses bbp_unspam_topic() To unmark the topic as spam
    2151  * @uses wp_trash_post() To trash the topic
    2152  * @uses wp_untrash_post() To untrash the topic
    2153  * @uses wp_delete_post() To delete the topic
    2154  * @uses do_action() Calls 'bbp_toggle_topic_handler' with success, post data
    2155  *                    and action
    2156  * @uses bbp_get_forum_permalink() To get the forum link
    2157  * @uses bbp_get_topic_permalink() To get the topic link
    2158  * @uses bbp_redirect() To redirect to the topic
    2159  * @uses bbPress::errors:add() To log the error messages
    21601930 */
    21611931function bbp_toggle_topic_handler( $action = '' ) {
     
    23862156 *
    23872157 * @param int $topic_id Get the topic id to remove
    2388  * @uses bbp_get_topic_id To get the topic id
    2389  * @uses bbp_get_topic_favoriters() To get the topic's favoriters
    2390  * @uses bbp_remove_user_favorite() To remove the topic from user's favorites
    23912158 */
    23922159function bbp_remove_topic_from_all_favorites( $topic_id = 0 ) {
     
    24192186 *
    24202187 * @param int $topic_id Get the topic id to remove
    2421  * @uses bbp_is_subscriptions_active() To check if the subscriptions are active
    2422  * @uses bbp_get_topic_id To get the topic id
    2423  * @uses bbp_get_topic_subscribers() To get the topic subscribers
    2424  * @uses bbp_remove_user_subscription() To remove the user subscription
    24252188 */
    24262189function bbp_remove_topic_from_all_subscriptions( $topic_id = 0 ) {
     
    24502213 * @param int $topic_id   Optional. Topic id.
    24512214 * @param int $difference Optional. Default 1
    2452  * @uses bbp_get_topic_id() To get the topic id
    2453  * @uses bbp_get_topic_reply_count() To get the topic reply count
    2454  * @uses update_post_meta() To update the topic's reply count meta
    2455  * @uses apply_filters() Calls 'bbp_bump_topic_reply_count' with the reply
    2456  *                        count, topic id, and difference
    24572215 * @return int Topic reply count
    24582216 */
     
    24842242 * @param int $topic_id The topic id.
    24852243 *
    2486  * @uses bbp_is_reply() To check if the passed topic id is a reply
    2487  * @uses bbp_get_reply_topic_id() To get the replies topic id
    2488  * @uses bbp_is_reply_published() To check if the reply is published
    2489  * @uses bbp_increase_topic_reply_count_hidden() To increase the topics reply
    2490  *                                                hidden count by 1
    2491  * @uses bbp_bump_topic_reply_count() To bump the topic reply count
    2492  *
    24932244 * @return void
    24942245 */
     
    25222273 * @param int $topic_id The topic id.
    25232274 *
    2524  * @uses bbp_is_reply() To check if the passed topic id is a reply
    2525  * @uses bbp_get_reply_topic_id() To get the replies topic id
    2526  * @uses bbp_bump_topic_reply_count() To bump the topic reply count
    2527  *
    25282275 * @return void
    25292276 */
     
    25502297 * @param int $topic_id   Optional. Topic id.
    25512298 * @param int $difference Optional. Default 1
    2552  * @uses bbp_get_topic_id() To get the topic id
    2553  * @uses bbp_get_topic_reply_count_hidden To get the topic's hidden reply count
    2554  * @uses update_post_meta() To update the topic's reply count meta
    2555  * @uses apply_filters() Calls 'bbp_bump_topic_reply_count_hidden' with the
    2556  *                        reply count, topic id, and difference
    25572299 * @return int Topic hidden reply count
    25582300 */
     
    25842326 * @param int $topic_id The topic id.
    25852327 *
    2586  * @uses bbp_is_reply() To check if the passed topic id is a reply
    2587  * @uses bbp_get_reply_topic_id() To get the topic id
    2588  * @uses bbp_bump_topic_reply_count_hidden() To bump topic hidden reply count
    2589  *
    25902328 * @return void
    25912329 */
     
    26122350 * @param int $topic_id The topic id.
    26132351 *
    2614  * @uses bbp_is_reply() To check if the passed topic id is a reply
    2615  * @uses bbp_get_reply_topic_id() To get the topic id
    2616  * @uses bbp_bump_topic_reply_count_hidden() To bump topic hidden reply count
    2617  *
    26182352 * @return void
    26192353 */
     
    26412375 * @param int $forum_id The forum id.
    26422376 *
    2643  * @uses bbp_get_topic_status() To get the post status
    2644  * @uses bbp_get_public_status_id() To get the public status id
    2645  * @uses bbp_increase_forum_topic_count() To bump the topic's forum topic count by 1
    2646  * @uses bbp_increase_forum_topic_count_hidden() To bump the topic's forum topic
    2647  *                                               hidden count by 1
    2648  *
    26492377 * @return void
    26502378 */
     
    26702398 * @param int $topic_id Optional. Topic id to update
    26712399 * @param int $forum_id Optional. Forum id
    2672  * @uses bbp_is_reply() TO check if the passed topic id is a reply
    2673  * @uses bbp_get_reply_topic_id() To get the reply topic id
    2674  * @uses bbp_get_topic_id() To get the topic id
    2675  * @uses get_post_field() To get the post parent of the topic id
    2676  * @uses bbp_get_forum_id() To get the forum id
    2677  * @uses update_post_meta() To update the topic forum id meta
    2678  * @uses apply_filters() Calls 'bbp_update_topic_forum_id' with the forum id
    2679  *                        and topic id
    26802400 * @return int Forum id
    26812401 */
     
    27062426 *
    27072427 * @param int $topic_id Optional. Topic id to update
    2708  * @uses bbp_get_topic_id() To get the topic id
    2709  * @uses update_post_meta() To update the topic's topic id meta
    2710  * @uses apply_filters() Calls 'bbp_update_topic_topic_id' with the topic id
    27112428 * @return int Topic id
    27122429 */
     
    27272444 * @param int $topic_id Optional. Topic id to update
    27282445 * @param int $reply_count Optional. Set the reply count manually.
    2729  * @uses bbp_is_reply() To check if the passed topic id is a reply
    2730  * @uses bbp_get_reply_topic_id() To get the reply topic id
    2731  * @uses bbp_get_topic_id() To get the topic id
    2732  * @uses bbp_get_reply_post_type() To get the reply post type
    2733  * @uses bbp_get_public_child_count() To get the reply count
    2734  * @uses update_post_meta() To update the topic reply count meta
    2735  * @uses apply_filters() Calls 'bbp_update_topic_reply_count' with the reply
    2736  *                        count and topic id
    27372446 * @return int Topic reply count
    27382447 */
     
    27652474 * @param int $topic_id Optional. Topic id to update
    27662475 * @param int $reply_count Optional. Set the reply count manually
    2767  * @uses bbp_is_reply() To check if the passed topic id is a reply
    2768  * @uses bbp_get_reply_topic_id() To get the reply topic id
    2769  * @uses bbp_get_topic_id() To get the topic id
    2770  * @uses bbp_get_trash_status_id() To get the trash status id
    2771  * @uses bbp_get_spam_status_id() To get the spam status id
    2772  * @uses bbp_get_pending_status_id() To get the pending status id
    2773  * @uses bbp_get_reply_post_type() To get the reply post type
    2774  * @uses wpdb::prepare() To prepare our database query
    2775  * @uses wpdb::get_var() To execute our query and get the var back
    2776  * @uses update_post_meta() To update the topic hidden reply count meta
    2777  * @uses apply_filters() Calls 'bbp_update_topic_reply_count_hidden' with the
    2778  *                        hidden reply count and topic id
    27792476 * @return int Topic hidden reply count
    27802477 */
     
    28102507 * @param int $topic_id Optional. Topic id to update
    28112508 * @param int $active_id Optional. active id
    2812  * @uses bbp_is_reply() To check if the passed topic id is a reply
    2813  * @uses bbp_get_reply_topic_id() To get the reply topic id
    2814  * @uses bbp_get_topic_id() To get the topic id
    2815  * @uses bbp_get_reply_post_type() To get the reply post type
    2816  * @uses bbp_get_public_child_last_id() To get the last public reply id
    2817  * @uses bbp_get_active_id() To get the active id
    2818  * @uses update_post_meta() To update the topic last active id meta
    2819  * @uses apply_filters() Calls 'bbp_update_topic_last_active_id' with the active
    2820  *                        id and topic id
    28212509 * @return int Active id
    28222510 */
     
    28562544 * @param int    $topic_id Optional. Topic id.
    28572545 * @param string $new_time Optional. New time in mysql format.
    2858  * @uses bbp_is_reply() To check if the passed topic id is a reply
    2859  * @uses bbp_get_topic_id() To get the topic id
    2860  * @uses bbp_get_reply_topic_id() To get the reply topic id
    2861  * @uses get_post_field() To get the timestamp of the newest topic reply
    2862  * @uses bbp_get_public_child_last_id() To get the newest topic reply id
    2863  * @uses bbp_get_reply_post_type() To get the reply post type
    2864  * @uses update_post_meta() To update the topic last active time meta
    28652546 * @return string MySQL timestamp of last active reply
    28662547 */
     
    28932574 * @param int $topic_id Optional. Topic id to update
    28942575 * @param int $reply_id Optional. Reply id
    2895  * @uses bbp_is_reply() To check if the passed topic id is a reply
    2896  * @uses bbp_get_reply_id() To get the reply id
    2897  * @uses bbp_get_reply_topic_id() To get the reply topic id
    2898  * @uses bbp_get_topic_id() To get the topic id
    2899  * @uses bbp_get_reply_post_type() To get the reply post type
    2900  * @uses bbp_get_public_child_last_id() To get the last public reply id
    2901  * @uses update_post_meta() To update the topic last reply id meta
    2902  * @uses apply_filters() Calls 'bbp_update_topic_last_reply_id' with the reply
    2903  *                        id and topic id
    29042576 * @return int Reply id
    29052577 */
     
    29422614 *
    29432615 * @param int $topic_id Optional. Topic id to update
    2944  * @uses bbp_is_reply() To check if the passed topic id is a reply
    2945  * @uses bbp_get_reply_topic_id() To get the reply topic id
    2946  * @uses bbp_get_topic_id() To get the topic id
    2947  * @uses bbp_get_reply_topic_id() To get the reply topic id
    2948  * @uses bbp_get_reply_post_type() To get the reply post type
    2949  * @uses bbp_get_topic_post_type() To get the topic post type
    2950  * @uses wpdb::prepare() To prepare our database query
    2951  * @uses wpdb::get_var() To execute our query and get the column back
    2952  * @uses update_post_meta() To update the topic voice count meta
    2953  * @uses apply_filters() Calls 'bbp_update_topic_voice_count' with the voice
    2954  *                        count and topic id
    29552616 * @return int Voice count
    29562617 */
     
    29832644 *
    29842645 * @param int $topic_id Optional. Topic id to update
    2985  * @uses bbp_is_reply() To check if the passed topic id is a reply
    2986  * @uses bbp_get_reply_topic_id() To get the reply topic id
    2987  * @uses bbp_get_topic_id() To get the topic id
    2988  * @uses bbp_get_reply_topic_id() To get the reply topic id
    2989  * @uses bbp_get_reply_post_type() To get the reply post type
    2990  * @uses bbp_get_topic_post_type() To get the topic post type
    2991  * @uses wpdb::prepare() To prepare our database query
    2992  * @uses wpdb::get_var() To execute our query and get the column back
    2993  * @uses update_post_meta() To update the topic anonymous reply count meta
    2994  * @uses apply_filters() Calls 'bbp_update_topic_anonymous_reply_count' with the
    2995  *                        anonymous reply count and topic id
    29962646 * @return int Anonymous reply count
    29972647 */
     
    30242674 *  - reason: Reason for editing
    30252675 *  - revision_id: Revision id
    3026  * @uses bbp_get_topic_id() To get the topic id
    3027  * @uses bbp_format_revision_reason() To format the reason
    3028  * @uses bbp_get_topic_raw_revision_log() To get the raw topic revision log
    3029  * @uses update_post_meta() To update the topic revision log meta
    30302676 * @return mixed False on failure, true on success
    30312677 */
     
    30622708 *
    30632709 * @param int $topic_id Topic id
    3064  * @uses bbp_get_topic() To get the topic
    3065  * @uses get_post_meta() To get the topic status meta
    3066  * @uses bbp_get_closed_status_id() to get the closed status
    3067  * @uses bbp_get_public_status_id() to get the public status
    3068  * @uses do_action() Calls 'bbp_close_topic' with the topic id
    3069  * @uses add_post_meta() To add the previous status to a meta
    3070  * @uses post_type_supports() To check if revisions are enabled
    3071  * @uses bbp_get_topic_post_type() To get the topic post type
    3072  * @uses remove_post_type_support() To temporarily remove topic revisions
    3073  * @uses wp_update_post() To update the topic with the new status
    3074  * @uses add_post_type_support() To restore topic revisions
    3075  * @uses do_action() Calls 'bbp_closed_topic' with the topic id
    30762710 * @return mixed False or {@link WP_Error} on failure, topic id on success
    30772711 */
     
    31322766 *
    31332767 * @param int $topic_id Topic id
    3134  * @uses bbp_get_topic() To get the topic
    3135  * @uses do_action() Calls 'bbp_open_topic' with the topic id
    3136  * @uses get_post_meta() To get the previous status
    3137  * @uses delete_post_meta() To delete the previous status meta
    3138  * @uses post_type_supports() To check if revisions are enabled
    3139  * @uses bbp_get_topic_post_type() To get the topic post type
    3140  * @uses remove_post_type_support() To temporarily remove topic revisions
    3141  * @uses wp_update_post() To update the topic with the new status
    3142  * @uses add_post_type_support() To restore topic revisions
    3143  * @uses do_action() Calls 'bbp_opened_topic' with the topic id
    31442768 * @return mixed False or {@link WP_Error} on failure, topic id on success
    31452769 */
     
    32022826 *
    32032827 * @param int $topic_id Topic id
    3204  * @uses bbp_get_topic() To get the topic
    3205  * @uses do_action() Calls 'bbp_spam_topic' with the topic id
    3206  * @uses add_post_meta() To add the previous status to a meta
    3207  * @uses wp_update_post() To update the topic with the new status
    3208  * @uses do_action() Calls 'bbp_spammed_topic' with the topic id
    32092828 * @return mixed False or {@link WP_Error} on failure, topic id on success
    32102829 */
     
    33402959 *
    33412960 * @param int $topic_id Topic id
    3342  * @uses bbp_get_topic() To get the topic
    3343  * @uses do_action() Calls 'bbp_unspam_topic' with the topic id
    3344  * @uses get_post_meta() To get the previous status
    3345  * @uses delete_post_meta() To delete the previous status meta
    3346  * @uses wp_update_post() To update the topic with the new status
    3347  * @uses do_action() Calls 'bbp_unspammed_topic' with the topic id
    33482961 * @return mixed False or {@link WP_Error} on failure, topic id on success
    33492962 */
     
    34593072 * @param int $topic_id Optional. Topic id
    34603073 * @param int $super Should we make the topic a super sticky?
    3461  * @uses bbp_get_topic_id() To get the topic id
    3462  * @uses bbp_unstick_topic() To unstick the topic
    3463  * @uses bbp_get_topic_forum_id() To get the topic forum id
    3464  * @uses bbp_get_stickies() To get the stickies
    3465  * @uses do_action() 'bbp_stick_topic' with topic id and bool super
    3466  * @uses update_option() To update the super stickies option
    3467  * @uses update_post_meta() To update the forum stickies meta
    3468  * @uses do_action() Calls 'bbp_stuck_topic' with the topic id, bool super
    3469  *                    and success
    34703074 * @return bool True on success, false on failure
    34713075 */
     
    35203124 *
    35213125 * @param int $topic_id Topic id
    3522  * @uses bbp_get_topic() To get the topic
    3523  * @uses bbp_get_pending_status_id() To get the pending status id
    3524  * @uses do_action() Calls 'bbp_approve_topic' with the topic id
    3525  * @uses bbp_get_public_status_id() To get the public status id
    3526  * @uses remove_action() To remove the auto save post revision action
    3527  * @uses wp_update_post() To update the topic with the new status
    3528  * @uses do_action() Calls 'bbp_approved_topic' with the topic id
    35293126 * @return mixed False or {@link WP_Error} on failure, topic id on success
    35303127 */
     
    35673164 *
    35683165 * @param int $topic_id Topic id
    3569  * @uses bbp_get_topic() To get the topic
    3570  * @uses bbp_get_pending_status_id() To get the pending status id
    3571  * @uses do_action() Calls 'bbp_unapprove_topic' with the topic id
    3572  * @uses remove_action() To remove the auto save post revision action
    3573  * @uses wp_update_post() To update the topic with the new status
    3574  * @uses do_action() Calls 'bbp_unapproved_topic' with the topic id
    35753166 * @return mixed False or {@link WP_Error} on failure, topic id on success
    35763167 */
     
    36133204 *
    36143205 * @param int $topic_id Optional. Topic id
    3615  * @uses bbp_get_topic_id() To get the topic id
    3616  * @uses bbp_is_topic_super_sticky() To check if the topic is a super sticky
    3617  * @uses bbp_get_topic_forum_id() To get the topic forum id
    3618  * @uses bbp_get_stickies() To get the forum stickies
    3619  * @uses do_action() Calls 'bbp_unstick_topic' with the topic id
    3620  * @uses delete_option() To delete the super stickies option
    3621  * @uses update_option() To update the super stickies option
    3622  * @uses delete_post_meta() To delete the forum stickies meta
    3623  * @uses update_post_meta() To update the forum stickies meta
    3624  * @uses do_action() Calls 'bbp_unstuck_topic' with the topic id and success
    36253206 * @return bool Always true.
    36263207 */
     
    36623243 * handled by WordPress core API functions. It is used to clean up after
    36633244 * a topic that is being deleted.
    3664  *
    3665  * @uses bbp_get_topic_id() To get the topic id
    3666  * @uses bbp_is_topic() To check if the passed id is a topic
    3667  * @uses do_action() Calls 'bbp_delete_topic' with the topic id
    3668  * @uses bbp_has_replies() To check if the topic has replies
    3669  * @uses bbp_replies() To loop through the replies
    3670  * @uses bbp_the_reply() To set a reply as the current reply in the loop
    3671  * @uses bbp_get_reply_id() To get the reply id
    3672  * @uses wp_delete_post() To delete the reply
    36733245 */
    36743246function bbp_delete_topic( $topic_id = 0 ) {
     
    37283300 * handled by WordPress core API functions. It is used to clean up after
    37293301 * a topic that is being trashed.
    3730  *
    3731  * @uses bbp_get_topic_id() To get the topic id
    3732  * @uses bbp_is_topic() To check if the passed id is a topic
    3733  * @uses do_action() Calls 'bbp_trash_topic' with the topic id
    3734  * @uses wp_trash_post() To trash the reply
    3735  * @uses update_post_meta() To save a list of just trashed replies for future use
    37363302 */
    37373303function bbp_trash_topic( $topic_id = 0 ) {
     
    37963362/**
    37973363 * Called before untrashing a topic
    3798  *
    3799  * @uses bbp_get_topic_id() To get the topic id
    3800  * @uses bbp_is_topic() To check if the passed id is a topic
    3801  * @uses do_action() Calls 'bbp_untrash_topic' with the topic id
    3802  * @uses get_post_meta() To get the list of replies which were trashed with the
    3803  *                        topic
    3804  * @uses wp_untrash_post() To untrash the reply
    38053364 */
    38063365function bbp_untrash_topic( $topic_id = 0 ) {
     
    38553414 *
    38563415 * @since 2.0.0 bbPress (r2993)
    3857  *
    3858  * @uses bbp_get_topic_id() To get the topic id
    3859  * @uses bbp_is_topic() To check if the passed id is a topic
    3860  * @uses do_action() Calls 'bbp_deleted_topic' with the topic id
    38613416 */
    38623417function bbp_deleted_topic( $topic_id = 0 ) {
     
    38743429 *
    38753430 * @since 2.0.0 bbPress (r2993)
    3876  *
    3877  * @uses bbp_get_topic_id() To get the topic id
    3878  * @uses bbp_is_topic() To check if the passed id is a topic
    3879  * @uses do_action() Calls 'bbp_trashed_topic' with the topic id
    38803431 */
    38813432function bbp_trashed_topic( $topic_id = 0 ) {
     
    38933444 *
    38943445 * @since 2.0.0 bbPress (r2993)
    3895  *
    3896  * @uses bbp_get_topic_id() To get the topic id
    3897  * @uses bbp_is_topic() To check if the passed id is a topic
    3898  * @uses do_action() Calls 'bbp_untrashed_topic' with the topic id
    38993446 */
    39003447function bbp_untrashed_topic( $topic_id = 0 ) {
     
    39143461 *
    39153462 * @since 2.0.0 bbPress (r3540)
    3916  *
    3917  * @param int $default Default replies per page (15)
    3918  * @uses get_option() To get the setting
    3919  * @uses apply_filters() To allow the return value to be manipulated
    39203463 * @return int
    39213464 */
     
    39403483 *
    39413484 * @param int $default Default replies per page (25)
    3942  * @uses get_option() To get the setting
    3943  * @uses apply_filters() To allow the return value to be manipulated
    39443485 * @return int
    39453486 */
     
    40843625 *
    40853626 * @since 2.0.0 bbPress (r3171)
    4086  *
    4087  * @uses bbp_version()
    4088  * @uses bbp_is_single_topic()
    4089  * @uses bbp_user_can_view_forum()
    4090  * @uses bbp_get_topic_forum_id()
    4091  * @uses bbp_show_lead_topic()
    4092  * @uses bbp_topic_permalink()
    4093  * @uses bbp_topic_title()
    4094  * @uses bbp_get_topic_reply_count()
    4095  * @uses bbp_topic_content()
    4096  * @uses bbp_has_topics()
    4097  * @uses bbp_topics()
    4098  * @uses bbp_the_topic()
    4099  * @uses get_bloginfo_rss()
    4100  * @uses get_option()
    4101  * @uses self_link()
    4102  * @uses the_author()
    4103  * @uses get_post_time()
    4104  * @uses rss_enclosure()
    4105  * @uses do_action()
    4106  * @uses apply_filters()
    41073627 *
    41083628 * @param array $topics_query
     
    41913711 *
    41923712 * @since 2.1.0 bbPress (r3605)
    4193  *
    4194  * @uses bbp_is_topic_edit()
    4195  * @uses current_user_can()
    4196  * @uses bbp_get_topic_id()
    4197  * @uses bbp_redirect()
    4198  * @uses bbp_get_topic_permalink()
    41993713 */
    42003714function bbp_check_topic_edit() {
     
    42153729 *
    42163730 * @since 2.1.0 bbPress (r3605)
    4217  *
    4218  * @uses bbp_is_topic_tag_edit()
    4219  * @uses current_user_can()
    4220  * @uses bbp_get_topic_tag_id()
    4221  * @uses bbp_redirect()
    4222  * @uses bbp_get_topic_tag_link()
    42233731 */
    42243732function bbp_check_topic_tag_edit() {
Note: See TracChangeset for help on using the changeset viewer.