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/template.php

    r6551 r6573  
    1717 *
    1818 * @since 2.0.0 bbPress (r2857)
    19  *
    20  * @uses bbp_get_forum_post_type() To get the forum post type
    2119 */
    2220function bbp_forum_post_type() {
    … …  
    2826     * @since 2.0.0 bbPress (r2857)
    2927     *
    30      * @uses apply_filters() Calls 'bbp_get_forum_post_type' with the forum
    31      *                        post type id
    3228     * @return string The unique forum post type id
    3329     */
    … …  
    115111 *
    116112 * @param array $args All the arguments supported by {@link WP_Query}
    117  * @uses WP_Query To make query and get the forums
    118  * @uses bbp_get_forum_post_type() To get the forum post type id
    119  * @uses bbp_get_forum_id() To get the forum id
    120  * @uses get_option() To get the forums per page option
    121  * @uses current_user_can() To check if the current user is capable of editing
    122  *                           others' forums
    123  * @uses apply_filters() Calls 'bbp_has_forums' with
    124  *                        bbPress::forum_query::have_posts()
    125  *                        and bbPress::forum_query
     113 *
    126114 * @return object Multidimensional array of forum information
    127115 */
    … …  
    166154 * @since 2.0.0 bbPress (r2464)
    167155 *
    168  * @uses bbPress:forum_query::have_posts() To check if there are more forums
    169  *                                          available
    170156 * @return object Forum information
    171157 */
    … …  
    188174 * @since 2.0.0 bbPress (r2464)
    189175 *
    190  * @uses bbPress:forum_query::the_post() To get the current forum
    191176 * @return object Forum information
    192177 */
    … …  
    203188 *
    204189 * @param $forum_id Optional. Used to check emptiness
    205  * @uses bbp_get_forum_id() To get the forum id
    206190 */
    207191function bbp_forum_id( $forum_id = 0 ) {
    … …  
    214198     *
    215199     * @param $forum_id Optional. Used to check emptiness
    216      * @uses bbPress::forum_query::in_the_loop To check if we're in the loop
    217      * @uses bbPress::forum_query::post::ID To get the forum id
    218      * @uses WP_Query::post::ID To get the forum id
    219      * @uses bbp_is_forum() To check if the search result is a forum
    220      * @uses bbp_is_single_forum() To check if it's a forum page
    221      * @uses bbp_is_single_topic() To check if it's a topic page
    222      * @uses bbp_get_topic_forum_id() To get the topic forum id
    223      * @uses get_post_field() To get the post's post type
    224      * @uses apply_filters() Calls 'bbp_get_forum_id' with the forum id and
    225      *                        supplied forum id
    226200     * @return int The forum id
    227201     */
    … …  
    272246 * @param string $output Optional. OBJECT, ARRAY_A, or ARRAY_N. Default = OBJECT
    273247 * @param string $filter Optional Sanitation filter. See {@link sanitize_post()}
    274  * @uses get_post() To get the forum
    275  * @uses apply_filters() Calls 'bbp_get_forum' with the forum, output type and
    276  *                        sanitation filter
     248 *
    277249 * @return mixed Null if error or forum (in specified form) if success
    278250 */
    … …  
    321293 * @param string $redirect_to Optional. Pass a redirect value for use with
    322294 *                              shortcodes and other fun things.
    323  * @uses bbp_get_forum_permalink() To get the permalink
    324295 */
    325296function bbp_forum_permalink( $forum_id = 0, $redirect_to = '' ) {
    … …  
    334305     * @param string $redirect_to Optional. Pass a redirect value for use with
    335306     *                              shortcodes and other fun things.
    336      * @uses bbp_get_forum_id() To get the forum id
    337      * @uses get_permalink() Get the permalink of the forum
    338      * @uses apply_filters() Calls 'bbp_get_forum_permalink' with the forum
    339      *                        link
     307     *
    340308     * @return string Permanent link to forum
    341309     */
    … …  
    362330 *
    363331 * @param int $forum_id Optional. Forum id
    364  * @uses bbp_get_forum_title() To get the forum title
    365332 */
    366333function bbp_forum_title( $forum_id = 0 ) {
    … …  
    373340     *
    374341     * @param int $forum_id Optional. Forum id
    375      * @uses bbp_get_forum_id() To get the forum id
    376      * @uses get_the_title() To get the forum title
    377      * @uses apply_filters() Calls 'bbp_get_forum_title' with the title
    378342     * @return string Title of forum
    379343     */
    … …  
    402366     *
    403367     * @param string $title Default text to use as title
    404      *
    405      * @uses bbp_get_page_by_path() Check if page exists at root path
    406      * @uses get_the_title() Use the page title at the root path
    407      * @uses get_post_type_object() Load the post type object
    408      * @uses bbp_get_forum_post_type() Get the forum post type ID
    409      * @uses get_post_type_labels() Get labels for forum post type
    410      * @uses apply_filters() Allow output to be manipulated
    411368     *
    412369     * @return string The forum archive title
    … …  
    439396 *
    440397 * @param int $forum_id Optional. Topic id
    441  * @uses bbp_get_forum_content() To get the forum content
    442398 */
    443399function bbp_forum_content( $forum_id = 0 ) {
    … …  
    450406     *
    451407     * @param int $forum_id Optional. Topic id
    452      * @uses bbp_get_forum_id() To get the forum id
    453      * @uses post_password_required() To check if the forum requires pass
    454      * @uses get_the_password_form() To get the password form
    455      * @uses get_post_field() To get the content post field
    456      * @uses apply_filters() Calls 'bbp_get_forum_content' with the content
    457      *                        and forum id
     408     *
    458409     * @return string Content of the forum
    459410     */
    … …  
    477428 * @since 2.1.0 bbPress (r3653)
    478429 *
    479  * @uses do_action()
    480430 * @todo Links and filter
    481431 */
    … …  
    489439 * @since 2.0.0 bbPress (r2860)
    490440 *
    491  * @uses bbp_get_forum_last_active_id() To get the forum's last active id
    492441 * @param int $forum_id Optional. Forum id
    493442 */
    … …  
    501450     *
    502451     * @param int $forum_id Optional. Forum id
    503      * @uses bbp_get_forum_id() To get the forum id
    504      * @uses get_post_meta() To get the forum's last active id
    505      * @uses apply_filters() Calls 'bbp_get_forum_last_active_id' with
    506452     *                        the last active id and forum id
    507453     * @return int Forum's last active id
    … …  
    520466 * @since 2.0.0 bbPress (r2464)
    521467 *
    522  * @uses bbp_get_forum_last_active_time() To get the forum freshness
    523468 * @param int $forum_id Optional. Forum id
    524469 */
    … …  
    532477     *
    533478     * @param int $forum_id Optional. Forum id
    534      * @uses bbp_get_forum_id() To get the forum id
    535      * @uses get_post_meta() To retrieve forum last active meta
    536      * @uses bbp_get_forum_last_reply_id() To get forum's last reply id
    537      * @uses get_post_field() To get the post date of the reply
    538      * @uses bbp_get_forum_last_topic_id() To get forum's last topic id
    539      * @uses bbp_get_topic_last_active_time() To get time when the topic was
    540      *                                    last active
    541      * @uses bbp_convert_date() To convert the date
    542      * @uses bbp_get_time_since() To get time in since format
    543      * @uses apply_filters() Calls 'bbp_get_forum_last_active' with last
    544      *                        active time and forum id
    545479     * @return string Forum last update date/time (freshness)
    546480     */
    … …  
    577511 *
    578512 * @param int $forum_id Optional. Forum id
    579  * @uses bbp_get_forum_freshness_link() To get the forum freshness link
    580513 */
    581514function bbp_forum_freshness_link( $forum_id = 0) {
    … …  
    590523     *
    591524     * @param int $forum_id Optional. Forum id
    592      * @uses bbp_get_forum_id() To get the forum id
    593      * @uses bbp_get_forum_last_active_id() To get the forum last active id
    594      * @uses bbp_get_forum_last_reply_id() To get the forum last reply id
    595      * @uses bbp_get_forum_last_topic_id() To get the forum last topic id
    596      * @uses bbp_get_forum_last_reply_url() To get the forum last reply url
    597      * @uses bbp_get_forum_last_reply_title() To get the forum last reply
    598      *                                         title
    599      * @uses bbp_get_forum_last_topic_permalink() To get the forum last
    600      *                                             topic permalink
    601      * @uses bbp_get_forum_last_topic_title() To get the forum last topic
    602      *                                         title
    603      * @uses bbp_get_forum_last_active_time() To get the time when the forum
    604      *                                         was last active
    605      * @uses apply_filters() Calls 'bbp_get_forum_freshness_link' with the
    606      *                        link and forum id
    607525     */
    608526    function bbp_get_forum_freshness_link( $forum_id = 0 ) {
    … …  
    645563 *
    646564 * @param int $forum_id Forum ID
    647  * @uses bbp_get_forum_parent_id() To get the forum's parent ID
    648565 */
    649566function bbp_forum_parent_id( $forum_id = 0 ) {
    … …  
    656573     *
    657574     * @param int $forum_id Optional. Forum id
    658      * @uses bbp_get_forum_id() To get the forum id
    659      * @uses get_post_field() To get the forum parent
    660      * @uses apply_filters() Calls 'bbp_get_forum_parent' with the parent & forum id
    661575     * @return int Forum parent
    662576     */
    … …  
    685599 *
    686600 * @param int $forum_id Optional. Forum id
    687  * @uses bbp_get_forum_id() To get the forum id
    688  * @uses bbp_get_forum() To get the forum
    689  * @uses apply_filters() Calls 'bbp_get_forum_ancestors' with the ancestors
    690  *                        and forum id
    691601 * @return array Forum ancestors
    692602 */
    … …  
    713623 *
    714624 * @param array $args All the arguments supported by {@link WP_Query}
    715  * @uses bbp_get_forum_id() To get the forum id
    716  * @uses current_user_can() To check if the current user is capable of
    717  *                           reading private forums
    718  * @uses get_posts() To get the subforums
    719  * @uses apply_filters() Calls 'bbp_forum_get_subforums' with the subforums
    720  *                        and the args
    721625 * @return mixed false if none, array of subs if yes
    722626 */
    … …  
    790694 *  - show_topic_count - To show forum topic count or not. Defaults to true
    791695 *  - show_reply_count - To show forum reply count or not. Defaults to true
    792  * @uses bbp_forum_get_subforums() To check if the forum has subforums or not
    793  * @uses bbp_get_forum_permalink() To get forum permalink
    794  * @uses bbp_get_forum_title() To get forum title
    795  * @uses bbp_is_forum_category() To check if a forum is a category
    796  * @uses bbp_get_forum_topic_count() To get forum topic count
    797  * @uses bbp_get_forum_reply_count() To get forum reply count
    798696 */
    799697function bbp_list_forums( $args = array() ) {
    … …  
    877775 * @since 2.5.0 bbPress (r5156)
    878776 * @since 2.6.0 bbPress (r6308) Add 'redirect_to' support
    879  *
    880  * @uses bbp_get_forum_subscription_link()
    881777 */
    882778function bbp_forum_subscription_link( $args = array() ) {
    … …  
    891787     * @since 2.5.0 bbPress (r5156)
    892788     * @since 2.6.0 bbPress (r6308) Add 'redirect_to' support
    893      *
    894      * @uses bbp_parse_args()
    895      * @uses bbp_get_user_subscribe_link()
    896      * @uses apply_filters() Calls 'bbp_get_forum_subscribe_link'
    897789     */
    898790    function bbp_get_forum_subscription_link( $args = array() ) {
    … …  
    933825 * @since 2.0.0 bbPress (r2464)
    934826 *
    935  * @uses bbp_get_forum_last_topic_id() To get the forum's last topic id
    936827 * @param int $forum_id Optional. Forum id
    937828 */
    … …  
    945836     *
    946837     * @param int $forum_id Optional. Forum id
    947      * @uses bbp_get_forum_id() To get the forum id
    948      * @uses get_post_meta() To get the forum's last topic id
    949      * @uses apply_filters() Calls 'bbp_get_forum_last_topic_id' with the
    950      *                        forum and topic id
    951838     * @return int Forum's last topic id
    952839     */
    … …  
    965852 *
    966853 * @param int $forum_id Optional. Forum id
    967  * @uses bbp_get_forum_last_topic_title() To get the forum's last topic's title
    968854 */
    969855function bbp_forum_last_topic_title( $forum_id = 0 ) {
    … …  
    976862     *
    977863     * @param int $forum_id Optional. Forum id
    978      * @uses bbp_get_forum_id() To get the forum id
    979      * @uses bbp_get_forum_last_topic_id() To get the forum's last topic id
    980      * @uses bbp_get_topic_title() To get the topic's title
    981      * @uses apply_filters() Calls 'bbp_get_forum_last_topic_title' with the
    982      *                        topic title and forum id
    983864     * @return string Forum's last topic's title
    984865     */
    … …  
    998879 *
    999880 * @param int $forum_id Optional. Forum id
    1000  * @uses bbp_get_forum_last_topic_permalink() To get the forum's last topic's
    1001  *                                             permanent link
    1002881 */
    1003882function bbp_forum_last_topic_permalink( $forum_id = 0 ) {
    … …  
    1010889     *
    1011890     * @param int $forum_id Optional. Forum id
    1012      * @uses bbp_get_forum_id() To get the forum id
    1013      * @uses bbp_get_forum_last_topic_id() To get the forum's last topic id
    1014      * @uses bbp_get_topic_permalink() To get the topic's permalink
    1015      * @uses apply_filters() Calls 'bbp_get_forum_last_topic_permalink' with
    1016      *                        the topic link and forum id
    1017891     * @return string Permanent link to topic
    1018892     */
    … …  
    1032906 *
    1033907 * @param int $forum_id Optional. Forum id
    1034  * @uses bbp_get_forum_id() To get the forum id
    1035  * @uses bbp_get_forum_last_topic_id() To get the forum's last topic id
    1036  * @uses bbp_get_topic_author_id() To get the topic's author id
    1037  * @uses apply_filters() Calls 'bbp_get_forum_last_topic_author' with the author
    1038  *                        id and forum id
    1039908 * @return int Forum's last topic's author id
    1040909 */
    … …  
    1054923 *
    1055924 * @param int $forum_id Optional. Forum id
    1056  * @uses bbp_get_forum_last_topic_author_link() To get the forum's last topic's
    1057  *                                               author link
    1058925 */
    1059926function bbp_forum_last_topic_author_link( $forum_id = 0 ) {
    … …  
    1066933     *
    1067934     * @param int $forum_id Optional. Forum id
    1068      * @uses bbp_get_forum_id() To get the forum id
    1069      * @uses bbp_get_forum_last_topic_author_id() To get the forum's last
    1070      *                                             topic's author id
    1071      * @uses bbp_get_user_profile_link() To get the author's profile link
    1072      * @uses apply_filters() Calls 'bbp_get_forum_last_topic_author_link'
    1073      *                        with the author link and forum id
    1074935     * @return string Forum's last topic's author link
    1075936     */
    … …  
    1090951 * @since 2.0.0 bbPress (r2464)
    1091952 *
    1092  * @uses bbp_get_forum_last_reply_id() To get the forum's last reply id
    1093953 * @param int $forum_id Optional. Forum id
    1094954 */
    … …  
    1102962     *
    1103963     * @param int $forum_id Optional. Forum id
    1104      * @uses bbp_get_forum_id() To get the forum id
    1105      * @uses get_post_meta() To get the forum's last reply id
    1106      * @uses bbp_get_forum_last_topic_id() To get the forum's last topic id
    1107      * @uses apply_filters() Calls 'bbp_get_forum_last_reply_id' with
    1108      *                        the last reply id and forum id
    1109964     * @return int Forum's last reply id
    1110965     */
    … …  
    1121976 *
    1122977 * @param int $forum_id Optional. Forum id
    1123  * @uses bbp_get_forum_last_reply_title() To get the forum's last reply's title
    1124978 */
    1125979function bbp_forum_last_reply_title( $forum_id = 0 ) {
    … …  
    1130984     *
    1131985     * @param int $forum_id Optional. Forum id
    1132      * @uses bbp_get_forum_id() To get the forum id
    1133      * @uses bbp_get_forum_last_reply_id() To get the forum's last reply id
    1134      * @uses bbp_get_reply_title() To get the reply title
    1135      * @uses apply_filters() Calls 'bbp_get_forum_last_reply_title' with the
    1136      *                        reply title and forum id
    1137986     * @return string
    1138987     */
    … …  
    11521001 *
    11531002 * @param int $forum_id Optional. Forum id
    1154  * @uses bbp_get_forum_last_reply_permalink() To get the forum last reply link
    11551003 */
    11561004function bbp_forum_last_reply_permalink( $forum_id = 0 ) {
    … …  
    11631011     *
    11641012     * @param int $forum_id Optional. Forum id
    1165      * @uses bbp_get_forum_id() To get the forum id
    1166      * @uses bbp_get_forum_last_reply_id() To get the forum's last reply id
    1167      * @uses bbp_get_reply_permalink() To get the reply permalink
    1168      * @uses apply_filters() Calls 'bbp_get_forum_last_reply_permalink' with
    1169      *                        the reply link and forum id
     1013     *
    11701014     * @return string Permanent link to the forum's last reply
    11711015     */
    … …  
    11851029 *
    11861030 * @param int $forum_id Optional. Forum id
    1187  * @uses bbp_get_forum_last_reply_url() To get the forum last reply url
    11881031 */
    11891032function bbp_forum_last_reply_url( $forum_id = 0 ) {
    … …  
    11961039     *
    11971040     * @param int $forum_id Optional. Forum id
    1198      * @uses bbp_get_forum_id() To get the forum id
    1199      * @uses bbp_get_forum_last_reply_id() To get the forum's last reply id
    1200      * @uses bbp_get_reply_url() To get the reply url
    1201      * @uses bbp_get_forum_last_topic_permalink() To get the forum's last
    1202      *                                             topic's permalink
    1203      * @uses apply_filters() Calls 'bbp_get_forum_last_reply_url' with the
    1204      *                        reply url and forum id
    12051041     * @return string Paginated URL to latest reply
    12061042     */
    … …  
    12331069 *
    12341070 * @param int $forum_id Optional. Forum id
    1235  * @uses bbp_get_forum_last_reply_author_id() To get the forum's last reply
    1236  *                                             author id
    12371071 */
    12381072function bbp_forum_last_reply_author_id( $forum_id = 0 ) {
    … …  
    12451079     *
    12461080     * @param int $forum_id Optional. Forum id
    1247      * @uses bbp_get_forum_id() To get the forum id
    1248      * @uses bbp_get_forum_last_reply_author_id() To get the forum's last
    1249      *                                             reply's author id
    1250      * @uses bbp_get_reply_author_id() To get the reply's author id
    1251      * @uses apply_filters() Calls 'bbp_get_forum_last_reply_author_id' with
    1252      *                        the author id and forum id
    12531081     * @return int Forum's last reply author id
    12541082     */
    … …  
    12681096 *
    12691097 * @param int $forum_id Optional. Forum id
    1270  * @uses bbp_get_forum_last_reply_author_link() To get the forum's last reply's
    1271  *                                               author link
    12721098 */
    12731099function bbp_forum_last_reply_author_link( $forum_id = 0 ) {
    … …  
    12801106     *
    12811107     * @param int $forum_id Optional. Forum id
    1282      * @uses bbp_get_forum_id() To get the forum id
    1283      * @uses bbp_get_forum_last_reply_author_id() To get the forum's last
    1284      *                                             reply's author id
    1285      * @uses bbp_get_user_profile_link() To get the reply's author's profile
    1286      *                                    link
    1287      * @uses apply_filters() Calls 'bbp_get_forum_last_reply_author_link'
    1288      *                        with the author link and forum id
    12891108     * @return string Link to author of last reply of forum
    12901109     */
    … …  
    13061125 *
    13071126 * @param int $forum_id Optional. Topic id
    1308  * @uses bbp_get_forum_topics_link() To get the forum topics link
    13091127 */
    13101128function bbp_forum_topics_link( $forum_id = 0 ) {
    … …  
    13181136     *
    13191137     * @param int $forum_id Optional. Topic id
    1320      * @uses bbp_get_forum_id() To get the forum id
    1321      * @uses bbp_get_forum_permalink() To get the forum permalink
    1322      * @uses bbp_get_forum_topic_count() To get the forum topic count
    1323      * @uses bbp_get_forum_topic_count_hidden() To get the forum hidden
    1324      *                                           topic count
    1325      * @uses current_user_can() To check if the current user can edit others
    1326      *                           topics
    1327      * @uses apply_filters() Calls 'bbp_get_forum_topics_link' with the
    1328      *                        topics link and forum id
    13291138     */
    13301139    function bbp_get_forum_topics_link( $forum_id = 0 ) {
    … …  
    13651174 * @param int $forum_id Optional. Forum id to check
    13661175 * @param boolean $integer Optional. Whether or not to format the result
    1367  * @uses bbp_get_forum_subforum_count() To get the forum's subforum count
    13681176 */
    13691177function bbp_forum_subforum_count( $forum_id = 0, $integer = false ) {
    … …  
    13771185     * @param int $forum_id Optional. Forum id
    13781186     * @param boolean $integer Optional. Whether or not to format the result
    1379      * @uses bbp_get_forum_id() To get the forum id
    1380      * @uses get_post_meta() To get the subforum count
    1381      * @uses apply_filters() Calls 'bbp_get_forum_subforum_count' with the
    1382      *                        subforum count and forum id
    13831187     * @return int Forum's subforum count
    13841188     */
    … …  
    14011205 * @param bool $total_count Optional. To get the total count or normal count?
    14021206 * @param boolean $integer Optional. Whether or not to format the result
    1403  * @uses bbp_get_forum_topic_count() To get the forum topic count
    14041207 */
    14051208function bbp_forum_topic_count( $forum_id = 0, $total_count = true, $integer = false ) {
    … …  
    14151218     *                           count? Defaults to total.
    14161219     * @param boolean $integer Optional. Whether or not to format the result
    1417      * @uses bbp_get_forum_id() To get the forum id
    1418      * @uses get_post_meta() To get the forum topic count
    1419      * @uses apply_filters() Calls 'bbp_get_forum_topic_count' with the
    1420      *                        topic count and forum id
    14211220     * @return int Forum topic count
    14221221     */
    … …  
    14401239 * @param bool $total_count Optional. To get the total count or normal count?
    14411240 * @param boolean $integer Optional. Whether or not to format the result
    1442  * @uses bbp_get_forum_reply_count() To get the forum reply count
    14431241 */
    14441242function bbp_forum_reply_count( $forum_id = 0, $total_count = true, $integer = false ) {
    … …  
    14541252     *                           count?
    14551253     * @param boolean $integer Optional. Whether or not to format the result
    1456      * @uses bbp_get_forum_id() To get the forum id
    1457      * @uses get_post_meta() To get the forum reply count
    1458      * @uses apply_filters() Calls 'bbp_get_forum_reply_count' with the
    1459      *                        reply count and forum id
    14601254     * @return int Forum reply count
    14611255     */
    … …  
    14791273 * @param bool $total_count Optional. To get the total count or normal count?
    14801274 * @param boolean $integer Optional. Whether or not to format the result
    1481  * @uses bbp_get_forum_post_count() To get the forum post count
    14821275 */
    14831276function bbp_forum_post_count( $forum_id = 0, $total_count = true, $integer = false ) {
    … …  
    14931286     *                           count?
    14941287     * @param boolean $integer Optional. Whether or not to format the result
    1495      * @uses bbp_get_forum_id() To get the forum id
    1496      * @uses bbp_get_forum_topic_count() To get the topic count
    1497      * @uses bbp_get_forum_reply_count() To get the reply count
    1498      * @uses apply_filters() Calls 'bbp_get_forum_post_count' with the
    1499      *                        post count and forum id
    15001288     * @return int Forum post count
    15011289     */
    … …  
    15201308 * @param int $forum_id Optional. Topic id
    15211309 * @param boolean $integer Optional. Whether or not to format the result
    1522  * @uses bbp_get_forum_topic_count_hidden() To get the forum hidden topic count
    15231310 */
    15241311function bbp_forum_topic_count_hidden( $forum_id = 0, $integer = false ) {
    … …  
    15331320     * @param int $forum_id Optional. Topic id
    15341321     * @param boolean $integer Optional. Whether or not to format the result
    1535      * @uses bbp_get_forum_id() To get the forum id
    1536      * @uses get_post_meta() To get the hidden topic count
    1537      * @uses apply_filters() Calls 'bbp_get_forum_topic_count_hidden' with
    1538      *                        the hidden topic count and forum id
    15391322     * @return int Topic hidden topic count
    15401323     */
    … …  
    15551338 *
    15561339 * @param int $forum_id Optional. Forum id
    1557  * @uses bbp_get_forum_status() To get the forum status
    15581340 */
    15591341function bbp_forum_status( $forum_id = 0 ) {
    … …  
    15661348     *
    15671349     * @param int $forum_id Optional. Forum id
    1568      * @uses bbp_get_forum_id() To get the forum id
    1569      * @uses get_post_status() To get the forum's status
    1570      * @uses apply_filters() Calls 'bbp_get_forum_status' with the status
    1571      *                        and forum id
    15721350     * @return string Status of forum
    15731351     */
    … …  
    15901368 *
    15911369 * @param int $forum_id Optional. Forum id
    1592  * @uses bbp_get_forum_visibility() To get the forum visibility
    15931370 */
    15941371function bbp_forum_visibility( $forum_id = 0 ) {
    … …  
    16011378     *
    16021379     * @param int $forum_id Optional. Forum id
    1603      * @uses bbp_get_forum_id() To get the forum id
    1604      * @uses get_post_status() To get the forum's status
    1605      * @uses apply_filters() Calls 'bbp_get_forum_visibility' with the visibility
    1606      *                        and forum id
    16071380     * @return string Status of forum
    16081381     */
    … …  
    16211394 *
    16221395 * @param int $forum_id Optional. Forum id
    1623  * @uses bbp_get_forum_type() To get the forum type
    16241396 */
    16251397function bbp_forum_type( $forum_id = 0 ) {
    … …  
    16321404     *
    16331405     * @param int $forum_id Optional. Forum id
    1634      * @uses get_post_meta() To get the forum category meta
    16351406     * @return bool Whether the forum is a category or not
    16361407     */
    … …  
    16531424 *
    16541425 * @param int $forum_id Optional. Forum id
    1655  * @uses bbp_get_forum_type() To get the forum type
    16561426 * @return bool Whether the forum is a category or not
    16571427 */
    … …  
    16731443 * @param bool $check_ancestors Check if the ancestors are open (only
    16741444 *                               if they're a category)
    1675  * @uses bbp_is_forum_closed() To check if the forum is closed
    16761445 * @return bool Whether the forum is open or not
    16771446 */
    … …  
    16881457 * @param bool $check_ancestors Check if the ancestors are closed (only
    16891458 *                               if they're a category)
    1690  * @uses bbp_get_forum_id() To get the forum ID
    1691  * @uses bbp_is_forum_status() To check the forum status
    16921459 * @return bool True if closed, false if not
    16931460 */
    … …  
    17141481 *      'OR' means only one forum from the tree needs to match;
    17151482 *      'AND' means all forums must match. The default is 'AND'.
    1716  * @uses bbp_get_forum_id() To get the forum ID
    1717  * @uses bbp_get_forum_status() To get the forum status
    1718  * @uses bbp_get_forum_ancestors() To get the forum ancestors
    1719  * @uses bbp_is_forum_category() To check the forum type
    17201483 * @return bool True if match, false if not
    17211484 */
    … …  
    17851548 * @param int $forum_id Optional. Forum id
    17861549 * @param bool $check_ancestors Check if the ancestors are public
    1787  * @uses bbp_get_forum_id() To get the forum ID
    1788  * @uses bbp_is_forum_visibility() To check the forum visibility ID
    17891550 * @return bool True if closed, false if not
    17901551 */
    … …  
    18081569 * @param int $forum_id Optional. Forum id
    18091570 * @param bool $check_ancestors Check if the ancestors are private
    1810  * @uses bbp_get_forum_id() To get the forum ID
    1811  * @uses bbp_is_forum_visibility() To check the forum visibility ID
    18121571 * @return bool True if private, false if not
    18131572 */
    … …  
    18321591 * @param bool $check_ancestors Check if the ancestors are private (only if
    18331592 *                               they're a category)
    1834  * @uses bbp_get_forum_id() To get the forum ID
    1835  * @uses bbp_is_forum_visibility() To check the forum visibility ID
    18361593 * @return bool True if hidden, false if not
    18371594 */
    … …  
    18591616 *      'OR' means only one forum from the tree needs to match;
    18601617 *      'AND' means all forums must match. The default is 'AND'.
    1861  * @uses bbp_get_forum_id() To get the forum ID
    1862  * @uses bbp_get_forum_visibility() To get the forum visibility
    1863  * @uses bbp_get_forum_ancestors() To get the forum ancestors
    1864  * @uses bbp_is_forum() To check the post type
    18651618 * @return bool True if match, false if not
    18661619 */
    … …  
    19311684 *
    19321685 * @param int $forum_id Optional. Forum id
    1933  * @uses bbp_get_forum_author_id() To get the forum author id
    19341686 */
    19351687function bbp_forum_author_id( $forum_id = 0 ) {
    … …  
    19421694     *
    19431695     * @param int $forum_id Optional. Forum id
    1944      * @uses bbp_get_forum_id() To get the forum id
    1945      * @uses get_post_field() To get the forum author id
    1946      * @uses apply_filters() Calls 'bbp_get_forum_author_id' with the author
    19471696     *                        id and forum id
    19481697     * @return string Author of forum
    … …  
    19621711 *
    19631712 * @param int $forum_id Optional. Forum id
    1964  * @uses bbp_get_forum_author() To get the forum author
    19651713 */
    19661714function bbp_forum_author_display_name( $forum_id = 0 ) {
    … …  
    19731721     *
    19741722     * @param int $forum_id Optional. Forum id
    1975      * @uses bbp_get_forum_id() To get the forum id
    1976      * @uses bbp_get_forum_author_id() To get the forum author id
    1977      * @uses get_the_author_meta() To get the display name of the author
    1978      * @uses apply_filters() Calls 'bbp_get_forum_author' with the author
    1979      *                        and forum id
    19801723     * @return string Author of forum
    19811724     */
    … …  
    19971740 * @param int $forum_id
    19981741 *
    1999  * @uses bbp_is_forum_private()
    2000  * @uses current_user_can()
    2001  *
    20021742 * @return string
    20031743 */
    … …  
    20181758 * @param string $author_link
    20191759 * @param array $args
    2020  *
    2021  * @uses bbp_is_forum_private()
    2022  * @uses get_post_field()
    2023  * @uses bbp_get_topic_post_type()
    2024  * @uses bbp_is_forum_private()
    2025  * @uses bbp_get_topic_forum_id()
    2026  * @uses bbp_get_reply_post_type()
    2027  * @uses bbp_get_reply_forum_id()
    20281760 *
    20291761 * @return string
    … …  
    20731805 * @param int $forum_id Optional. Forum ID.
    20741806 * @param array Extra classes you can pass when calling this function
    2075  * @uses bbp_get_forum_class() To get the row class of the forum
    20761807 */
    20771808function bbp_forum_class( $forum_id = 0, $classes = array() ) {
    … …  
    20851816     * @param int $forum_id Optional. Forum ID
    20861817     * @param array Extra classes you can pass when calling this function
    2087      * @uses bbp_get_forum_id() To validate the forum id
    2088      * @uses bbp_is_forum_category() To see if forum is a category
    2089      * @uses bbp_get_forum_status() To get the forum status
    2090      * @uses bbp_get_forum_visibility() To get the forum visibility
    2091      * @uses bbp_get_forum_parent_id() To get the forum parent id
    2092      * @uses get_post_class() To get all the classes including ours
    2093      * @uses apply_filters() Calls 'bbp_get_forum_class' with the classes
    20941818     * @return string Row class of the forum
    20951819     */
    … …  
    21291853 *
    21301854 * @param array $args Arguments passed to alter output
    2131  * @uses bbp_get_single_forum_description() Return the eventual output
    21321855 */
    21331856function bbp_single_forum_description( $args = array() ) {
    … …  
    21451868     *  - after: After the text
    21461869     *  - size: Size of the avatar
    2147      * @uses bbp_get_forum_id() To get the forum id
    2148      * @uses bbp_get_forum_topic_count() To get the forum topic count
    2149      * @uses bbp_get_forum_reply_count() To get the forum reply count
    2150      * @uses bbp_get_forum_freshness_link() To get the forum freshness link
    2151      * @uses bbp_get_forum_last_active_id() To get the forum last active id
    2152      * @uses bbp_get_author_link() To get the author link
    2153      * @uses add_filter() To add the 'view all' filter back
    2154      * @uses apply_filters() Calls 'bbp_get_single_forum_description' with
    2155      *                        the description and args
    21561870     * @return string Filtered forum description
    21571871     */
    … …  
    22451959 *
    22461960 * @since 2.1.0 bbPress (r3551)
    2247  *
    2248  * @uses bbp_get_form_forum_title() To get the value of forum title field
    22491961 */
    22501962function bbp_form_forum_title() {
    … …  
    22561968     * @since 2.1.0 bbPress (r3551)
    22571969     *
    2258      * @uses bbp_is_forum_edit() To check if it's forum edit page
    2259      * @uses apply_filters() Calls 'bbp_get_form_forum_title' with the title
    22601970     * @return string Value of forum title field
    22611971     */
    … …  
    22831993 *
    22841994 * @since 2.1.0 bbPress (r3551)
    2285  *
    2286  * @uses bbp_get_form_forum_content() To get value of forum content field
    22871995 */
    22881996function bbp_form_forum_content() {
    … …  
    22942002     * @since 2.1.0 bbPress (r3551)
    22952003     *
    2296      * @uses bbp_is_forum_edit() To check if it's the forum edit page
    2297      * @uses apply_filters() Calls 'bbp_get_form_forum_content' with the content
    22982004     * @return string Value of forum content field
    22992005     */
    … …  
    23212027 *
    23222028 * @since 2.6.0 bbPress (r5837)
    2323  *
    2324  * @uses bbp_get_form_forum_moderators() To get the value of forum moderators field
    23252029 */
    23262030function bbp_form_forum_moderators() {
    … …  
    23312035     *
    23322036     * @since 2.6.0 bbPress (r5837)
    2333      *
    2334      * @uses bbp_is_forum_edit() To check if it's the forum edit page
    2335      * @uses apply_filters() Calls 'bbp_get_form_forum_mods' with the mods
    23362037     *
    23372038     * @return string Value of forum mods field
    … …  
    23762077 *
    23772078 * @since 2.1.0 bbPress (r3551)
    2378  *
    2379  * @uses bbp_get_form_forum_parent() To get the topic's forum id
    23802079 */
    23812080function bbp_form_forum_parent() {
    … …  
    23872086     * @since 2.1.0 bbPress (r3551)
    23882087     *
    2389      * @uses bbp_is_topic_edit() To check if it's the topic edit page
    2390      * @uses bbp_get_forum_parent_id() To get the topic forum id
    2391      * @uses apply_filters() Calls 'bbp_get_form_forum_parent' with the forum
    23922088     * @return string Value of topic content field
    23932089     */
    … …  
    24152111 *
    24162112 * @since 2.1.0 bbPress (r3563)
    2417  *
    2418  * @uses bbp_get_form_forum_type() To get the topic's forum id
    24192113 */
    24202114function bbp_form_forum_type() {
    … …  
    24262120     * @since 2.1.0 bbPress (r3563)
    24272121     *
    2428      * @uses bbp_is_topic_edit() To check if it's the topic edit page
    2429      * @uses bbp_get_forum_type_id() To get the topic forum id
    2430      * @uses apply_filters() Calls 'bbp_get_form_forum_type' with the forum
    24312122     * @return string Value of topic content field
    24322123     */
    … …  
    24542145 *
    24552146 * @since 2.1.0 bbPress (r3563)
    2456  *
    2457  * @uses bbp_get_form_forum_visibility() To get the topic's forum id
    24582147 */
    24592148function bbp_form_forum_visibility() {
    … …  
    24652154     * @since 2.1.0 bbPress (r3563)
    24662155     *
    2467      * @uses bbp_is_topic_edit() To check if it's the topic edit page
    2468      * @uses bbp_get_forum_visibility_id() To get the topic forum id
    2469      * @uses apply_filters() Calls 'bbp_get_form_forum_visibility' with the forum
    24702156     * @return string Value of topic content field
    24712157     */
    … …  
    24932179 *
    24942180 * @since 2.5.0 bbPress (r5156)
    2495  *
    2496  * @uses bbp_get_form_forum_subscribed() To get the subscribed checkbox value
    24972181 */
    24982182function bbp_form_forum_subscribed() {
    … …  
    25042188     * @since 2.5.0 bbPress (r5156)
    25052189     *
    2506      * @uses bbp_is_forum_edit() To check if it's the forum edit page
    2507      * @uses bbp_get_global_post_field() To get current post author
    2508      * @uses bbp_get_current_user_id() To get the current user id
    2509      * @uses bbp_is_user_subscribed() To check if the user is subscribed
    2510      * @uses apply_filters() Calls 'bbp_get_form_forum_subscribed' with the
    2511      *                option
    25122190     * @return string Checked value of forum subscription
    25132191     */
    … …  
    25612239 *  - forum_id: Forum id
    25622240 *  - selected: Override the selected option
    2563  * @uses bbp_get_form_forum_type() To get the topic's forum id
    25642241 */
    25652242function bbp_form_forum_type_dropdown( $args = array() ) {
    … …  
    25762253     *  - forum_id: Forum id
    25772254     *  - selected: Override the selected option
    2578      * @uses bbp_is_topic_edit() To check if it's the topic edit page
    2579      * @uses bbp_get_forum_type() To get the forum type
    2580      * @uses apply_filters()
    25812255     * @return string HTML select list for selecting forum type
    25822256     */
    … …  
    26512325 *  - forum_id: Forum id
    26522326 *  - selected: Override the selected option
    2653  * @uses bbp_get_form_forum_status() To get the topic's forum id
    26542327 */
    26552328function bbp_form_forum_status_dropdown( $args = array() ) {
    … …  
    26662339     *  - forum_id: Forum id
    26672340     *  - selected: Override the selected option
    2668      * @uses bbp_is_topic_edit() To check if it's the topic edit page
    2669      * @uses bbp_get_forum_status() To get the forum status
    2670      * @uses apply_filters()
    26712341     * @return string HTML select list for selecting forum status
    26722342     */
    … …  
    27412411 *  - forum_id: Forum id
    27422412 *  - selected: Override the selected option
    2743  * @uses bbp_get_form_forum_visibility() To get the topic's forum id
    27442413 */
    27452414function bbp_form_forum_visibility_dropdown( $args = array() ) {
    … …  
    27562425     *  - forum_id: Forum id
    27572426     *  - selected: Override the selected option
    2758      * @uses bbp_is_topic_edit() To check if it's the topic edit page
    2759      * @uses bbp_get_forum_visibility() To get the forum visibility
    2760      * @uses apply_filters()
    27612427     * @return string HTML select list for selecting forum visibility
    27622428     */
    … …  
    28612527 *
    28622528 * @param type $forum_id Optional. Forum ID.
    2863  *
    2864  * @uses bbp_get_forum_topics_feed_link()
    28652529 */
    28662530function bbp_forum_topics_feed_link( $forum_id = 0 ) {
    … …  
    28732537     *
    28742538     * @param int $forum_id Optional. Forum ID.
    2875      *
    2876      * @uses bbp_get_forum_id()
    2877      * @uses get_option()
    2878      * @uses trailingslashit()
    2879      * @uses bbp_get_forum_permalink()
    2880      * @uses user_trailingslashit()
    2881      * @uses bbp_get_forum_post_type()
    2882      * @uses get_post_field()
    2883      * @uses apply_filters()
    28842539     *
    28852540     * @return string
    … …  
    29242579 *
    29252580 * @param type $forum_id Optional. Forum ID.
    2926  *
    2927  * @uses bbp_get_forum_replies_feed_link()
    29282581 */
    29292582function bbp_forum_replies_feed_link( $forum_id = 0 ) {
    … …  
    29362589     *
    29372590     * @param int $forum_id Optional. Forum ID.
    2938      *
    2939      * @uses bbp_get_forum_id()
    2940      * @uses get_option()
    2941      * @uses trailingslashit()
    2942      * @uses bbp_get_forum_permalink()
    2943      * @uses user_trailingslashit()
    2944      * @uses bbp_get_forum_post_type()
    2945      * @uses get_post_field()
    2946      * @uses apply_filters()
    29472591     *
    29482592     * @return string
Note: See TracChangeset for help on using the changeset viewer.