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

    r6565 r6573  
    1717 *
    1818 * @since 2.0.0 bbPress (r2857)
    19  *
    20  * @uses bbp_get_topic_post_type() To get the topic post type
    2119 */
    2220function bbp_topic_post_type() {
    … …  
    2826     * @since 2.0.0 bbPress (r2857)
    2927     *
    30      * @uses apply_filters() Calls 'bbp_get_topic_post_type' with the topic
    31      *                        post type id
    3228     * @return string The unique topic post type id
    3329     */
    … …  
    133129 *
    134130 * @param array $args All the arguments supported by {@link WP_Query}
    135  * @uses current_user_can() To check if the current user can edit other's topics
    136  * @uses bbp_get_topic_post_type() To get the topic post type
    137  * @uses WP_Query To make query and get the topics
    138  * @uses is_page() To check if it's a page
    139  * @uses bbp_is_single_forum() To check if it's a forum
    140  * @uses bbp_get_forum_id() To get the forum id
    141  * @uses bbp_get_paged() To get the current page value
    142  * @uses bbp_get_super_stickies() To get the super stickies
    143  * @uses bbp_get_stickies() To get the forum stickies
    144  * @uses bbp_use_pretty_urls() To check if the site is using pretty URLs
    145  * @uses get_permalink() To get the permalink
    146  * @uses add_query_arg() To add custom args to the url
    147  * @uses apply_filters() Calls 'bbp_topics_pagination' with the pagination args
    148  * @uses paginate_links() To paginate the links
    149  * @uses apply_filters() Calls 'bbp_has_topics' with
    150  *                        bbPress::topic_query::have_posts()
    151  *                        and bbPress::topic_query
    152131 * @return object Multidimensional array of topic information
    153132 */
    … …  
    283262 * @since 2.0.0 bbPress (r2485)
    284263 *
    285  * @uses WP_Query bbPress::topic_query::have_posts()
    286264 * @return object Topic information
    287265 */
    … …  
    304282 * @since 2.0.0 bbPress (r2485)
    305283 *
    306  * @uses WP_Query bbPress::topic_query::the_post()
    307284 * @return object Topic information
    308285 */
    … …  
    451428 *
    452429 * @since 2.0.0 bbPress (r2485)
    453  *
    454  * @uses bbp_get_topic_id() To get the topic id
    455430 */
    456431function bbp_topic_id( $topic_id = 0) {
    … …  
    463438     *
    464439     * @param $topic_id Optional. Used to check emptiness
    465      * @uses bbPress::topic_query::post::ID To get the topic id
    466      * @uses bbp_is_topic() To check if the search result is a topic
    467      * @uses bbp_is_single_topic() To check if it's a topic page
    468      * @uses bbp_is_topic_edit() To check if it's a topic edit page
    469      * @uses bbp_is_single_reply() To check if it it's a reply page
    470      * @uses bbp_is_reply_edit() To check if it's a reply edit page
    471      * @uses bbp_get_reply_topic_edit() To get the reply topic id
    472      * @uses get_post_field() To get the post's post type
    473      * @uses WP_Query::post::ID To get the topic id
    474      * @uses bbp_get_topic_post_type() To get the topic post type
    475      * @uses apply_filters() Calls 'bbp_get_topic_id' with the topic id and
    476      *                        supplied topic id
    477440     * @return int The topic id
    478441     */
    … …  
    520483 * @since 2.0.0 bbPress (r2787)
    521484 *
    522  * @param int|object $topic Topic id or topic object
    523  * @param string $output Optional. OBJECT, ARRAY_A, or ARRAY_N. Default = OBJECT
    524  * @param string $filter Optional Sanitation filter. See {@link sanitize_post()}
    525  * @uses get_post() To get the topic
    526  * @uses apply_filters() Calls 'bbp_get_topic' with the topic, output type and
    527  *                        sanitation filter
    528485 * @return mixed Null if error or topic (in specified form) if success
    529486 */
    … …  
    571528 * @param string $redirect_to Optional. Pass a redirect value for use with
    572529 *                              shortcodes and other fun things.
    573  * @uses bbp_get_topic_permalink() To get the topic permalink
    574530 */
    575531function bbp_topic_permalink( $topic_id = 0, $redirect_to = '' ) {
    … …  
    584540     * @param string $redirect_to Optional. Pass a redirect value for use with
    585541     *                              shortcodes and other fun things.
    586      * @uses bbp_get_topic_id() To get the topic id
    587      * @uses get_permalink() To get the topic permalink
    588      * @uses esc_url_raw() To clean the redirect_to url
    589      * @uses apply_filters() Calls 'bbp_get_topic_permalink' with the link
    590      *                        and topic id
    591542     * @return string Permanent link to topic
    592543     */
    … …  
    613564 *
    614565 * @param int $topic_id Optional. Topic id
    615  * @uses bbp_get_topic_title() To get the topic title
    616566 */
    617567function bbp_topic_title( $topic_id = 0 ) {
    … …  
    624574     *
    625575     * @param int $topic_id Optional. Topic id
    626      * @uses bbp_get_topic_id() To get the topic id
    627      * @uses get_the_title() To get the title
    628      * @uses apply_filters() Calls 'bbp_get_topic_title' with the title and
    629      *                        topic id
    630576     * @return string Title of topic
    631577     */
    … …  
    654600     *
    655601     * @param string $title Default text to use as title
    656      *
    657      * @uses bbp_get_page_by_path() Check if page exists at root path
    658      * @uses get_the_title() Use the page title at the root path
    659      * @uses get_post_type_object() Load the post type object
    660      * @uses bbp_get_topic_post_type() Get the topic post type ID
    661      * @uses get_post_type_labels() Get labels for topic post type
    662      * @uses apply_filters() Allow output to be manipulated
    663602     *
    664603     * @return string The topic archive title
    … …  
    691630 *
    692631 * @param int $topic_id Optional. Topic id
    693  * @uses bbp_get_topic_content() To get the topic content
    694632 */
    695633function bbp_topic_content( $topic_id = 0 ) {
    … …  
    702640     *
    703641     * @param int $topic_id Optional. Topic id
    704      * @uses bbp_get_topic_id() To get the topic id
    705      * @uses post_password_required() To check if the topic requires pass
    706      * @uses get_the_password_form() To get the password form
    707      * @uses get_post_field() To get the content post field
    708      * @uses apply_filters() Calls 'bbp_get_topic_content' with the content
    709      *                        and topic id
    710642     * @return string Content of the topic
    711643     */
    … …  
    731663 * @param int $topic_id Optional. Topic id
    732664 * @param int $length Optional. Length of the excerpt. Defaults to 100 letters
    733  * @uses bbp_get_topic_excerpt() To get the topic excerpt
    734665 */
    735666function bbp_topic_excerpt( $topic_id = 0, $length = 100 ) {
    … …  
    744675     * @param int $length Optional. Length of the excerpt. Defaults to 100
    745676     *                     letters
    746      * @uses bbp_get_topic_id() To get the topic id
    747      * @uses get_post_field() To get the excerpt
    748      * @uses bbp_get_topic_content() To get the topic content
    749      * @uses apply_filters() Calls 'bbp_get_topic_excerpt' with the excerpt,
    750      *                        topic id and length
    751677     * @return string topic Excerpt
    752678     */
    … …  
    786712 * @param bool $humanize Optional. Humanize output using time_since
    787713 * @param bool $gmt Optional. Use GMT
    788  * @uses bbp_get_topic_post_date() to get the output
    789714 */
    790715function bbp_topic_post_date( $topic_id = 0, $humanize = false, $gmt = false ) {
    … …  
    799724     * @param bool $humanize Optional. Humanize output using time_since
    800725     * @param bool $gmt Optional. Use GMT
    801      * @uses bbp_get_topic_id() To get the topic id
    802      * @uses get_post_time() to get the topic post time
    803      * @uses bbp_get_time_since() to maybe humanize the topic post time
    804726     * @return string
    805727     */
    … …  
    831753 *
    832754 * @param array $args See {@link bbp_get_topic_pagination()}
    833  * @uses bbp_get_topic_pagination() To get the topic pagination links
    834755 */
    835756function bbp_topic_pagination( $args = array() ) {
    … …  
    845766     *  - before: Before the links
    846767     *  - after: After the links
    847      * @uses bbp_get_topic_id() To get the topic id
    848      * @uses bbp_use_pretty_urls() To check if the site is using pretty URLs
    849      * @uses user_trailingslashit() To add a trailing slash
    850      * @uses trailingslashit() To add a trailing slash
    851      * @uses get_permalink() To get the permalink of the topic
    852      * @uses add_query_arg() To add query args
    853      * @uses bbp_get_topic_reply_count() To get topic reply count
    854      * @uses bbp_show_topic_lead() Are we showing the topic as a lead?
    855      * @uses get_option() To get replies per page option
    856      * @uses paginate_links() To paginate the links
    857      * @uses apply_filters() Calls 'bbp_get_topic_pagination' with the links
    858      *                        and arguments
    859768     * @return string Pagination links
    860769     */
    … …  
    929838 * @param string $content Optional. Content to which we need to append the revisions to
    930839 * @param int $topic_id Optional. Topic id
    931  * @uses bbp_get_topic_revision_log() To get the topic revision log
    932  * @uses apply_filters() Calls 'bbp_topic_append_revisions' with the processed
    933  *                        content, original content and topic id
    934840 * @return string Content with the revisions appended
    935841 */
    … …  
    954860 *
    955861 * @param int $topic_id Optional. Topic id
    956  * @uses bbp_get_topic_revision_log() To get the topic revision log
    957862 */
    958863function bbp_topic_revision_log( $topic_id = 0 ) {
    … …  
    965870     *
    966871     * @param int $topic_id Optional. Topic id
    967      * @uses bbp_get_topic_id() To get the topic id
    968      * @uses bbp_get_topic_revisions() To get the topic revisions
    969      * @uses bbp_get_topic_raw_revision_log() To get the raw revision log
    970      * @uses bbp_get_topic_author_display_name() To get the topic author
    971      * @uses bbp_get_author_link() To get the topic author link
    972      * @uses bbp_convert_date() To convert the date
    973      * @uses bbp_get_time_since() To get the time in since format
    974      * @uses apply_filters() Calls 'bbp_get_topic_revision_log' with the
    975      *                        log and topic id
    976872     * @return string Revision log of the topic
    977873     */
    … …  
    1027923         *
    1028924         * @param int $topic_id Optional. Topic id
    1029          * @uses bbp_get_topic_id() To get the topic id
    1030          * @uses get_post_meta() To get the revision log meta
    1031          * @uses apply_filters() Calls 'bbp_get_topic_raw_revision_log'
    1032          *                        with the log and topic id
    1033925         * @return string Raw revision log of the topic
    1034926         */
    … …  
    1049941 *
    1050942 * @param int $topic_id Optional. Topic id
    1051  * @uses bbp_get_topic_id() To get the topic id
    1052  * @uses wp_get_post_revisions() To get the topic revisions
    1053  * @uses apply_filters() Calls 'bbp_get_topic_revisions'
    1054  *                        with the revisions and topic id
    1055943 * @return string Topic revisions
    1056944 */
    … …  
    1069957 *
    1070958 * @param int $topic_id Optional. Topic id
    1071  * @uses bbp_get_topic_revisions() To get the topic revisions
    1072  * @uses apply_filters() Calls 'bbp_get_topic_revision_count'
    1073  *                        with the revision count and topic id
    1074959 * @return string Topic revision count
    1075960 */
    … …  
    1093978 *                           normal sticky, it is checked if it is a super
    1094979 *                           sticky or not. Defaults to true.
    1095  * @uses bbp_get_topic_id() To get the topic id
    1096  * @uses bbp_get_topic_forum_id() To get the topic forum id
    1097  * @uses bbp_get_stickies() To get the stickies
    1098  * @uses bbp_is_topic_super_sticky() To check if the topic is a super sticky
    1099980 * @return bool True if sticky or super sticky, false if not.
    1100981 */
    … …  
    11201001 *
    11211002 * @param int $topic_id Optional. Topic id
    1122  * @uses bbp_get_topic_id() To get the topic id
    1123  * @uses bbp_get_super_stickies() To get the super stickies
    11241003 * @return bool True if super sticky, false if not.
    11251004 */
    … …  
    11391018 *
    11401019 * @param int $topic_id Optional. Topic id
    1141  * @uses bbp_get_topic_status() To get the topic status
    11421020 */
    11431021function bbp_topic_status( $topic_id = 0 ) {
    … …  
    11501028     *
    11511029     * @param int $topic_id Optional. Topic id
    1152      * @uses bbp_get_topic_id() To get the topic id
    1153      * @uses get_post_status() To get the topic status
    1154      * @uses apply_filters() Calls 'bbp_get_topic_status' with the status
    1155      *                        and topic id
    11561030     * @return string Status of topic
    11571031     */
    … …  
    11671041 *
    11681042 * @since 2.6.0 bbPress (r6383)
    1169  *
    1170  * @uses bbp_get_public_status_id()
    1171  * @uses bbp_get_closed_status_id()
    11721043 *
    11731044 * @return array
    … …  
    11891060 *
    11901061 * @param int $topic_id Optional. Topic id
    1191  * @uses bbp_get_topic_status() To get the topic status
    1192  * @uses apply_filters() Calls 'bbp_is_topic_closed' with the topic id
    11931062 *
    11941063 * @return bool True if closed, false if not.
    … …  
    12081077 * @since 2.0.0 bbPress (r2727)
    12091078 *
    1210  * @uses bbp_get_topic_status()
    1211  *
    1212  * @param int $topic_id Optional. Topic id
    1213  * @uses bbp_is_topic_closed() To check if the topic is closed
     1079 * @param int $topic_id Optional. Topic id
     1080 *
    12141081 * @return bool True if open, false if closed.
    12151082 */
    … …  
    12261093 *
    12271094 * @param int $topic_id Optional. Topic id
    1228  * @uses bbp_get_topic_id() To get the topic id
    1229  * @uses bbp_get_topic_status() To get the topic status
    1230  * @uses bbp_get_public_topic_statuses() To get the public statuses
    1231  * @uses apply_filters() Calls 'bbp_is_topic_public' with the topic id
    12321095 * @return bool True if public, false if not.
    12331096 */
    … …  
    12481111 *
    12491112 * @param int $topic_id Optional. Topic id
    1250  * @uses bbp_get_topic_id() To get the topic id
    1251  * @uses bbp_get_topic_status() To get the topic status
    1252  * @uses apply_filters() Calls 'bbp_is_topic_published' with the topic id
    12531113 * @return bool True if published, false if not.
    12541114 */
    … …  
    12681128 *
    12691129 * @param int $topic_id Optional. Topic id
    1270  * @uses bbp_get_topic_id() To get the topic id
    1271  * @uses bbp_get_topic_status() To get the topic status
    1272  * @uses apply_filters() Calls 'bbp_is_topic_spam' with the topic id
    12731130 * @return bool True if spam, false if not.
    12741131 */
    … …  
    12881145 *
    12891146 * @param int $topic_id Optional. Topic id
    1290  * @uses bbp_get_topic_id() To get the topic id
    1291  * @uses bbp_get_topic_status() To get the topic status
    1292  * @uses apply_filters() Calls 'bbp_is_topic_trash' with the topic id
    12931147 * @return bool True if trashed, false if not.
    12941148 */
    … …  
    13081162 *
    13091163 * @param int $topic_id Optional. Topic id
    1310  * @uses bbp_get_topic_id() To get the topic id
    1311  * @uses bbp_get_topic_status() To get the topic status
    1312  * @uses apply_filters() Calls 'bbp_is_topic_pending' with the topic id
    13131164 * @return bool True if pending, false if not.
    13141165 */
    … …  
    13281179 *
    13291180 * @param int $topic_id Optional. Topic id
    1330  * @uses bbp_get_topic_id() To get the topic id
    1331  * @uses bbp_get_topic_status() To get the topic status
    1332  * @uses apply_filters() Calls 'bbp_is_topic_private' with the topic id
    13331181 * @return bool True if private, false if not.
    13341182 */
    … …  
    13481196 *
    13491197 * @param int $topic_id Optional. Topic id
    1350  * @uses bbp_get_topic_id() To get the topic id
    1351  * @uses bbp_get_topic_author_id() To get the topic author id
    1352  * @uses get_post_meta() To get the anonymous user name and email meta
    1353  * @uses apply_filters() Calls 'bbp_is_topic_anonymous' with the topic id
    13541198 * @return bool True if the post is by an anonymous user, false if not.
    13551199 */
    … …  
    13821226 *
    13831227 * @param int $topic_id Optional. Topic id
    1384  * @uses bbp_get_topic_author() To get the topic author
    13851228 */
    13861229function bbp_topic_author( $topic_id = 0 ) {
    … …  
    13971240     *
    13981241     * @param int $topic_id Optional. Topic id
    1399      * @uses bbp_get_topic_id() To get the topic id
    1400      * @uses bbp_is_topic_anonymous() To check if the topic is by an
    1401      *                                 anonymous user
    1402      * @uses bbp_get_topic_author_id() To get the topic author id
    1403      * @uses get_the_author_meta() To get the display name of the author
    1404      * @uses get_post_meta() To get the name of the anonymous poster
    1405      * @uses apply_filters() Calls 'bbp_get_topic_author' with the author
    1406      *                        and topic id
    14071242     * @return string Author of topic
    14081243     */
    … …  
    14261261 *
    14271262 * @param int $topic_id Optional. Topic id
    1428  * @uses bbp_get_topic_author_id() To get the topic author id
    14291263 */
    14301264function bbp_topic_author_id( $topic_id = 0 ) {
    … …  
    14371271     *
    14381272     * @param int $topic_id Optional. Topic id
    1439      * @uses bbp_get_topic_id() To get the topic id
    1440      * @uses get_post_field() To get the topic author id
    1441      * @uses apply_filters() Calls 'bbp_get_topic_author_id' with the author
    1442      *                        id and topic id
    14431273     * @return string Author of topic
    14441274     */
    … …  
    14571287 *
    14581288 * @param int $topic_id Optional. Topic id
    1459  * @uses bbp_get_topic_author_display_name() To get the topic author's display
    1460  *                                            name
    14611289 */
    14621290function bbp_topic_author_display_name( $topic_id = 0 ) {
    … …  
    14691297     *
    14701298     * @param int $topic_id Optional. Topic id
    1471      * @uses bbp_get_topic_id() To get the topic id
    1472      * @uses bbp_is_topic_anonymous() To check if the topic is by an
    1473      *                                 anonymous user
    1474      * @uses bbp_get_topic_author_id() To get the topic author id
    1475      * @uses get_the_author_meta() To get the author meta
    1476      * @uses get_post_meta() To get the anonymous user name
    1477      * @uses apply_filters() Calls 'bbp_get_topic_author_id' with the
    1478      *                        display name and topic id
    14791299     * @return string Topic's author's display name
    14801300     */
    … …  
    15221342 * @param int $topic_id Optional. Topic id
    15231343 * @param int $size Optional. Avatar size. Defaults to 40
    1524  * @uses bbp_get_topic_author_avatar() To get the topic author avatar
    15251344 */
    15261345function bbp_topic_author_avatar( $topic_id = 0, $size = 40 ) {
    … …  
    15341353     * @param int $topic_id Optional. Topic id
    15351354     * @param int $size Optional. Avatar size. Defaults to 40
    1536      * @uses bbp_get_topic_id() To get the topic id
    1537      * @uses bbp_is_topic_anonymous() To check if the topic is by an
    1538      *                                 anonymous user
    1539      * @uses bbp_get_topic_author_id() To get the topic author id
    1540      * @uses get_post_meta() To get the anonymous user's email
    1541      * @uses get_avatar() To get the avatar
    1542      * @uses apply_filters() Calls 'bbp_get_topic_author_avatar' with the
    1543      *                        avatar, topic id and size
    15441355     * @return string Avatar of the author of the topic
    15451356     */
    … …  
    15661377 *
    15671378 * @param mixed|int $args If it is an integer, it is used as topic_id. Optional.
    1568  * @uses bbp_get_topic_author_link() To get the topic author link
    15691379 */
    15701380function bbp_topic_author_link( $args = array() ) {
    … …  
    15781388     * @param mixed|int $args If it is an integer, it is used as topic id.
    15791389     *                         Optional.
    1580      * @uses bbp_get_topic_id() To get the topic id
    1581      * @uses bbp_get_topic_author_display_name() To get the topic author
    1582      * @uses bbp_is_topic_anonymous() To check if the topic is by an
    1583      *                                 anonymous user
    1584      * @uses bbp_get_topic_author_url() To get the topic author url
    1585      * @uses bbp_get_topic_author_avatar() To get the topic author avatar
    1586      * @uses bbp_get_topic_author_display_name() To get the topic author display
    1587      *                                      name
    1588      * @uses bbp_get_user_display_role() To get the topic author display role
    1589      * @uses bbp_get_topic_author_id() To get the topic author id
    1590      * @uses apply_filters() Calls 'bbp_get_topic_author_link' with the link
    1591      *                        and args
    15921390     * @return string Author link of topic
    15931391     */
    … …  
    16801478 *
    16811479 * @param int $topic_id Optional. Topic id
    1682  * @uses bbp_get_topic_author_url() To get the topic author url
    16831480 */
    16841481function bbp_topic_author_url( $topic_id = 0 ) {
    … …  
    16921489     *
    16931490     * @param int $topic_id Optional. Topic id
    1694      * @uses bbp_get_topic_id() To get the topic id
    1695      * @uses bbp_is_topic_anonymous() To check if the topic is by an anonymous
    1696      *                                 user or not
    1697      * @uses bbp_user_has_profile() To check if the user has a profile
    1698      * @uses bbp_get_topic_author_id() To get topic author id
    1699      * @uses bbp_get_user_profile_url() To get profile url
    1700      * @uses get_post_meta() To get anonmous user's website
    1701      * @uses apply_filters() Calls 'bbp_get_topic_author_url' with the link &
    1702      *                        topic id
    17031491     * @return string Author URL of topic
    17041492     */
    … …  
    17281516 *
    17291517 * @param int $topic_id Optional. Reply id
    1730  * @uses bbp_get_topic_author_email() To get the topic author email
    17311518 */
    17321519function bbp_topic_author_email( $topic_id = 0 ) {
    … …  
    17391526     *
    17401527     * @param int $topic_id Optional. Reply id
    1741      * @uses bbp_get_topic_id() To get the topic id
    1742      * @uses bbp_is_topic_anonymous() To check if the topic is by an anonymous
    1743      *                                 user
    1744      * @uses bbp_get_topic_author_id() To get the topic author id
    1745      * @uses get_userdata() To get the user data
    1746      * @uses get_post_meta() To get the anonymous poster's email
    1747      * @uses apply_filters() Calls bbp_get_topic_author_email with the author
    1748      *                        email & topic id
    17491528     * @return string Topic author email address
    17501529     */
    … …  
    17821561 *
    17831562 * @param array $args Optional.
    1784  * @uses bbp_get_topic_author_role() To get the topic author role
    17851563 */
    17861564function bbp_topic_author_role( $args = array() ) {
    … …  
    17931571     *
    17941572     * @param array $args Optional.
    1795      * @uses bbp_get_topic_id() To get the topic id
    1796      * @uses bbp_get_user_display_role() To get the user display role
    1797      * @uses bbp_get_topic_author_id() To get the topic author id
    1798      * @uses apply_filters() Calls bbp_get_topic_author_role with the author
    1799      *                        role & args
    18001573     * @return string topic author role
    18011574     */
    … …  
    18341607 *
    18351608 * @param int $topic_id Optional. Topic id
    1836  * @uses bbp_get_topic_forum_title() To get the topic's forum title
    18371609 */
    18381610function bbp_topic_forum_title( $topic_id = 0 ) {
    … …  
    18451617     *
    18461618     * @param int $topic_id Optional. Topic id
    1847      * @uses bbp_get_topic_id() To get topic id
    1848      * @uses bbp_get_topic_forum_id() To get topic's forum id
    1849      * @uses apply_filters() Calls 'bbp_get_topic_forum' with the forum
    1850      *                        title and topic id
    18511619     * @return string Topic forum title
    18521620     */
    … …  
    18651633 *
    18661634 * @param int $topic_id Optional. Topic id
    1867  * @uses bbp_get_topic_forum_id()
    18681635 */
    18691636function bbp_topic_forum_id( $topic_id = 0 ) {
    … …  
    18761643     *
    18771644     * @param int $topic_id Optional. Topic id
    1878      * @uses bbp_get_topic_id() To get topic id
    1879      * @uses get_post_meta() To retrieve get topic's forum id meta
    1880      * @uses apply_filters() Calls 'bbp_get_topic_forum_id' with the forum
    1881      *                        id and topic id
    18821645     * @return int Topic forum id
    18831646     */
    … …  
    19061669 *
    19071670 * @param int $topic_id Optional. Forum id
    1908  * @uses bbp_get_topic_last_active_id() To get the topic's last active id
    19091671 */
    19101672function bbp_topic_last_active_id( $topic_id = 0 ) {
    … …  
    19171679     *
    19181680     * @param int $topic_id Optional. Forum id
    1919      * @uses bbp_get_topic_id() To get the topic id
    1920      * @uses get_post_meta() To get the topic's last active id
    1921      * @uses apply_filters() Calls 'bbp_get_topic_last_active_id' with
    1922      *                        the last active id and topic id
    19231681     * @return int Forum's last active id
    19241682     */
    … …  
    19371695 *
    19381696 * @param int $topic_id Optional. Topic id
    1939  * @uses bbp_get_topic_last_active_time() To get topic freshness
    19401697 */
    19411698function bbp_topic_last_active_time( $topic_id = 0 ) {
    … …  
    19481705     *
    19491706     * @param int $topic_id Optional. Topic id
    1950      * @uses bbp_get_topic_id() To get topic id
    1951      * @uses get_post_meta() To get the topic last active meta
    1952      * @uses bbp_get_topic_last_reply_id() To get topic last reply id
    1953      * @uses get_post_field() To get the post date of topic/reply
    1954      * @uses bbp_convert_date() To convert date
    1955      * @uses bbp_get_time_since() To get time in since format
    1956      * @uses apply_filters() Calls 'bbp_get_topic_last_active' with topic
    1957      *                        freshness and topic id
    19581707     * @return string Topic freshness
    19591708     */
    … …  
    19851734 * @since 2.5.0 bbPress (r5156)
    19861735 * @since 2.6.0 bbPress (r6308) Add 'redirect_to' support
    1987  *
    1988  * @uses bbp_get_topic_subscription_link()
    19891736 */
    19901737function bbp_topic_subscription_link( $args = array() ) {
    … …  
    19991746     * @since 2.5.0 bbPress (r5156)
    20001747     * @since 2.6.0 bbPress (r6308) Add 'redirect_to' support
    2001      *
    2002      * @uses bbp_is_subscriptions()
    2003      * @uses bbp_get_subscriptions_permalink()
    2004      * @uses bbp_parse_args()
    2005      * @uses bbp_get_user_subscribe_link()
    2006      * @uses apply_filters() Calls 'bbp_get_topic_subscribe_link'
    20071748     */
    20081749    function bbp_get_topic_subscription_link( $args = array() ) {
    … …  
    20401781 * @since 2.5.0 bbPress (r5156)
    20411782 * @since 2.6.0 bbPress (r6308) Add 'redirect_to' support
    2042  *
    2043  * @uses bbp_get_topic_favorite_link()
    20441783 */
    20451784function bbp_topic_favorite_link( $args = array() ) {
    … …  
    20541793     * @since 2.5.0 bbPress (r5156)
    20551794     * @since 2.6.0 bbPress (r6308) Add 'redirect_to' support
    2056      *
    2057      * @uses bbp_is_favorites()
    2058      * @uses bbp_get_favorites_permalink()
    2059      * @uses bbp_parse_args()
    2060      * @uses bbp_get_user_favorites_link()
    2061      * @uses apply_filters() Calls 'bbp_get_topic_favorite_link'
    20621795     */
    20631796    function bbp_get_topic_favorite_link( $args = array() ) {
    … …  
    20961829 *
    20971830 * @param int $topic_id Optional. Topic id
    2098  * @uses bbp_get_topic_last_reply_id() To get the topic last reply id
    20991831 */
    21001832function bbp_topic_last_reply_id( $topic_id = 0 ) {
    … …  
    21071839     *
    21081840     * @param int $topic_id Optional. Topic id
    2109      * @uses bbp_get_topic_id() To get the topic id
    2110      * @uses get_post_meta() To get the last reply id meta
    2111      * @uses apply_filters() Calls 'bbp_get_topic_last_reply_id' with the
    2112      *                        last reply id and topic id
    21131841     * @return int Topic last reply id
    21141842     */
    … …  
    21271855 *
    21281856 * @param int $topic_id Optional. Topic id
    2129  * @uses bbp_get_topic_last_reply_title() To get the topic last reply title
    21301857 */
    21311858function bbp_topic_last_reply_title( $topic_id = 0 ) {
    … …  
    21391866     *
    21401867     * @param int $topic_id Optional. Topic id
    2141      * @uses bbp_get_topic_id() To get the topic id
    2142      * @uses bbp_get_topic_last_reply_id() To get the topic last reply id
    2143      * @uses bbp_get_reply_title() To get the reply title
    2144      * @uses apply_filters() Calls 'bbp_get_topic_last_reply_title' with
    2145      *                        the reply title and topic id
    21461868     * @return string Topic last reply title
    21471869     */
    … …  
    21641886 *
    21651887 * @param int $topic_id Optional. Topic id
    2166  * @uses bbp_get_topic_last_reply_permalink() To get the topic's last reply link
    21671888 */
    21681889function bbp_topic_last_reply_permalink( $topic_id = 0 ) {
    … …  
    21751896     *
    21761897     * @param int $topic_id Optional. Topic id
    2177      * @uses bbp_get_topic_id() To get the topic id
    2178      * @uses bbp_get_topic_last_reply_id() To get the topic last reply id
    2179      * @uses bbp_get_reply_permalink() To get the reply permalink
    2180      * @uses apply_filters() Calls 'bbp_get_topic_last_reply_permalink' with
    2181      *                        the reply permalink and topic id
    21821898     * @return string Permanent link to the reply
    21831899     */
    … …  
    21971913 *
    21981914 * @param int $topic_id Optional. Topic id
    2199  * @uses bbp_get_topic_last_reply_url() To get the topic last reply url
    22001915 */
    22011916function bbp_topic_last_reply_url( $topic_id = 0 ) {
    … …  
    22081923     *
    22091924     * @param int $topic_id Optional. Topic id
    2210      * @uses bbp_get_topic_id() To get the topic id
    2211      * @uses bbp_get_topic_last_reply_id() To get the topic last reply id
    2212      * @uses bbp_get_reply_url() To get the reply url
    2213      * @uses bbp_get_topic_permalink() To get the topic permalink
    2214      * @uses apply_filters() Calls 'bbp_get_topic_last_reply_url' with
    2215      *                        the reply url and topic id
    22161925     * @return string Topic last reply url
    22171926     */
    … …  
    22371946 *
    22381947 * @param int $topic_id Optional. Topic id
    2239  * @uses bbp_get_topic_freshness_link() To get the topic freshness link
    22401948 */
    22411949function bbp_topic_freshness_link( $topic_id = 0 ) {
    … …  
    22491957     *
    22501958     * @param int $topic_id Optional. Topic id
    2251      * @uses bbp_get_topic_id() To get the topic id
    2252      * @uses bbp_get_topic_last_reply_url() To get the topic last reply url
    2253      * @uses bbp_get_topic_last_reply_title() To get the reply title
    2254      * @uses bbp_get_topic_last_active_time() To get the topic freshness
    2255      * @uses apply_filters() Calls 'bbp_get_topic_freshness_link' with the
    2256      *                        link and topic id
    22571959     * @return string Topic freshness link
    22581960     */
    … …  
    22791981 *
    22801982 * @param int $topic_id Optional. Topic id
    2281  * @uses bbp_get_topic_replies_link() To get the topic replies link
    22821983 */
    22831984function bbp_topic_replies_link( $topic_id = 0 ) {
    … …  
    22911992     *
    22921993     * @param int $topic_id Optional. Topic id
    2293      * @uses bbp_get_topic_id() To get the topic id
    2294      * @uses bbp_get_topic_permalink() To get the topic permalink
    2295      * @uses bbp_get_topic_reply_count() To get the topic reply count
    2296      * @uses bbp_get_topic_reply_count_hidden() To get the topic hidden
    2297      *                                           reply count
    2298      * @uses current_user_can() To check if the current user can edit others
    2299      *                           replies
    2300      * @uses apply_filters() Calls 'bbp_get_topic_replies_link' with the
    2301      *                        replies link and topic id
    23021994     */
    23031995    function bbp_get_topic_replies_link( $topic_id = 0 ) {
    … …  
    23382030 * @param int $topic_id Optional. Topic id
    23392031 * @param boolean $integer Optional. Whether or not to format the result
    2340  * @uses bbp_get_topic_reply_count() To get the topic reply count
    23412032 */
    23422033function bbp_topic_reply_count( $topic_id = 0, $integer = false ) {
    … …  
    23502041     * @param int $topic_id Optional. Topic id
    23512042     * @param boolean $integer Optional. Whether or not to format the result
    2352      * @uses bbp_get_topic_id() To get the topic id
    2353      * @uses get_post_meta() To get the topic reply count meta
    2354      * @uses apply_filters() Calls 'bbp_get_topic_reply_count' with the
    2355      *                        reply count and topic id
    23562043     * @return int Reply count
    23572044     */
    … …  
    23732060 * @param int $topic_id Optional. Topic id
    23742061 * @param boolean $integer Optional. Whether or not to format the result
    2375  * @uses bbp_get_topic_post_count() To get the topic post count
    23762062 */
    23772063function bbp_topic_post_count( $topic_id = 0, $integer = false ) {
    … …  
    23852071     * @param int $topic_id Optional. Topic id
    23862072     * @param boolean $integer Optional. Whether or not to format the result
    2387      * @uses bbp_get_topic_id() To get the topic id
    2388      * @uses get_post_meta() To get the topic post count meta
    2389      * @uses apply_filters() Calls 'bbp_get_topic_post_count' with the
    2390      *                        post count and topic id
    23912073     * @return int Post count
    23922074     */
    … …  
    24092091 * @param int $topic_id Optional. Topic id
    24102092 * @param boolean $integer Optional. Whether or not to format the result
    2411  * @uses bbp_get_topic_reply_count_hidden() To get the topic hidden reply count
    24122093 */
    24132094function bbp_topic_reply_count_hidden( $topic_id = 0, $integer = false ) {
    … …  
    24222103     * @param int $topic_id Optional. Topic id
    24232104     * @param boolean $integer Optional. Whether or not to format the result
    2424      * @uses bbp_get_topic_id() To get the topic id
    2425      * @uses get_post_meta() To get the hidden reply count
    2426      * @uses apply_filters() Calls 'bbp_get_topic_reply_count_hidden' with
    2427      *                        the hidden reply count and topic id
    24282105     * @return int Topic hidden reply count
    24292106     */
    … …  
    24442121 *
    24452122 * @param int $topic_id Optional. Topic id
    2446  * @uses bbp_get_topic_voice_count() To get the topic voice count
    24472123 */
    24482124function bbp_topic_voice_count( $topic_id = 0, $integer = false ) {
    … …  
    24552131     *
    24562132     * @param int $topic_id Optional. Topic id
    2457      * @uses bbp_get_topic_id() To get the topic id
    2458      * @uses get_post_meta() To get the voice count meta
    2459      * @uses apply_filters() Calls 'bbp_get_topic_voice_count' with the
    2460      *                        voice count and topic id
    24612133     * @return int Voice count of the topic
    24622134     */
    … …  
    24782150 * @param int $topic_id Optional. Topic id
    24792151 * @param array $args See {@link bbp_get_topic_tag_list()}
    2480  * @uses bbp_get_topic_tag_list() To get the topic tag list
    24812152 */
    24822153function bbp_topic_tag_list( $topic_id = 0, $args = array() ) {
    … …  
    24932164     *  - sep: Tag separator
    24942165     *  - after: After the tag list
    2495      * @uses bbp_get_topic_id() To get the topic id
    2496      * @uses get_the_term_list() To get the tags list
    24972166     * @return string Tag list of the topic
    24982167     */
    … …  
    25472216 * @param int $topic_id Optional. Topic id
    25482217 * @param array Extra classes you can pass when calling this function
    2549  * @uses bbp_get_topic_class() To get the topic class
    25502218 */
    25512219function bbp_topic_class( $topic_id = 0, $classes = array() ) {
    … …  
    25592227     * @param int $topic_id Optional. Topic id
    25602228     * @param array Extra classes you can pass when calling this function
    2561      * @uses bbp_is_topic_sticky() To check if the topic is a sticky
    2562      * @uses bbp_is_topic_super_sticky() To check if the topic is a super sticky
    2563      * @uses bbp_get_topic_forum_id() To get the topic forum id
    2564      * @uses get_post_class() To get the topic classes
    2565      * @uses apply_filters() Calls 'bbp_get_topic_class' with the classes
    2566      *                        and topic id
    25672229     * @return string Row class of a topic
    25682230     */
    … …  
    25912253 *
    25922254 * @param array $args See {@link bbp_get_topic_admin_links()}
    2593  * @uses bbp_get_topic_admin_links() To get the topic admin links
    25942255 */
    25952256function bbp_topic_admin_links( $args = array() ) {
    … …  
    26072268     *  - sep: Links separator
    26082269     *  - links: Topic admin links array
    2609      * @uses current_user_can() To check if the current user can edit/delete
    2610      *                           the topic
    2611      * @uses bbp_get_topic_edit_link() To get the topic edit link
    2612      * @uses bbp_get_topic_trash_link() To get the topic trash link
    2613      * @uses bbp_get_topic_close_link() To get the topic close link
    2614      * @uses bbp_get_topic_spam_link() To get the topic spam link
    2615      * @uses bbp_get_topic_stick_link() To get the topic stick link
    2616      * @uses bbp_get_topic_merge_link() To get the topic merge link
    2617      * @uses bbp_get_topic_status() To get the topic status
    2618      * @uses apply_filters() Calls 'bbp_get_topic_admin_links' with the
    2619      *                        topic admin links and args
    26202270     * @return string Topic admin links
    26212271     */
    … …  
    26752325 *
    26762326 * @param array $args See {@link bbp_get_topic_edit_link()}
    2677  * @uses bbp_get_topic_edit_link() To get the topic edit link
    26782327 */
    26792328function bbp_topic_edit_link( $args = array() ) {
    … …  
    26912340     *  - link_after: After the link
    26922341     *  - edit_text: Edit text
    2693      * @uses bbp_get_topic_id() To get the topic id
    2694      * @uses bbp_get_topic() To get the topic
    2695      * @uses current_user_can() To check if the current user can edit the
    2696      *                           topic
    2697      * @uses bbp_get_topic_edit_url() To get the topic edit url
    2698      * @uses apply_filters() Calls 'bbp_get_topic_edit_link' with the link
    2699      *                        and args
    27002342     * @return string Topic edit link
    27012343     */
    … …  
    27422384 *
    27432385 * @param int $topic_id Optional. Topic id
    2744  * @uses bbp_get_topic_edit_url() To get the topic edit url
    27452386 */
    27462387function bbp_topic_edit_url( $topic_id = 0 ) {
    … …  
    27532394     *
    27542395     * @param int $topic_id Optional. Topic id
    2755      * @uses bbp_get_topic_id() To get the topic id
    2756      * @uses bbp_get_topic() To get the topic
    2757      * @uses add_query_arg() To add custom args to the url
    2758      * @uses apply_filters() Calls 'bbp_get_topic_edit_url' with the edit
    2759      *                        url and topic id
    27602396     * @return string Topic edit url
    27612397     */
    … …  
    27972433 *
    27982434 * @param array $args See {@link bbp_get_topic_trash_link()}
    2799  * @uses bbp_get_topic_trash_link() To get the topic trash link
    28002435 */
    28012436function bbp_topic_trash_link( $args = array() ) {
    … …  
    28162451     *  - restore_text: Restore text
    28172452     *  - delete_text: Delete text
    2818      * @uses bbp_get_topic_id() To get the topic id
    2819      * @uses bbp_get_topic() To get the topic
    2820      * @uses current_user_can() To check if the current user can delete the
    2821      *                           topic
    2822      * @uses bbp_is_topic_trash() To check if the topic is trashed
    2823      * @uses bbp_get_topic_status() To get the topic status
    2824      * @uses add_query_arg() To add custom args to the url
    2825      * @uses wp_nonce_url() To nonce the url
    2826      * @uses esc_url() To escape the url
    2827      * @uses apply_filters() Calls 'bbp_get_topic_trash_link' with the link
    2828      *                        and args
    28292453     * @return string Topic trash link
    28302454     */
    … …  
    28762500 *
    28772501 * @param array $args See {@link bbp_get_topic_close_link()}
    2878  * @uses bbp_get_topic_close_link() To get the topic close link
    28792502 */
    28802503function bbp_topic_close_link( $args = array() ) {
    … …  
    28932516     *  - close_text: Close text
    28942517     *  - open_text: Open text
    2895      * @uses bbp_get_topic_id() To get the topic id
    2896      * @uses bbp_get_topic() To get the topic
    2897      * @uses current_user_can() To check if the current user can edit the topic
    2898      * @uses bbp_is_topic_open() To check if the topic is open
    2899      * @uses add_query_arg() To add custom args to the url
    2900      * @uses wp_nonce_url() To nonce the url
    2901      * @uses esc_url() To escape the url
    2902      * @uses apply_filters() Calls 'bbp_get_topic_close_link' with the link
    2903      *                        and args
    29042518     * @return string Topic close link
    29052519     */
    … …  
    29392553 *
    29402554 * @param array $args See {@link bbp_get_topic_approve_link()}
    2941  * @uses bbp_get_topic_approve_link() To get the topic approve link
    29422555 */
    29432556function bbp_topic_approve_link( $args = array() ) {
    … …  
    29572570     *  - approve_text: Approve text
    29582571     *  - unapprove_text: Unapprove text
    2959      * @uses bbp_get_topic_id() To get the topic id
    2960      * @uses bbp_get_topic() To get the topic
    2961      * @uses current_user_can() To check if the current user can approve the topic
    2962      * @uses bbp_is_topic_pending() To check if the topic is pending
    2963      * @uses add_query_arg() To add custom args to the url
    2964      * @uses wp_nonce_url() To nonce the url
    2965      * @uses esc_url() To escape the url
    2966      * @uses apply_filters() Calls 'bbp_get_topic_approve_link' with the link
    2967      *                        and args
    29682572     * @return string Topic approve link
    29692573     */
    … …  
    30032607 *
    30042608 * @param array $args See {@link bbp_get_topic_stick_link()}
    3005  * @uses bbp_get_topic_stick_link() To get the topic stick link
    30062609 */
    30072610function bbp_topic_stick_link( $args = array() ) {
    … …  
    30212624     *  - unstick_text: Unstick text
    30222625     *  - super_text: Stick to front text
    3023      * @uses bbp_get_topic_id() To get the topic id
    3024      * @uses bbp_get_topic() To get the topic
    3025      * @uses current_user_can() To check if the current user can edit the
    3026      *                           topic
    3027      * @uses bbp_is_topic_sticky() To check if the topic is a sticky
    3028      * @uses add_query_arg() To add custom args to the url
    3029      * @uses wp_nonce_url() To nonce the url
    3030      * @uses esc_url() To escape the url
    3031      * @uses apply_filters() Calls 'bbp_get_topic_stick_link' with the link
    3032      *                        and args
     2626     *
    30332627     * @return string Topic stick link
    30342628     */
    … …  
    30832677 *
    30842678 * @param array $args
    3085  * @uses bbp_get_topic_merge_link() To get the topic merge link
    30862679 */
    30872680function bbp_topic_merge_link( $args = array() ) {
    … …  
    30992692     *  - link_after: After the link
    31002693     *  - merge_text: Merge text
    3101      * @uses bbp_get_topic_id() To get the topic id
    3102      * @uses bbp_get_topic() To get the topic
    3103      * @uses bbp_get_topic_edit_url() To get the topic edit url
    3104      * @uses add_query_arg() To add custom args to the url
    3105      * @uses esc_url() To escape the url
    3106      * @uses apply_filters() Calls 'bbp_get_topic_merge_link' with the link
    3107      *                        and args
     2694     *
    31082695     * @return string Topic merge link
    31092696     */
    … …  
    31392726 *
    31402727 * @param array $args See {@link bbp_get_topic_spam_link()}
    3141  * @uses bbp_get_topic_spam_link() Topic spam link
    31422728 */
    31432729function bbp_topic_spam_link( $args = array() ) {
    … …  
    31562742     *  - spam_text: Spam text
    31572743     *  - unspam_text: Unspam text
    3158      * @uses bbp_get_topic_id() To get the topic id
    3159      * @uses bbp_get_topic() To get the topic
    3160      * @uses current_user_can() To check if the current user can edit the topic
    3161      * @uses bbp_is_topic_spam() To check if the topic is marked as spam
    3162      * @uses add_query_arg() To add custom args to the url
    3163      * @uses wp_nonce_url() To nonce the url
    3164      * @uses esc_url() To escape the url
    3165      * @uses apply_filters() Calls 'bbp_get_topic_spam_link' with the link
    3166      *                        and args
     2744     *
    31672745     * @return string Topic spam link
    31682746     */
    … …  
    32002778 *
    32012779 * @param array $args
    3202  * @uses bbp_get_reply_to_link() To get the reply to link
    32032780 */
    32042781function bbp_topic_reply_link( $args = array() ) {
    … …  
    32122789     *
    32132790     * @param array $args Arguments
    3214      * @uses bbp_current_user_can_access_create_reply_form() To check permissions
    3215      * @uses bbp_get_topic_id() To validate the topic id
    3216      * @uses bbp_get_topic() To get the topic
    3217      * @uses apply_filters() Calls 'bbp_get_topic_reply_link' with the formatted link,
    3218      *                        the arguments array, and the topic
     2791     *
    32192792     * @return string Link for a reply to a topic
    32202793     */
    … …  
    33212894 *
    33222895 * @since 2.0.0 bbPress (r2519)
    3323  *
    3324  * @uses bbp_get_forum_pagination_count() To get the forum pagination count
    33252896 */
    33262897function bbp_forum_pagination_count() {
    … …  
    33322903     * @since 2.0.0 bbPress (r2519)
    33332904     *
    3334      * @uses bbp_number_format() To format the number value
    3335      * @uses apply_filters() Calls 'bbp_get_forum_pagination_count' with the
    3336      *                        pagination count
    33372905     * @return string Forum Pagination count
    33382906     */
    … …  
    33682936 *
    33692937 * @since 2.0.0 bbPress (r2519)
    3370  *
    3371  * @uses bbp_get_forum_pagination_links() To get the pagination links
    33722938 */
    33732939function bbp_forum_pagination_links() {
    … …  
    33792945     * @since 2.0.0 bbPress (r2519)
    33802946     *
    3381      * @uses bbPress::topic_query::pagination_links To get the links
    33822947     * @return string Pagination links
    33832948     */
    … …  
    33972962 *
    33982963 * @since 2.0.0 bbPress (r2744)
    3399  *
    3400  * @uses bbp_is_single_topic() To check if it's a topic page
    3401  * @uses bbp_get_topic_status() To get the topic status
    3402  * @uses bbp_get_topic_id() To get the topic id
    3403  * @uses apply_filters() Calls 'bbp_topic_notices' with the notice text, topic
    3404  *                        status and topic id
    3405  * @uses bbp_add_error() To add an error message
    34062964 */
    34072965function bbp_topic_notices() {
    … …  
    34843042     *  - topic_id: Topic id
    34853043     *  - selected: Override the selected option
    3486      * @uses bbp_get_topic_id() To get the topic id
    3487      * @uses bbp_is_single_topic() To check if we're viewing a single topic
    3488      * @uses bbp_is_topic_edit() To check if it is the topic edit page
    3489      * @uses bbp_is_topic_super_sticky() To check if the topic is a super sticky
    3490      * @uses bbp_is_topic_sticky() To check if the topic is a sticky
    34913044     */
    34923045    function bbp_get_form_topic_type_dropdown( $args = array() ) {
    … …  
    36403193 *
    36413194 * @param array $args See {@link bbp_get_single_topic_description()}
    3642  * @uses bbp_get_single_topic_description() Return the eventual output
    36433195 */
    36443196function bbp_single_topic_description( $args = array() ) {
    … …  
    36563208     *  - after: After the text
    36573209     *  - size: Size of the avatar
    3658      * @uses bbp_get_topic_id() To get the topic id
    3659      * @uses bbp_get_topic_voice_count() To get the topic voice count
    3660      * @uses bbp_get_topic_reply_count() To get the topic reply count
    3661      * @uses bbp_get_topic_freshness_link() To get the topic freshness link
    3662      * @uses bbp_get_topic_last_active_id() To get the topic last active id
    3663      * @uses bbp_get_reply_author_link() To get the reply author link
    3664      * @uses apply_filters() Calls 'bbp_get_single_topic_description' with
    3665      *                        the description and args
    36663210     * @return string Filtered topic description
    36673211     */
    … …  
    37223266 *
    37233267 * @since 2.0.0 bbPress (r3348)
    3724  *
    3725  * @uses bbp_get_topic_post_type() To get the topic post type
    37263268 */
    37273269function bbp_topic_tag_tax_id() {
    … …  
    37333275     * @since 2.0.0 bbPress (r3348)
    37343276     *
    3735      * @uses apply_filters() Calls 'bbp_get_topic_tag_tax_id' with the topic tax id
    37363277     * @return string The unique topic tag taxonomy
    37373278     */
    … …  
    37913332 * @since 2.0.0 bbPress (r3109)
    37923333 *
    3793  * @uses bbp_get_topic_tag_id()
    37943334 */
    37953335function bbp_topic_tag_id( $tag = '' ) {
    … …  
    38003340     *
    38013341     * @since 2.0.0 bbPress (r3109)
    3802      *
    3803      * @uses get_term_by()
    3804      * @uses get_queried_object()
    3805      * @uses get_query_var()
    3806      * @uses apply_filters()
    38073342     *
    38083343     * @return string Term Name
    … …  
    38313366 *
    38323367 * @since 2.0.0 bbPress (r3109)
    3833  *
    3834  * @uses bbp_get_topic_tag_name()
    38353368 */
    38363369function bbp_topic_tag_name( $tag = '' ) {
    … …  
    38413374     *
    38423375     * @since 2.0.0 bbPress (r3109)
    3843      *
    3844      * @uses get_term_by()
    3845      * @uses get_queried_object()
    3846      * @uses get_query_var()
    3847      * @uses apply_filters()
    38483376     *
    38493377     * @return string Term Name
    … …  
    38723400 *
    38733401 * @since 2.0.0 bbPress (r3109)
    3874  *
    3875  * @uses bbp_get_topic_tag_slug()
    38763402 */
    38773403function bbp_topic_tag_slug( $tag = '' ) {
    … …  
    38823408     *
    38833409     * @since 2.0.0 bbPress (r3109)
    3884      *
    3885      * @uses get_term_by()
    3886      * @uses get_queried_object()
    3887      * @uses get_query_var()
    3888      * @uses apply_filters()
    38893410     *
    38903411     * @return string Term Name
    … …  
    39133434 *
    39143435 * @since 2.0.0 bbPress (r3348)
    3915  *
    3916  * @uses bbp_get_topic_tag_link()
    39173436 */
    39183437function bbp_topic_tag_link( $tag = '' ) {
    … …  
    39233442     *
    39243443     * @since 2.0.0 bbPress (r3348)
    3925      *
    3926      * @uses get_term_by()
    3927      * @uses get_queried_object()
    3928      * @uses get_query_var()
    3929      * @uses apply_filters()
    39303444     *
    39313445     * @return string Term Name
    … …  
    39543468 *
    39553469 * @since 2.0.0 bbPress (r3348)
    3956  *
    3957  * @uses bbp_get_topic_tag_edit_link()
    39583470 */
    39593471function bbp_topic_tag_edit_link( $tag = '' ) {
    … …  
    39643476     *
    39653477     * @since 2.0.0 bbPress (r3348)
    3966      *
    3967      * @uses get_term_by()
    3968      * @uses get_queried_object()
    3969      * @uses get_query_var()
    3970      * @uses apply_filters()
    39713478     *
    39723479     * @return string Term Name
    … …  
    40033510 *
    40043511 * @since 2.0.0 bbPress (r3109)
    4005  *
    4006  * @uses bbp_get_topic_tag_description()
    40073512 */
    40083513function bbp_topic_tag_description( $args = array() ) {
    … …  
    40143519     * @since 2.0.0 bbPress (r3109)
    40153520     *
    4016      * @uses get_term_by()
    4017      * @uses get_queried_object()
    4018      * @uses get_query_var()
    4019      * @uses apply_filters()
    40203521     * @param array $args before|after|tag
    40213522     *
    … …  
    40543555 *
    40553556 * @since 2.0.0 bbPress (r2976)
    4056  *
    4057  * @uses bbp_get_form_topic_title() To get the value of topic title field
    40583557 */
    40593558function bbp_form_topic_title() {
    … …  
    40653564     * @since 2.0.0 bbPress (r2976)
    40663565     *
    4067      * @uses bbp_is_topic_edit() To check if it's topic edit page
    4068      * @uses apply_filters() Calls 'bbp_get_form_topic_title' with the title
    40693566     * @return string Value of topic title field
    40703567     */
    … …  
    40923589 *
    40933590 * @since 2.0.0 bbPress (r2976)
    4094  *
    4095  * @uses bbp_get_form_topic_content() To get value of topic content field
    40963591 */
    40973592function bbp_form_topic_content() {
    … …  
    41033598     * @since 2.0.0 bbPress (r2976)
    41043599     *
    4105      * @uses bbp_is_topic_edit() To check if it's the topic edit page
    4106      * @uses apply_filters() Calls 'bbp_get_form_topic_content' with the content
    41073600     * @return string Value of topic content field
    41083601     */
    … …  
    41313624 * @since 2.1.0 bbPress (r3653)
    41323625 *
    4133  * @uses do_action()
    41343626 * @todo Links and filter
    41353627 */
    … …  
    41423634 *
    41433635 * @since 2.0.0 bbPress (r2976)
    4144  *
    4145  * @uses bbp_get_form_topic_tags() To get the value of topic tags field
    41463636 */
    41473637function bbp_form_topic_tags() {
    … …  
    41533643     * @since 2.0.0 bbPress (r2976)
    41543644     *
    4155      * @uses bbp_is_topic_edit() To check if it's the topic edit page
    4156      * @uses apply_filters() Calls 'bbp_get_form_topic_tags' with the tags
    41573645     * @return string Value of topic tags field
    41583646     */
    … …  
    42083696 *
    42093697 * @since 2.0.0 bbPress (r2976)
    4210  *
    4211  * @uses bbp_get_form_topic_forum() To get the topic's forum id
    42123698 */
    42133699function bbp_form_topic_forum() {
    … …  
    42193705     * @since 2.0.0 bbPress (r2976)
    42203706     *
    4221      * @uses bbp_is_topic_edit() To check if it's the topic edit page
    4222      * @uses bbp_get_topic_forum_id() To get the topic forum id
    4223      * @uses apply_filters() Calls 'bbp_get_form_topic_forum' with the forum
    42243707     * @return string Value of topic content field
    42253708     */
    … …  
    42473730 *
    42483731 * @since 2.0.0 bbPress (r2976)
    4249  *
    4250  * @uses bbp_get_form_topic_subscribed() To get the subscribed checkbox value
    42513732 */
    42523733function bbp_form_topic_subscribed() {
    … …  
    42583739     * @since 2.0.0 bbPress (r2976)
    42593740     *
    4260      * @uses bbp_is_topic_edit() To check if it's the topic edit page
    4261      * @uses bbp_is_user_subscribed() To check if the user is subscribed
    4262      * @uses apply_filters() Calls 'bbp_get_form_topic_subscribed' with the
    4263      *                        option
    42643741     * @return string Checked value of topic subscription
    42653742     */
    … …  
    43053782 *
    43063783 * @since 2.0.0 bbPress (r2976)
    4307  *
    4308  * @uses bbp_get_form_topic_log_edit() To get the topic log edit value
    43093784 */
    43103785function bbp_form_topic_log_edit() {
    … …  
    43163791     * @since 2.0.0 bbPress (r2976)
    43173792     *
    4318      * @uses apply_filters() Calls 'bbp_get_form_topic_log_edit' with the
    4319      *                        log edit value
    43203793     * @return string Topic log edit checked value
    43213794     */
    … …  
    43423815 *
    43433816 * @since 2.0.0 bbPress (r2976)
    4344  *
    4345  * @uses bbp_get_form_topic_edit_reason() To get the topic edit reason value
    43463817 */
    43473818function bbp_form_topic_edit_reason() {
    … …  
    43533824     * @since 2.0.0 bbPress (r2976)
    43543825     *
    4355      * @uses apply_filters() Calls 'bbp_get_form_topic_edit_reason' with the
    4356      *                        topic edit reason value
    43573826     * @return string Topic edit reason value
    43583827     */
Note: See TracChangeset for help on using the changeset viewer.