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

    r6569 r6573  
    1818 *
    1919 * @since 2.0.0 bbPress (r3349)
    20  *
    21  * @uses bbp_parse_args()
    22  * @uses bbp_get_forum_post_type()
    23  * @uses wp_insert_post()
    24  * @uses update_post_meta()
    2520 *
    2621 * @param array $forum_data Forum post data
     
    115110 *
    116111 * @param string $action The requested action to compare this function to
    117  * @uses bbp_add_error() To add an error message
    118  * @uses bbp_verify_nonce_request() To verify the nonce and check the request
    119  * @uses bbp_is_anonymous() To check if an anonymous post is being made
    120  * @uses current_user_can() To check if the current user can publish forum
    121  * @uses bbp_get_current_user_id() To get the current user id
    122  * @uses is_wp_error() To check if the value retrieved is a {@link WP_Error}
    123  * @uses bbp_is_forum_category() To check if the forum is a category
    124  * @uses bbp_is_forum_closed() To check if the forum is closed
    125  * @uses bbp_is_forum_private() To check if the forum is private
    126  * @uses bbp_check_for_flood() To check for flooding
    127  * @uses bbp_check_for_duplicate() To check for duplicates
    128  * @uses bbp_get_forum_post_type() To get the forum post type
    129  * @uses remove_filter() To remove kses filters if needed
    130  * @uses apply_filters() Calls 'bbp_new_forum_pre_title' with the content
    131  * @uses apply_filters() Calls 'bbp_new_forum_pre_content' with the content
    132  * @uses bbPress::errors::get_error_codes() To get the {@link WP_Error} errors
    133  * @uses do_action() Calls 'bbp_new_forum' with the forum id, forum id,
    134  *                    anonymous data and reply author
    135  * @uses bbp_get_forum_permalink() To get the forum permalink
    136  * @uses bbp_redirect() To redirect to the forum link
    137  * @uses bbPress::errors::get_error_messages() To get the {@link WP_Error} error
    138  *                                              messages
    139112 */
    140113function bbp_new_forum_handler( $action = '' ) {
     
    381354 *
    382355 * @param string $action The requested action to compare this function to
    383  * @uses bbPress:errors::add() To log various error messages
    384  * @uses bbp_get_forum() To get the forum
    385  * @uses bbp_verify_nonce_request() To verify the nonce and check the request
    386  * @uses bbp_is_forum_anonymous() To check if forum is by an anonymous user
    387  * @uses current_user_can() To check if the current user can edit the forum
    388  * @uses is_wp_error() To check if the value retrieved is a {@link WP_Error}
    389  * @uses bbp_is_forum_category() To check if the forum is a category
    390  * @uses bbp_is_forum_closed() To check if the forum is closed
    391  * @uses bbp_is_forum_private() To check if the forum is private
    392  * @uses remove_filter() To remove kses filters if needed
    393  * @uses apply_filters() Calls 'bbp_edit_forum_pre_title' with the title and
    394  *                        forum id
    395  * @uses apply_filters() Calls 'bbp_edit_forum_pre_content' with the content
    396  *                        and forum id
    397  * @uses bbPress::errors::get_error_codes() To get the {@link WP_Error} errors
    398  * @uses wp_save_post_revision() To save a forum revision
    399  * @uses bbp_update_forum_revision_log() To update the forum revision log
    400  * @uses wp_update_post() To update the forum
    401  * @uses do_action() Calls 'bbp_edit_forum' with the forum id, forum id,
    402  *                    anonymous data and reply author
    403  * @uses bbp_move_forum_handler() To handle movement of a forum from one forum
    404  *                                 to another
    405  * @uses bbp_get_forum_permalink() To get the forum permalink
    406  * @uses bbp_redirect() To redirect to the forum link
    407  * @uses bbPress::errors::get_error_messages() To get the {@link WP_Error} error
    408  *                                              messages
    409356 */
    410357function bbp_edit_forum_handler( $action = '' ) {
     
    640587 *
    641588 * @param int $forum_id
    642  * @uses bbp_is_forum_closed() To check if forum is closed
    643  * @uses bbp_close_forum() To close forum
    644  * @uses bbp_open_forum() To open forum
    645  * @uses bbp_is_forum_category() To check if forum is a category
    646  * @uses bbp_categorize_forum() To turn forum into a category
    647  * @uses bbp_normalize_forum() To turn category into forum
    648  * @uses bbp_get_public_status_id() To get the public status ID
    649  * @uses bbp_get_private_status_id() To get the private status ID
    650  * @uses bbp_get_hidden_status_id() To get the hidden status ID
    651  * @uses bbp_get_forum_visibility() To get the forums visibility
    652  * @uses bbp_hide_forum() To hide a forum
    653  * @uses bbp_privatize_forum() To make a forum private
    654  * @uses bbp_publicize_forum() To make a forum public
    655589 * @return If forum ID is empty
    656590 */
     
    768702 *
    769703 * @param int $forum_id forum id
    770  * @uses do_action() Calls 'bbp_close_forum' with the forum id
    771  * @uses update_post_meta() To add the previous status to a meta
    772  * @uses do_action() Calls 'bbp_opened_forum' with the forum id
    773704 * @return mixed False or {@link WP_Error} on failure, forum id on success
    774705 */
     
    792723 *
    793724 * @param int $forum_id forum id
    794  * @uses do_action() Calls 'bbp_open_forum' with the forum id
    795  * @uses get_post_meta() To get the previous status
    796  * @uses update_post_meta() To delete the previous status meta
    797  * @uses do_action() Calls 'bbp_opened_forum' with the forum id
    798725 * @return mixed False or {@link WP_Error} on failure, forum id on success
    799726 */
     
    819746 *
    820747 * @param int $forum_id Optional. Forum id
    821  * @uses update_post_meta() To update the forum category meta
    822748 * @return bool False on failure, true on success
    823749 */
     
    841767 *
    842768 * @param int $forum_id Optional. Forum id
    843  * @uses delete_post_meta() To delete the forum category meta
    844769 * @return bool False on failure, true on success
    845770 */
     
    865790 *
    866791 * @param int $forum_id Optional. Forum id
    867  * @uses update_post_meta() To update the forum private meta
    868792 * @return bool False on failure, true on success
    869793 */
     
    923847 *
    924848 * @param int $forum_id Optional. Forum id
    925  * @uses update_post_meta() To update the forum private meta
    926849 * @return bool False on failure, true on success
    927850 */
     
    973896 *
    974897 * @param int $forum_id Optional. Forum id
    975  * @uses update_post_meta() To update the forum private meta
    976898 * @return bool False on failure, true on success
    977899 */
     
    1022944 * @since 2.4.0 bbPress (r5017)
    1023945 *
    1024  * @uses delete_option() to delete private and hidden forum pointers
    1025  * @uses WP_Query() To query post IDs
    1026  * @uses is_wp_error() To return if error occurred
    1027  * @uses update_option() To update the private and hidden post ID pointers
    1028946 * @return array An array of the status code and the message
    1029947 */
     
    10911009 *
    10921010 * @param int $forum_id Get the forum ID to remove
    1093  * @uses bbp_is_subscriptions_active() To check if the subscriptions are active
    1094  * @uses bbp_get_forum_id To get the forum id
    1095  * @uses bbp_get_forum_subscribers() To get the forum subscribers
    1096  * @uses bbp_remove_user_subscription() To remove the user subscription
    10971011 */
    10981012function bbp_remove_forum_from_all_subscriptions( $forum_id = 0 ) {
     
    11231037 * @param int $difference Optional. Default 1
    11241038 * @param bool $update_ancestors Optional. Default true
    1125  * @uses bbp_get_forum_id() To get the forum id
    1126  * @uses update_post_meta() To update the forum's topic count meta
    1127  * @uses apply_filters() Calls 'bbp_bump_forum_topic_count' with the topic
    1128  *                        count, forum id, and difference
     1039 *
    11291040 * @return int Forum topic count
    11301041 */
     
    11831094 *
    11841095 * @param int $forum_id The forum id.
    1185  *
    1186  * @uses bbp_is_topic() To get the topic id
    1187  * @uses bbp_get_topic_forum_id() To get the topics forum id
    1188  * @uses bbp_is_topic_published() To get the topics published status
    1189  * @uses bbp_is_topic_closed() To get the topics closed status
    1190  * @uses bbp_increase_forum_topic_count_hidden() To increase the forums hidden
    1191  *                                                topic count by 1
    1192  * @uses bbp_bump_forum_topic_count() To bump the forum topic count
    1193  *
    11941096 * @return void
    11951097 */
     
    12231125 * @param int $forum_id The forum id.
    12241126 *
    1225  * @uses bbp_is_topic() To get the topic id
    1226  * @uses bbp_get_topic_forum_id() To get the topics forum id
    1227  * @uses bbp_bump_forum_topic_count() To bump the forum topic count
    1228  *
    12291127 * @return void
    12301128 */
     
    12511149 * @param int $forum_id Optional. Forum id.
    12521150 * @param int $difference Optional. Default 1
    1253  * @uses bbp_get_forum_id() To get the forum id
    1254  * @uses bbp_get_forum_topic_count_hidden To get the forum's hidden topic count
    1255  * @uses update_post_meta() To update the forum's topic count meta
    1256  * @uses apply_filters() Calls 'bbp_bump_forum_topic_count_hidden' with the
    1257  *                        topic count, forum id, and difference
     1151 *
    12581152 * @return int Forum hidden topic count
    12591153 */
     
    12851179 * @param int $forum_id The forum id.
    12861180 *
    1287  * @uses bbp_is_topic() To get the topic id
    1288  * @uses bbp_get_topic_forum_id() To get the topics forum id
    1289  * @uses bbp_bump_forum_topic_count_hidden() To bump the forum hidden topic count
    1290  *
    12911181 * @return void
    12921182 */
     
    13131203 * @param int $forum_id The forum id.
    13141204 *
    1315  * @uses bbp_is_topic() To get the topic id
    1316  * @uses bbp_get_topic_forum_id() To get the topics forum id
    1317  * @uses bbp_bump_forum_topic_count_hidden() To bump the forums hidden topic
    1318  *                                            count by -1
    1319  *
    13201205 * @return void
    13211206 */
     
    13431228 * @param int $difference Optional. Default 1
    13441229 * @param bool $update_ancestors Optional. Default true
    1345  * @uses bbp_get_forum_id() To get the forum id
    1346  * @uses update_post_meta() To update the forum's topic count meta
    1347  * @uses apply_filters() Calls 'bbp_bump_forum_reply_count' with the topic
    1348  *                        count, forum id, and difference
     1230 *
    13491231 * @return int Forum topic count
    13501232 */
     
    14041286 * @param int $forum_id The forum id.
    14051287 *
    1406  * @uses bbp_is_reply() To get the reply id
    1407  * @uses bbp_get_reply_forum_id() To get the replies forum id
    1408  * @uses bbp_is_reply_published() To get the replies published status
    1409  * @uses bbp_bump_forum_reply_count() To bump the forum reply count
    1410  *
    14111288 * @return void
    14121289 */
     
    14331310 * @param int $forum_id The forum id.
    14341311 *
    1435  * @uses bbp_is_reply() To get the reply id
    1436  * @uses bbp_get_reply_forum_id() To get the replies forum id
    1437  * @uses bbp_bump_forum_reply_count() To bump the forum reply count
    1438  *
    14391312 * @return void
    14401313 */
     
    14611334 * @param int $topic_id The topic id.
    14621335 *
    1463  * @uses bbp_get_public_child_ids() To get the topic's public child ids
    1464  * @uses bbp_get_reply_post_type() To get the reply post type
    1465  * @uses bbp_bump_forum_reply_count() To bump the forum reply count
    1466  * @uses bbp_get_topic_forum_id() To get the topics forum id
    1467  *
    14681336 * @return void
    14691337 */
     
    14971365 * @param int $forum_id Optional. Forum id.
    14981366 * @param int $topic_id Optional. Topic id.
    1499  * @uses bbp_get_forum_id() To get the forum id
    1500  * @uses bbp_forum_query_subforum_ids() To get the subforum ids
    1501  * @uses bbp_update_forum_last_topic_id() To update the last topic id of child
    1502  *                                         forums
    1503  * @uses bbp_get_topic_post_type() To get the topic post type
    1504  * @uses get_posts() To get the most recent topic in the forum
    1505  * @uses bbp_is_topic_published() To check if the topic is published
    1506  * @uses update_post_meta() To update the forum's last active id meta
    1507  * @uses apply_filters() Calls 'bbp_update_forum_last_topic_id' with the last
    1508  *                        topic id and forum id
    15091367 * @return int Id of the forums most recent topic
    15101368 */
     
    15681426 * @param int $forum_id Optional. Forum id.
    15691427 * @param int $reply_id Optional. Reply id.
    1570  * @uses bbp_get_forum_id() To get the forum id
    1571  * @uses bbp_forum_query_subforum_ids() To get the subforum ids
    1572  * @uses bbp_update_forum_last_reply_id() To update the last reply id of child
    1573  *                                         forums
    1574  * @uses bbp_forum_query_topic_ids() To get the topic ids in the forum
    1575  * @uses bbp_forum_query_last_reply_id() To get the forum's last reply id
    1576  * @uses bbp_is_reply_published() To make sure the reply is published
    1577  * @uses update_post_meta() To update the forum's last active id meta
    1578  * @uses apply_filters() Calls 'bbp_update_forum_last_reply_id' with the last
    1579  *                        reply id and forum id
    15801428 * @return int Id of the forums most recent reply
    15811429 */
     
    16341482 * @param int $forum_id Optional. Forum id.
    16351483 * @param int $active_id Optional. Active post id.
    1636  * @uses bbp_get_forum_id() To get the forum id
    1637  * @uses bbp_forum_query_subforum_ids() To get the subforum ids
    1638  * @uses bbp_update_forum_last_active_id() To update the last active id of
    1639  *                                          child forums
    1640  * @uses bbp_forum_query_topic_ids() To get the topic ids in the forum
    1641  * @uses bbp_forum_query_last_reply_id() To get the forum's last reply id
    1642  * @uses bbp_get_public_status_id() To get the public status id
    1643  * @uses get_post_status() To make sure the reply is published
    1644  * @uses update_post_meta() To update the forum's last active id meta
    1645  * @uses apply_filters() Calls 'bbp_update_forum_last_active_id' with the last
    1646  *                        active post id and forum id
    16471484 * @return int Id of the forums last active post
    16481485 */
     
    17021539 * @param int    $forum_id Optional. Topic id.
    17031540 * @param string $new_time Optional. New time in mysql format.
    1704  * @uses bbp_get_forum_id() To get the forum id
    1705  * @uses bbp_get_forum_last_active_id() To get the forum's last post id
    1706  * @uses get_post_field() To get the post date of the forum's last post
    1707  * @uses update_post_meta() To update the forum last active time
    1708  * @uses apply_filters() Calls 'bbp_update_forum_last_active' with the new time
    1709  *                        and forum id
     1541 *
    17101542 * @return string MySQL timestamp of last active topic or reply
    17111543 */
     
    17331565 *
    17341566 * @param int $forum_id Optional. Forum id
    1735  * @uses bbp_get_forum_id() To get the forum id
    17361567 * @return bool True on success, false on failure
    17371568 */
     
    17591590 *                       is a topic or a forum. If it's a topic, its parent,
    17601591 *                       i.e. the forum is automatically retrieved.
    1761  * @param bool $total_count Optional. To return the total count or normal
    1762  *                           count?
    1763  * @uses bbp_get_forum_id() To get the forum id
    1764  * @uses bbp_forum_query_subforum_ids() To get the subforum ids
    1765  * @uses bbp_update_forum_topic_count() To update the forum topic count
    1766  * @uses bbp_forum_query_topic_ids() To get the forum topic ids
    1767  * @uses update_post_meta() To update the forum's topic count meta
    1768  * @uses apply_filters() Calls 'bbp_update_forum_topic_count' with the topic
    1769  *                        count and forum id
     1592 * @param bool $total_count Optional. To return the total count or normal count?
     1593 
    17701594 * @return int Forum topic count
    17711595 */
     
    18051629 * @param int $forum_id Optional. Topic id to update.
    18061630 * @param int $topic_count Optional. Set the topic count manually.
    1807  * @uses bbp_is_topic() To check if the supplied id is a topic
    1808  * @uses bbp_get_topic_id() To get the topic id
    1809  * @uses bbp_get_topic_forum_id() To get the topic forum id
    1810  * @uses bbp_get_forum_id() To get the forum id
    1811  * @uses bbp_get_trash_status_id() To get the trash status id
    1812  * @uses bbp_get_spam_status_id() To get the spam status id
    1813  * @uses bbp_get_pending_status_id() To get the pending status id
    1814  * @uses bbp_get_topic_post_type() To get the topic post type
    1815  * @uses update_post_meta() To update the forum hidden topic count meta
    1816  * @uses apply_filters() Calls 'bbp_update_forum_topic_count_hidden' with the
    1817  *                        hidden topic count and forum id
     1631 *
    18181632 * @return int Topic hidden topic count
    18191633 */
     
    18711685 *                       is a topic or a forum. If it's a topic, its parent,
    18721686 *                       i.e. the forum is automatically retrieved.
    1873  * @uses bbp_get_forum_id() To get the forum id
    1874  * @uses bbp_forum_query_subforum_ids() To get the subforum ids
    1875  * @uses bbp_update_forum_reply_count() To update the forum reply count
    1876  * @uses bbp_forum_query_topic_ids() To get the forum topic ids
    1877  * @uses bbp_get_public_status_id() To get the public status id
    1878  * @uses bbp_get_reply_post_type() To get the reply post type
    1879  * @uses update_post_meta() To update the forum's reply count meta
    1880  * @uses apply_filters() Calls 'bbp_update_forum_reply_count' with the reply
    1881  *                        count and forum id
     1687 *
    18821688 * @return int Forum reply count
    18831689 */
     
    19421748 *  - last_active_id: Last active post id
    19431749 *  - last_active_time: last active time
    1944  * @uses bbp_update_forum_last_topic_id() To update the forum last topic id
    1945  * @uses bbp_update_forum_last_reply_id() To update the forum last reply id
    1946  * @uses bbp_update_forum_last_active_id() To update the last active post id
    1947  * @uses get_post_field() To get the post date of the last active id
    1948  * @uses bbp_update_forum_last_active_time()  To update the last active time
    1949  * @uses bbp_update_forum_subforum_count() To update the subforum count
    1950  * @uses bbp_update_forum_topic_count() To update the forum topic count
    1951  * @uses bbp_update_forum_reply_count() To update the forum reply count
    1952  * @uses bbp_update_forum_topic_count_hidden() To update the hidden topic count
    19531750 */
    19541751function bbp_update_forum( $args = array() ) {
     
    20651862 *
    20661863 * @since 2.0.0 bbPress (r3007)
    2067  *
    2068  * @uses get_option() Returns the unserialized array of hidden forum ids
    2069  * @uses wp_parse_id_list() Make sure array items are ints
    2070  * @uses apply_filters() Calls 'bbp_forum_query_topic_ids' with the topic ids
    2071  *                        and forum id
    20721864 */
    20731865function bbp_get_hidden_forum_ids() {
     
    20871879 *
    20881880 * @since 2.0.0 bbPress (r3007)
    2089  *
    2090  * @uses get_option() Returns the unserialized array of private forum ids
    2091  * @uses wp_parse_id_list() Make sure array items are ints
    2092  * @uses apply_filters() Calls 'bbp_forum_query_topic_ids' with the topic ids
    2093  *                        and forum id
    20941881 */
    20951882function bbp_get_private_forum_ids() {
     
    21391926 *
    21401927 * @param string Optional. The type of value to return. (string|array|meta_query)
    2141  *
    2142  * @uses bbp_is_user_keymaster()
    2143  * @uses bbp_get_hidden_forum_ids()
    2144  * @uses bbp_get_private_forum_ids()
    2145  * @uses apply_filters()
    21461928 */
    21471929function bbp_exclude_forum_ids( $type = 'string' ) {
     
    22031985 * @param WP_Query $posts_query
    22041986 *
    2205  * @uses apply_filters()
    2206  * @uses bbp_exclude_forum_ids()
    2207  * @uses bbp_get_topic_post_type()
    2208  * @uses bbp_get_reply_post_type()
    22091987 * @return WP_Query
    22101988 */
     
    22332011
    22342012        /** Default ***********************************************************/
    2235 global $jjj;
     2013
    22362014        // Add all supported forum visibilities
    22372015        $posts_query->set( 'post_status', array_keys( bbp_get_forum_visibilities() ) );
     
    22452023        }
    22462024
    2247 if ( true === $jjj ) {
    2248     var_dump( bbp_get_private_forum_ids() ); die;
    2249 }
    22502025        // Get any existing meta queries
    22512026        $not_in = $posts_query->get( 'post__not_in', array() );
     
    22872062 *
    22882063 * @param int $forum_id Forum id
    2289  * @uses bbp_get_topic_post_type() To get the topic post type
    2290  * @uses bbp_get_public_child_ids() To get the topic ids
    2291  * @uses apply_filters() Calls 'bbp_forum_query_topic_ids' with the topic ids
    2292  *                        and forum id
    22932064 */
    22942065function bbp_forum_query_topic_ids( $forum_id ) {
     
    23072078 *
    23082079 * @param int $forum_id Forum id
    2309  * @uses bbp_get_forum_post_type() To get the forum post type
    2310  * @uses bbp_get_all_child_ids() To get the forum ids
    2311  * @uses apply_filters() Calls 'bbp_forum_query_subforum_ids' with the subforum
    2312  *                        ids and forum id
    23132080 */
    23142081function bbp_forum_query_subforum_ids( $forum_id ) {
     
    23272094 * @param int $forum_id Forum id.
    23282095 * @param int $topic_ids Optional. Topic ids.
    2329  * @uses bbp_get_forum_id() To validate the forum id
    2330  * @uses bbp_forum_query_topic_ids() To get the forum's topic ids
    2331  * @uses bbp_get_public_status_id() To get the public status id
    2332  * @uses bbp_get_reply_post_type() To get the reply post type
    2333  * @uses apply_filters() Calls 'bbp_forum_query_last_reply_id' with the reply id
    2334  *                        and forum id
    23352096 */
    23362097function bbp_forum_query_last_reply_id( $forum_id = 0, $topic_ids = 0 ) {
     
    23752136 *
    23762137 * @since 2.0.0 bbPress (r2996)
    2377  *
    2378  * @uses current_user_can() To check if the current user can read private forums
    2379  * @uses is_singular() To check if it's a singular page
    2380  * @uses bbp_is_user_keymaster() To check if user is a keymaster
    2381  * @uses bbp_get_forum_post_type() To get the forum post type
    2382  * @uses bbp_get_topic_post_type() To get the topic post type
    2383  * @uses bbp_get_reply_post_type() TO get the reply post type
    2384  * @uses bbp_get_topic_forum_id() To get the topic forum id
    2385  * @uses bbp_get_reply_forum_id() To get the reply forum id
    2386  * @uses bbp_is_forum_hidden() To check if the forum is hidden or not
    2387  * @uses bbp_set_404() To set a 404 status
    23882138 */
    23892139function bbp_forum_enforce_hidden() {
     
    24162166            $forum_id = bbp_get_reply_forum_id( $wp_query->post->ID );
    24172167            break;
    2418 
    24192168    }
    24202169
     
    24302179 *
    24312180 * @since 2.0.0 bbPress (r2996)
    2432  *
    2433  * @uses current_user_can() To check if the current user can read private forums
    2434  * @uses is_singular() To check if it's a singular page
    2435  * @uses bbp_is_user_keymaster() To check if user is a keymaster
    2436  * @uses bbp_get_forum_post_type() To get the forum post type
    2437  * @uses bbp_get_topic_post_type() To get the topic post type
    2438  * @uses bbp_get_reply_post_type() TO get the reply post type
    2439  * @uses bbp_get_topic_forum_id() To get the topic forum id
    2440  * @uses bbp_get_reply_forum_id() To get the reply forum id
    2441  * @uses bbp_is_forum_private() To check if the forum is private or not
    2442  * @uses bbp_set_404() To set a 404 status
    24432181 */
    24442182function bbp_forum_enforce_private() {
     
    24862224 *
    24872225 * @since 2.1.0 bbPress (r3607)
    2488  *
    2489  * @uses bbp_is_forum_edit()
    2490  * @uses current_user_can()
    2491  * @uses bbp_get_forum_id()
    2492  * @uses bbp_redirect()
    2493  * @uses bbp_get_forum_permalink()
    24942226 */
    24952227function bbp_check_forum_edit() {
     
    25122244 *
    25132245 * @param int $forum_id
    2514  * @uses bbp_get_forum_id() To validate the forum ID
    2515  * @uses bbp_is_forum() To make sure it's a forum
    2516  * @uses bbp_get_topic_post_type() To get the topic post type
    2517  * @uses bbp_topics() To make sure there are topics to loop through
    2518  * @uses wp_trash_post() To trash the post
    2519  * @uses update_post_meta() To update the forum meta of trashed topics
    25202246 * @return If forum is not valid
    25212247 */
     
    25622288 *
    25632289 * @param int $forum_id
    2564  * @uses bbp_get_forum_id() To validate the forum ID
    2565  * @uses bbp_is_forum() To make sure it's a forum
    2566  * @uses bbp_get_public_status_id() To return public post status
    2567  * @uses bbp_get_closed_status_id() To return closed post status
    2568  * @uses bbp_get_pending_status_id() To return pending post status
    2569  * @uses bbp_get_topic_post_type() To get the topic post type
    2570  * @uses wp_trash_post() To trash the post
    2571  * @uses update_post_meta() To update the forum meta of trashed topics
    25722290 * @return If forum is not valid
    25732291 */
     
    26312349 *
    26322350 * @param int $forum_id
    2633  * @uses bbp_get_forum_id() To validate the forum ID
    2634  * @uses bbp_is_forum() To make sure it's a forum
    2635  * @uses get_post_meta() To update the forum meta of trashed topics
    2636  * @uses wp_untrash_post() To trash the post
    26372351 * @return If forum is not valid
    26382352 */
     
    26742388 *
    26752389 * @since 2.1.0 bbPress (r3668)
    2676  *
    2677  * @uses bbp_get_forum_id() To get the forum id
    2678  * @uses bbp_is_forum() To check if the passed id is a forum
    2679  * @uses do_action() Calls 'bbp_delete_forum' with the forum id
    26802390 */
    26812391function bbp_delete_forum( $forum_id = 0 ) {
     
    26972407 *
    26982408 * @since 2.1.0 bbPress (r3668)
    2699  *
    2700  * @uses bbp_get_forum_id() To get the forum id
    2701  * @uses bbp_is_forum() To check if the passed id is a forum
    2702  * @uses do_action() Calls 'bbp_trash_forum' with the forum id
    27032409 */
    27042410function bbp_trash_forum( $forum_id = 0 ) {
     
    27162422 *
    27172423 * @since 2.1.0 bbPress (r3668)
    2718  *
    2719  * @uses bbp_get_forum_id() To get the forum id
    2720  * @uses bbp_is_forum() To check if the passed id is a forum
    2721  * @uses do_action() Calls 'bbp_untrash_forum' with the forum id
    27222424 */
    27232425function bbp_untrash_forum( $forum_id = 0 ) {
     
    27412443 * @since 2.1.0 bbPress (r3668)
    27422444 * @since 2.6.0 bbPress (r6526) Not recommend for usage
    2743  *
    2744  * @uses bbp_get_forum_id() To get the forum id
    2745  * @uses bbp_is_forum() To check if the passed id is a forum
    2746  * @uses do_action() Calls 'bbp_deleted_forum' with the forum id
    27472445 */
    27482446function bbp_deleted_forum( $forum_id = 0 ) {
     
    27602458 *
    27612459 * @since 2.1.0 bbPress (r3668)
    2762  *
    2763  * @uses bbp_get_forum_id() To get the forum id
    2764  * @uses bbp_is_forum() To check if the passed id is a forum
    2765  * @uses do_action() Calls 'bbp_trashed_forum' with the forum id
    27662460 */
    27672461function bbp_trashed_forum( $forum_id = 0 ) {
     
    27792473 *
    27802474 * @since 2.1.0 bbPress (r3668)
    2781  *
    2782  * @uses bbp_get_forum_id() To get the forum id
    2783  * @uses bbp_is_forum() To check if the passed id is a forum
    2784  * @uses do_action() Calls 'bbp_untrashed_forum' with the forum id
    27852475 */
    27862476function bbp_untrashed_forum( $forum_id = 0 ) {
Note: See TracChangeset for help on using the changeset viewer.