Skip to:
Content

bbPress.org


Ignore:
Timestamp:
10/28/2015 04:07:50 AM (11 years ago)
Author:
netweb
Message:

Standardize @since PHPDoc tags style and format

This changeset updates the style and formatting of all of our @since instances for compatibility with phpDocumentor 2 and WP-Parser as we move toward implementing the bbPress developer code reference.

Props thebrandonallen
Fixes #2879

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/includes/topics/template.php

    r5842 r5951  
    1616 * Output the unique id of the custom post type for topics
    1717 *
    18  * @since bbPress (r2857)
     18 * @since 2.0.0 bbPress (r2857)
    1919 *
    2020 * @uses bbp_get_topic_post_type() To get the topic post type
    … …  
    2626         * Return the unique id of the custom post type for topics
    2727         *
    28          * @since bbPress (r2857)
     28         * @since 2.0.0 bbPress (r2857)
    2929         *
    3030         * @uses apply_filters() Calls 'bbp_get_topic_post_type' with the topic
    … …  
    3939 * Return array of labels used by the topic post type
    4040 *
    41  * @since bbPress (r5129)
     41 * @since 2.5.0 bbPress (r5129)
    4242 *
    4343 * @return array
    … …  
    6666 * Return array of topic post type rewrite settings
    6767 *
    68  * @since bbPress (r5129)
     68 * @since 2.5.0 bbPress (r5129)
    6969 *
    7070 * @return array
    … …  
    8080 * Return array of features the topic post type supports
    8181 *
    82  * @since bbPress (r5129)
     82 * @since 2.5.0 bbPress (r5129)
    8383 *
    8484 * @return array
    … …  
    9797 * - New Style: Topics appear as "lead" posts, ahead of replies
    9898 *
    99  * @since bbPress (r2954)
     99 * @since 2.0.0 bbPress (r2954)
     100 *
    100101 * @param $show_lead Optional. Default false
    101102 * @return bool Yes if the topic appears as a lead, otherwise false
    … …  
    116117 * The main topic loop. WordPress makes this easy for us
    117118 *
    118  * @since bbPress (r2485)
     119 * @since 2.0.0 bbPress (r2485)
    119120 *
    120121 * @param array $args All the arguments supported by {@link WP_Query}
    … …  
    428429 * Whether there are more topics available in the loop
    429430 *
    430  * @since bbPress (r2485)
     431 * @since 2.0.0 bbPress (r2485)
    431432 *
    432433 * @uses WP_Query bbPress::topic_query::have_posts()
    … …  
    449450 * Loads up the current topic in the loop
    450451 *
    451  * @since bbPress (r2485)
     452 * @since 2.0.0 bbPress (r2485)
    452453 *
    453454 * @uses WP_Query bbPress::topic_query::the_post()
    … …  
    461462 * Output the topic id
    462463 *
    463  * @since bbPress (r2485)
     464 * @since 2.0.0 bbPress (r2485)
    464465 *
    465466 * @uses bbp_get_topic_id() To get the topic id
    … …  
    471472         * Return the topic id
    472473         *
    473          * @since bbPress (r2485)
     474         * @since 2.0.0 bbPress (r2485)
    474475         *
    475476         * @param $topic_id Optional. Used to check emptiness
    … …  
    528529 * Gets a topic
    529530 *
    530  * @since bbPress (r2787)
     531 * @since 2.0.0 bbPress (r2787)
    531532 *
    532533 * @param int|object $topic Topic id or topic object
    … …  
    575576 * Output the link to the topic in the topic loop
    576577 *
    577  * @since bbPress (r2485)
     578 * @since 2.0.0 bbPress (r2485)
    578579 *
    579580 * @param int $topic_id Optional. Topic id
    … …  
    588589         * Return the link to the topic
    589590         *
    590          * @since bbPress (r2485)
     591         * @since 2.0.0 bbPress (r2485)
    591592         *
    592593         * @param int $topic_id Optional. Topic id
    … …  
    618619 * Output the title of the topic
    619620 *
    620  * @since bbPress (r2485)
     621 * @since 2.0.0 bbPress (r2485)
    621622 *
    622623 * @param int $topic_id Optional. Topic id
    … …  
    629630         * Return the title of the topic
    630631         *
    631          * @since bbPress (r2485)
     632         * @since 2.0.0 bbPress (r2485)
    632633         *
    633634         * @param int $topic_id Optional. Topic id
    … …  
    648649 * Output the topic archive title
    649650 *
    650  * @since bbPress (r3249)
     651 * @since 2.0.0 bbPress (r3249)
    651652 *
    652653 * @param string $title Default text to use as title
    … …  
    658659         * Return the topic archive title
    659660         *
    660          * @since bbPress (r3249)
     661         * @since 2.0.0 bbPress (r3249)
    661662         *
    662663         * @param string $title Default text to use as title
    … …  
    694695 * Output the content of the topic
    695696 *
    696  * @since bbPress (r2780)
     697 * @since 2.0.0 bbPress (r2780)
    697698 *
    698699 * @param int $topic_id Optional. Topic id
    … …  
    705706         * Return the content of the topic
    706707         *
    707          * @since bbPress (r2780)
     708         * @since 2.0.0 bbPress (r2780)
    708709         *
    709710         * @param int $topic_id Optional. Topic id
    … …  
    732733 * Output the excerpt of the topic
    733734 *
    734  * @since bbPress (r2780)
     735 * @since 2.0.0 bbPress (r2780)
    735736 *
    736737 * @param int $topic_id Optional. Topic id
    … …  
    744745         * Return the excerpt of the topic
    745746         *
    746          * @since bbPress (r2780)
     747         * @since 2.0.0 bbPress (r2780)
    747748         *
    748749         * @param int $topic_id Optional. topic id
    … …  
    785786 * Output the post date and time of a topic
    786787 *
    787  * @since bbPress (r4155)
     788 * @since 2.2.0 bbPress (r4155)
    788789 *
    789790 * @param int $topic_id Optional. Topic id.
    … …  
    798799         * Return the post date and time of a topic
    799800         *
    800          * @since bbPress (r4155)
     801         * @since 2.2.0 bbPress (r4155)
    801802         *
    802803         * @param int $topic_id Optional. Topic id.
    … …  
    831832 * Output pagination links of a topic within the topic loop
    832833 *
    833  * @since bbPress (r2966)
     834 * @since 2.0.0 bbPress (r2966)
    834835 *
    835836 * @param array $args See {@link bbp_get_topic_pagination()}
    … …  
    842843         * Returns pagination links of a topic within the topic loop
    843844         *
    844          * @since bbPress (r2966)
     845         * @since 2.0.0 bbPress (r2966)
    845846         *
    846847         * @param array $args This function supports these arguments:
    … …  
    922923 * Append revisions to the topic content
    923924 *
    924  * @since bbPress (r2782)
     925 * @since 2.0.0 bbPress (r2782)
    925926 *
    926927 * @param string $content Optional. Content to which we need to append the revisions to
    … …  
    947948 * Output the revision log of the topic
    948949 *
    949  * @since bbPress (r2782)
     950 * @since 2.0.0 bbPress (r2782)
    950951 *
    951952 * @param int $topic_id Optional. Topic id
    … …  
    958959         * Return the formatted revision log of the topic
    959960         *
    960          * @since bbPress (r2782)
     961         * @since 2.0.0 bbPress (r2782)
    961962         *
    962963         * @param int $topic_id Optional. Topic id
    … …  
    10191020                 * Return the raw revision log of the topic
    10201021                 *
    1021                  * @since bbPress (r2782)
     1022                 * @since 2.0.0 bbPress (r2782)
    10221023                 *
    10231024                 * @param int $topic_id Optional. Topic id
    … …  
    10401041 * Return the revisions of the topic
    10411042 *
    1042  * @since bbPress (r2782)
     1043 * @since 2.0.0 bbPress (r2782)
    10431044 *
    10441045 * @param int $topic_id Optional. Topic id
    … …  
    10591060 * Return the revision count of the topic
    10601061 *
    1061  * @since bbPress (r2782)
     1062 * @since 2.0.0 bbPress (r2782)
    10621063 *
    10631064 * @param int $topic_id Optional. Topic id
    … …  
    10771078 * Is the topic a sticky or super sticky?
    10781079 *
    1079  * @since bbPress (r2754)
     1080 * @since 2.0.0 bbPress (r2754)
    10801081 *
    10811082 * @param int $topic_id Optional. Topic id
    … …  
    11061107 * Is the topic a super sticky?
    11071108 *
    1108  * @since bbPress (r2754)
     1109 * @since 2.0.0 bbPress (r2754)
    11091110 *
    11101111 * @param int $topic_id Optional. Topic id
    … …  
    11241125 * Output the status of the topic
    11251126 *
    1126  * @since bbPress (r2667)
     1127 * @since 2.0.0 bbPress (r2667)
    11271128 *
    11281129 * @param int $topic_id Optional. Topic id
    … …  
    11351136         * Return the status of the topic
    11361137         *
    1137          * @since bbPress (r2667)
     1138         * @since 2.0.0 bbPress (r2667)
    11381139         *
    11391140         * @param int $topic_id Optional. Topic id
    … …  
    11531154 * Is the topic closed to new replies?
    11541155 *
    1155  * @since bbPress (r2746)
     1156 * @since 2.0.0 bbPress (r2746)
    11561157 *
    11571158 * @param int $topic_id Optional. Topic id
    … …  
    11721173 * Is the topic open to new replies?
    11731174 *
    1174  * @since bbPress (r2727)
     1175 * @since 2.0.0 bbPress (r2727)
    11751176 *
    11761177 * @uses bbp_get_topic_status()
    … …  
    11871188 * Is the topic not spam or deleted?
    11881189 *
    1189  * @since bbPress (r3496)
     1190 * @since 2.0.0 bbPress (r3496)
    11901191 *
    11911192 * @param int $topic_id Optional. Topic id
    … …  
    12061207 * Is the topic marked as spam?
    12071208 *
    1208  * @since bbPress (r2727)
     1209 * @since 2.0.0 bbPress (r2727)
    12091210 *
    12101211 * @param int $topic_id Optional. Topic id
    … …  
    12251226 * Is the topic trashed?
    12261227 *
    1227  * @since bbPress (r2888)
     1228 * @since 2.0.0 bbPress (r2888)
    12281229 *
    12291230 * @param int $topic_id Optional. Topic id
    … …  
    12441245 * Is the topic pending?
    12451246 *
    1246  * @since bbPress (r5504)
     1247 * @since 2.6.0 bbPress (r5504)
    12471248 *
    12481249 * @param int $topic_id Optional. Topic id
    … …  
    12631264 * Is the topic private?
    12641265 *
    1265  * @since bbPress (r5504)
     1266 * @since 2.6.0 bbPress (r5504)
    12661267 *
    12671268 * @param int $topic_id Optional. Topic id
    … …  
    12821283 * Is the posted by an anonymous user?
    12831284 *
    1284  * @since bbPress (r2753)
     1285 * @since 2.0.0 bbPress (r2753)
    12851286 *
    12861287 * @param int $topic_id Optional. Topic id
    … …  
    13141315 * Output the author of the topic.
    13151316 *
    1316  * @since bbPress (r2590)
    1317  * @deprecated bbPress (r5119)
     1317 * @since 2.0.0 bbPress (r2590)
     1318 *
     1319 * @deprecated 2.5.0 bbPress (r5119)
    13181320 *
    13191321 * @param int $topic_id Optional. Topic id
    … …  
    13281330         * Return the author of the topic
    13291331         *
    1330          * @since bbPress (r2590)
    1331          * @deprecated bbPress (r5119)
     1332         * @since 2.0.0 bbPress (r2590)
     1333         *
     1334         * @deprecated 2.5.0 bbPress (r5119)
    13321335         *
    13331336         * @param int $topic_id Optional. Topic id
    … …  
    13571360 * Output the author ID of the topic
    13581361 *
    1359  * @since bbPress (r2590)
     1362 * @since 2.0.0 bbPress (r2590)
    13601363 *
    13611364 * @param int $topic_id Optional. Topic id
    … …  
    13681371         * Return the author ID of the topic
    13691372         *
    1370          * @since bbPress (r2590)
     1373         * @since 2.0.0 bbPress (r2590)
    13711374         *
    13721375         * @param int $topic_id Optional. Topic id
    … …  
    13871390 * Output the author display_name of the topic
    13881391 *
    1389  * @since bbPress (r2590)
     1392 * @since 2.0.0 bbPress (r2590)
    13901393 *
    13911394 * @param int $topic_id Optional. Topic id
    … …  
    13991402         * Return the author display_name of the topic
    14001403         *
    1401          * @since bbPress (r2485)
     1404         * @since 2.0.0 bbPress (r2485)
    14021405         *
    14031406         * @param int $topic_id Optional. Topic id
    … …  
    14501453 * Output the author avatar of the topic
    14511454 *
    1452  * @since bbPress (r2590)
     1455 * @since 2.0.0 bbPress (r2590)
    14531456 *
    14541457 * @param int $topic_id Optional. Topic id
    … …  
    14621465         * Return the author avatar of the topic
    14631466         *
    1464          * @since bbPress (r2590)
     1467         * @since 2.0.0 bbPress (r2590)
    14651468         *
    14661469         * @param int $topic_id Optional. Topic id
    … …  
    14941497 * Output the author link of the topic
    14951498 *
    1496  * @since bbPress (r2717)
     1499 * @since 2.0.0 bbPress (r2717)
    14971500 *
    14981501 * @param mixed|int $args If it is an integer, it is used as topic_id. Optional.
    … …  
    15051508         * Return the author link of the topic
    15061509         *
    1507          * @since bbPress (r2717)
     1510         * @since 2.0.0 bbPress (r2717)
    15081511         *
    15091512         * @param mixed|int $args If it is an integer, it is used as topic id.
    … …  
    16071610 * Output the author url of the topic
    16081611 *
    1609  * @since bbPress (r2590)
     1612 * @since 2.0.0 bbPress (r2590)
    16101613 *
    16111614 * @param int $topic_id Optional. Topic id
    … …  
    16191622         * Return the author url of the topic
    16201623         *
    1621          * @since bbPress (r2590)
     1624         * @since 2.0.0 bbPress (r2590)
    16221625         *
    16231626         * @param int $topic_id Optional. Topic id
    … …  
    16541657 * Output the topic author email address
    16551658 *
    1656  * @since bbPress (r3445)
     1659 * @since 2.0.0 bbPress (r3445)
    16571660 *
    16581661 * @param int $topic_id Optional. Reply id
    … …  
    16651668         * Return the topic author email address
    16661669         *
    1667          * @since bbPress (r3445)
     1670         * @since 2.0.0 bbPress (r3445)
    16681671         *
    16691672         * @param int $topic_id Optional. Reply id
    … …  
    17071710 * Output the topic author role
    17081711 *
    1709  * @since bbPress (r3860)
     1712 * @since 2.1.0 bbPress (r3860)
    17101713 *
    17111714 * @param array $args Optional.
    … …  
    17181721         * Return the topic author role
    17191722         *
    1720          * @since bbPress (r3860)
     1723         * @since 2.1.0 bbPress (r3860)
    17211724         *
    17221725         * @param array $args Optional.
    … …  
    17581761 * Output the title of the forum a topic belongs to
    17591762 *
    1760  * @since bbPress (r2485)
     1763 * @since 2.0.0 bbPress (r2485)
    17611764 *
    17621765 * @param int $topic_id Optional. Topic id
    … …  
    17691772         * Return the title of the forum a topic belongs to
    17701773         *
    1771          * @since bbPress (r2485)
     1774         * @since 2.0.0 bbPress (r2485)
    17721775         *
    17731776         * @param int $topic_id Optional. Topic id
    … …  
    17881791 * Output the forum id a topic belongs to
    17891792 *
    1790  * @since bbPress (r2491)
     1793 * @since 2.0.0 bbPress (r2491)
    17911794 *
    17921795 * @param int $topic_id Optional. Topic id
    … …  
    17991802         * Return the forum id a topic belongs to
    18001803         *
    1801          * @since bbPress (r2491)
     1804         * @since 2.0.0 bbPress (r2491)
    18021805         *
    18031806         * @param int $topic_id Optional. Topic id
    … …  
    18181821 * Output the topics last active ID
    18191822 *
    1820  * @since bbPress (r2860)
     1823 * @since 2.0.0 bbPress (r2860)
    18211824 *
    18221825 * @param int $topic_id Optional. Forum id
    … …  
    18291832         * Return the topics last active ID
    18301833         *
    1831          * @since bbPress (r2860)
     1834         * @since 2.0.0 bbPress (r2860)
    18321835         *
    18331836         * @param int $topic_id Optional. Forum id
    … …  
    18481851 * Output the topics last update date/time (aka freshness)
    18491852 *
    1850  * @since bbPress (r2625)
     1853 * @since 2.0.0 bbPress (r2625)
    18511854 *
    18521855 * @param int $topic_id Optional. Topic id
    … …  
    18591862         * Return the topics last update date/time (aka freshness)
    18601863         *
    1861          * @since bbPress (r2625)
     1864         * @since 2.0.0 bbPress (r2625)
    18621865         *
    18631866         * @param int $topic_id Optional. Topic id
    … …  
    18971900 * Output the topic subscription link
    18981901 *
    1899  * @since bbPress (r5156)
     1902 * @since 2.5.0 bbPress (r5156)
    19001903 *
    19011904 * @uses bbp_get_topic_subscription_link()
    … …  
    19101913         * A custom wrapper for bbp_get_user_subscribe_link()
    19111914         *
    1912          * @since bbPress (r5156)
     1915         * @since 2.5.0 bbPress (r5156)
    19131916         *
    19141917         * @uses bbp_parse_args()
    … …  
    19421945 * Output the topic favorite link
    19431946 *
    1944  * @since bbPress (r5156)
     1947 * @since 2.5.0 bbPress (r5156)
    19451948 *
    19461949 * @uses bbp_get_topic_favorite_link()
    … …  
    19551958         * A custom wrapper for bbp_get_user_favorite_link()
    19561959         *
    1957          * @since bbPress (r5156)
     1960         * @since 2.5.0 bbPress (r5156)
    19581961         *
    19591962         * @uses bbp_parse_args()
    … …  
    19871990 * Output the id of the topics last reply
    19881991 *
    1989  * @since bbPress (r2625)
     1992 * @since 2.0.0 bbPress (r2625)
    19901993 *
    19911994 * @param int $topic_id Optional. Topic id
    … …  
    19982001         * Return the topics last update date/time (aka freshness)
    19992002         *
    2000          * @since bbPress (r2625)
     2003         * @since 2.0.0 bbPress (r2625)
    20012004         *
    20022005         * @param int $topic_id Optional. Topic id
    … …  
    20452048 * Output the link to the last reply in a topic
    20462049 *
    2047  * @since bbPress (r2464)
     2050 * @since 2.0.0 bbPress (r2464)
    20482051 *
    20492052 * @param int $topic_id Optional. Topic id
    … …  
    20562059         * Return the link to the last reply in a topic
    20572060         *
    2058          * @since bbPress (r2464)
     2061         * @since 2.0.0 bbPress (r2464)
    20592062         *
    20602063         * @param int $topic_id Optional. Topic id
    … …  
    20772080 * Output the link to the last reply in a topic
    20782081 *
    2079  * @since bbPress (r2683)
     2082 * @since 2.0.0 bbPress (r2683)
    20802083 *
    20812084 * @param int $topic_id Optional. Topic id
    … …  
    20882091         * Return the link to the last reply in a topic
    20892092         *
    2090          * @since bbPress (r2683)
     2093         * @since 2.0.0 bbPress (r2683)
    20912094         *
    20922095         * @param int $topic_id Optional. Topic id
    … …  
    21162119 * attributes and content.
    21172120 *
    2118  * @since bbPress (r2625)
     2121 * @since 2.0.0 bbPress (r2625)
    21192122 *
    21202123 * @param int $topic_id Optional. Topic id
    … …  
    21282131         * with link attributes and content.
    21292132         *
    2130          * @since bbPress (r2625)
     2133         * @since 2.0.0 bbPress (r2625)
    21312134         *
    21322135         * @param int $topic_id Optional. Topic id
    … …  
    21572160 * Output the replies link of the topic
    21582161 *
    2159  * @since bbPress (r2740)
     2162 * @since 2.0.0 bbPress (r2740)
    21602163 *
    21612164 * @param int $topic_id Optional. Topic id
    … …  
    21692172         * Return the replies link of the topic
    21702173         *
    2171          * @since bbPress (r2740)
     2174         * @since 2.0.0 bbPress (r2740)
    21722175         *
    21732176         * @param int $topic_id Optional. Topic id
    … …  
    22222225 * Output total reply count of a topic
    22232226 *
    2224  * @since bbPress (r2485)
     2227 * @since 2.0.0 bbPress (r2485)
    22252228 *
    22262229 * @param int $topic_id Optional. Topic id
    … …  
    22342237         * Return total reply count of a topic
    22352238         *
    2236          * @since bbPress (r2485)
     2239         * @since 2.0.0 bbPress (r2485)
    22372240         *
    22382241         * @param int $topic_id Optional. Topic id
    … …  
    22552258 * Output total post count of a topic
    22562259 *
    2257  * @since bbPress (r2954)
     2260 * @since 2.0.0 bbPress (r2954)
    22582261 *
    22592262 * @param int $topic_id Optional. Topic id
    … …  
    22672270         * Return total post count of a topic
    22682271         *
    2269          * @since bbPress (r2954)
     2272         * @since 2.0.0 bbPress (r2954)
    22702273         *
    22712274         * @param int $topic_id Optional. Topic id
    … …  
    22892292 * spammed replies)
    22902293 *
    2291  * @since bbPress (r2740)
     2294 * @since 2.0.0 bbPress (r2740)
    22922295 *
    22932296 * @param int $topic_id Optional. Topic id
    … …  
    23022305         * and spammed replies)
    23032306         *
    2304          * @since bbPress (r2740)
     2307         * @since 2.0.0 bbPress (r2740)
    23052308         *
    23062309         * @param int $topic_id Optional. Topic id
    … …  
    23232326 * Output total voice count of a topic
    23242327 *
    2325  * @since bbPress (r2567)
     2328 * @since 2.0.0 bbPress (r2567)
    23262329 *
    23272330 * @param int $topic_id Optional. Topic id
    … …  
    23342337         * Return total voice count of a topic
    23352338         *
    2336          * @since bbPress (r2567)
     2339         * @since 2.0.0 bbPress (r2567)
    23372340         *
    23382341         * @param int $topic_id Optional. Topic id
    … …  
    23542357 * Output a the tags of a topic
    23552358 *
    2356  * @since bbPress (r2688)
     2359 * @since 2.0.0 bbPress (r2688)
    23572360 *
    23582361 * @param int $topic_id Optional. Topic id
    … …  
    23662369         * Return the tags of a topic
    23672370         *
    2368          * @since bbPress (r2688)
     2371         * @since 2.0.0 bbPress (r2688)
    23692372         *
    23702373         * @param int $topic_id Optional. Topic id
    … …  
    24232426 * Output the row class of a topic
    24242427 *
    2425  * @since bbPress (r2667)
     2428 * @since 2.0.0 bbPress (r2667)
    24262429 *
    24272430 * @param int $topic_id Optional. Topic id
    … …  
    24352438         * Return the row class of a topic
    24362439         *
    2437          * @since bbPress (r2667)
     2440         * @since 2.0.0 bbPress (r2667)
    24382441         *
    24392442         * @param int $topic_id Optional. Topic id
    … …  
    25512554 * Output the edit link of the topic
    25522555 *
    2553  * @since bbPress (r2727)
     2556 * @since 2.0.0 bbPress (r2727)
    25542557 *
    25552558 * @param array $args See {@link bbp_get_topic_edit_link()}
    … …  
    25632566         * Return the edit link of the topic
    25642567         *
    2565          * @since bbPress (r2727)
     2568         * @since 2.0.0 bbPress (r2727)
    25662569         *
    25672570         * @param array $args This function supports these args:
    … …  
    26172620 * Output URL to the topic edit page
    26182621 *
    2619  * @since bbPress (r2753)
     2622 * @since 2.0.0 bbPress (r2753)
    26202623 *
    26212624 * @param int $topic_id Optional. Topic id
    … …  
    26282631         * Return URL to the topic edit page
    26292632         *
    2630          * @since bbPress (r2753)
     2633         * @since 2.0.0 bbPress (r2753)
    26312634         *
    26322635         * @param int $topic_id Optional. Topic id
    … …  
    26702673 * Output the trash link of the topic
    26712674 *
    2672  * @since bbPress (r2727)
     2675 * @since 2.0.0 bbPress (r2727)
    26732676 *
    26742677 * @param array $args See {@link bbp_get_topic_trash_link()}
    … …  
    26822685         * Return the trash link of the topic
    26832686         *
    2684          * @since bbPress (r2727)
     2687         * @since 2.0.0 bbPress (r2727)
    26852688         *
    26862689         * @param array $args This function supports these args:
    … …  
    27452748 * Output the close link of the topic
    27462749 *
    2747  * @since bbPress (r2727)
     2750 * @since 2.0.0 bbPress (r2727)
    27482751 *
    27492752 * @param array $args See {@link bbp_get_topic_close_link()}
    … …  
    27572760         * Return the close link of the topic
    27582761         *
    2759          * @since bbPress (r2727)
     2762         * @since 2.0.0 bbPress (r2727)
    27602763         *
    27612764         * @param array $args This function supports these args:
    … …  
    28052808 * Output the approve link of the topic
    28062809 *
    2807  * @since bbPress (r5504)
     2810 * @since 2.6.0 bbPress (r5504)
    28082811 *
    28092812 * @param array $args See {@link bbp_get_topic_approve_link()}
    … …  
    28172820         * Return the approve link of the topic
    28182821         *
    2819          * @since bbPress (r5504)
     2822         * @since 2.6.0 bbPress (r5504)
    28202823         *
    28212824         * @param array $args This function supports these args:
    … …  
    28662869 * Output the stick link of the topic
    28672870 *
    2868  * @since bbPress (r2754)
     2871 * @since 2.0.0 bbPress (r2754)
    28692872 *
    28702873 * @param array $args See {@link bbp_get_topic_stick_link()}
    … …  
    28782881         * Return the stick link of the topic
    28792882         *
    2880          * @since bbPress (r2754)
     2883         * @since 2.0.0 bbPress (r2754)
    28812884         *
    28822885         * @param array $args This function supports these args:
    … …  
    29432946 * Output the merge link of the topic
    29442947 *
    2945  * @since bbPress (r2756)
     2948 * @since 2.0.0 bbPress (r2756)
    29462949 *
    29472950 * @param array $args
    … …  
    29552958         * Return the merge link of the topic
    29562959         *
    2957          * @since bbPress (r2756)
     2960         * @since 2.0.0 bbPress (r2756)
    29582961         *
    29592962         * @param array $args This function supports these args:
    … …  
    29962999 * Output the spam link of the topic
    29973000 *
    2998  * @since bbPress (r2727)
     3001 * @since 2.0.0 bbPress (r2727)
    29993002 *
    30003003 * @param array $args See {@link bbp_get_topic_spam_link()}
    … …  
    30083011         * Return the spam link of the topic
    30093012         *
    3010          * @since bbPress (r2727)
     3013         * @since 2.0.0 bbPress (r2727)
    30113014         *
    30123015         * @param array $args This function supports these args:
    … …  
    30563059 * Output the link to go directly to the reply form
    30573060 *
    3058  * @since bbPress (r4966)
     3061 * @since 2.4.0 bbPress (r4966)
    30593062 *
    30603063 * @param array $args
    … …  
    30683071         * Return the link to go directly to the reply form
    30693072         *
    3070          * @since bbPress (r4966)
     3073         * @since 2.4.0 bbPress (r4966)
    30713074         *
    30723075         * @param array $args Arguments
    … …  
    31103113 * Output the pagination count
    31113114 *
    3112  * @since bbPress (r2519)
     3115 * @since 2.0.0 bbPress (r2519)
    31133116 *
    31143117 * @uses bbp_get_forum_pagination_count() To get the forum pagination count
    … …  
    31203123         * Return the pagination count
    31213124         *
    3122          * @since bbPress (r2519)
     3125         * @since 2.0.0 bbPress (r2519)
    31233126         *
    31243127         * @uses bbp_number_format() To format the number value
    … …  
    31573160 * Output pagination links
    31583161 *
    3159  * @since bbPress (r2519)
     3162 * @since 2.0.0 bbPress (r2519)
    31603163 *
    31613164 * @uses bbp_get_forum_pagination_links() To get the pagination links
    … …  
    31673170         * Return pagination links
    31683171         *
    3169          * @since bbPress (r2519)
     3172         * @since 2.0.0 bbPress (r2519)
    31703173         *
    31713174         * @uses bbPress::topic_query::pagination_links To get the links
    … …  
    31853188 * Displays topic notices
    31863189 *
    3187  * @since bbPress (r2744)
     3190 * @since 2.0.0 bbPress (r2744)
    31883191 *
    31893192 * @uses bbp_is_single_topic() To check if it's a topic page
    … …  
    32353238 * Displays topic type select box (normal/sticky/super sticky)
    32363239 *
    3237  * @since bbPress (r5059)
    3238  * @deprecated since bbPress (r5059)
     3240 * @since 2.0.0 bbPress (r2784)
     3241 *
     3242 * @deprecated 2.4.0 bbPress (r5059)
    32393243 *
    32403244 * @param $args This function supports these arguments:
    … …  
    32513255 * Displays topic type select box (normal/sticky/super sticky)
    32523256 *
    3253  * @since bbPress (r5059)
     3257 * @since 2.4.0 bbPress (r5059)
    32543258 *
    32553259 * @param $args This function supports these arguments:
    … …  
    32653269         * Returns topic type select box (normal/sticky/super sticky)
    32663270         *
    3267          * @since bbPress (r5059)
     3271         * @since 2.4.0 bbPress (r5059)
    32683272         *
    32693273         * @param $args This function supports these arguments:
    … …  
    33423346 * Output value topic status dropdown
    33433347 *
    3344  * @since bbPress (r5059)
     3348 * @since 2.4.0 bbPress (r5059)
    33453349 *
    33463350 * @param $args This function supports these arguments:
    … …  
    33603364         * within this function to check available topic statuses.
    33613365         *
    3362          * @since bbPress (r5059)
     3366         * @since 2.4.0 bbPress (r5059)
    33633367         *
    33643368         * @param $args This function supports these arguments:
    … …  
    34293433 * total replies, and last activity.
    34303434 *
    3431  * @since bbPress (r2860)
     3435 * @since 2.0.0 bbPress (r2860)
    34323436 *
    34333437 * @param array $args See {@link bbp_get_single_topic_description()}
    … …  
    34413445         * total replies, and last activity.
    34423446         *
    3443          * @since bbPress (r2860)
     3447         * @since 2.0.0 bbPress (r2860)
    34443448         *
    34453449         * @param array $args This function supports these arguments:
    … …  
    35133517 * Output the unique id of the topic tag taxonomy
    35143518 *
    3515  * @since bbPress (r3348)
     3519 * @since 2.0.0 bbPress (r3348)
    35163520 *
    35173521 * @uses bbp_get_topic_post_type() To get the topic post type
    … …  
    35233527         * Return the unique id of the topic tag taxonomy
    35243528         *
    3525          * @since bbPress (r3348)
     3529         * @since 2.0.0 bbPress (r3348)
    35263530         *
    35273531         * @uses apply_filters() Calls 'bbp_get_topic_tag_tax_id' with the topic tax id
    … …  
    35353539 * Return array of labels used by the topic-tag taxonomy
    35363540 *
    3537  * @since bbPress (r5129)
     3541 * @since 2.5.0 bbPress (r5129)
    35383542 *
    35393543 * @return array
    … …  
    35583562 * Return an array of topic-tag taxonomy rewrite settings
    35593563 *
    3560  * @since bbPress (r5129)
     3564 * @since 2.5.0 bbPress (r5129)
    35613565 *
    35623566 * @return array
    … …  
    35723576 * Output the id of the current tag
    35733577 *
    3574  * @since bbPress (r3109)
     3578 * @since 2.0.0 bbPress (r3109)
    35753579 *
    35763580 * @uses bbp_get_topic_tag_id()
    … …  
    35823586         * Return the id of the current tag
    35833587         *
    3584          * @since bbPress (r3109)
     3588         * @since 2.0.0 bbPress (r3109)
    35853589         *
    35863590         * @uses get_term_by()
    … …  
    36163620 * Output the name of the current tag
    36173621 *
    3618  * @since bbPress (r3109)
     3622 * @since 2.0.0 bbPress (r3109)
    36193623 *
    36203624 * @uses bbp_get_topic_tag_name()
    … …  
    36263630         * Return the name of the current tag
    36273631         *
    3628          * @since bbPress (r3109)
     3632         * @since 2.0.0 bbPress (r3109)
    36293633         *
    36303634         * @uses get_term_by()
    … …  
    36603664 * Output the slug of the current tag
    36613665 *
    3662  * @since bbPress (r3109)
     3666 * @since 2.0.0 bbPress (r3109)
    36633667 *
    36643668 * @uses bbp_get_topic_tag_slug()
    … …  
    36703674         * Return the slug of the current tag
    36713675         *
    3672          * @since bbPress (r3109)
     3676         * @since 2.0.0 bbPress (r3109)
    36733677         *
    36743678         * @uses get_term_by()
    … …  
    37043708 * Output the link of the current tag
    37053709 *
    3706  * @since bbPress (r3348)
     3710 * @since 2.0.0 bbPress (r3348)
    37073711 *
    37083712 * @uses bbp_get_topic_tag_link()
    … …  
    37143718         * Return the link of the current tag
    37153719         *
    3716          * @since bbPress (r3348)
     3720         * @since 2.0.0 bbPress (r3348)
    37173721         *
    37183722         * @uses get_term_by()
    … …  
    37483752 * Output the link of the current tag
    37493753 *
    3750  * @since bbPress (r3348)
     3754 * @since 2.0.0 bbPress (r3348)
    37513755 *
    37523756 * @uses bbp_get_topic_tag_edit_link()
    … …  
    37583762         * Return the link of the current tag
    37593763         *
    3760          * @since bbPress (r3348)
     3764         * @since 2.0.0 bbPress (r3348)
    37613765         *
    37623766         * @uses get_term_by()
    … …  
    38003804 * Output the description of the current tag
    38013805 *
    3802  * @since bbPress (r3109)
     3806 * @since 2.0.0 bbPress (r3109)
    38033807 *
    38043808 * @uses bbp_get_topic_tag_description()
    … …  
    38103814         * Return the description of the current tag
    38113815         *
    3812          * @since bbPress (r3109)
     3816         * @since 2.0.0 bbPress (r3109)
    38133817         *
    38143818         * @uses get_term_by()
    … …  
    38553859 * Output the value of topic title field
    38563860 *
    3857  * @since bbPress (r2976)
     3861 * @since 2.0.0 bbPress (r2976)
    38583862 *
    38593863 * @uses bbp_get_form_topic_title() To get the value of topic title field
    … …  
    38653869         * Return the value of topic title field
    38663870         *
    3867          * @since bbPress (r2976)
     3871         * @since 2.0.0 bbPress (r2976)
    38683872         *
    38693873         * @uses bbp_is_topic_edit() To check if it's topic edit page
    … …  
    38923896 * Output the value of topic content field
    38933897 *
    3894  * @since bbPress (r2976)
     3898 * @since 2.0.0 bbPress (r2976)
    38953899 *
    38963900 * @uses bbp_get_form_topic_content() To get value of topic content field
    … …  
    39023906         * Return the value of topic content field
    39033907         *
    3904          * @since bbPress (r2976)
     3908         * @since 2.0.0 bbPress (r2976)
    39053909         *
    39063910         * @uses bbp_is_topic_edit() To check if it's the topic edit page
    … …  
    39293933 * Allow topic rows to have adminstrative actions
    39303934 *
    3931  * @since bbPress (r3653)
     3935 * @since 2.1.0 bbPress (r3653)
     3936 *
    39323937 * @uses do_action()
    39333938 * @todo Links and filter
    … …  
    39403945 * Output value of topic tags field
    39413946 *
    3942  * @since bbPress (r2976)
     3947 * @since 2.0.0 bbPress (r2976)
     3948 *
    39433949 * @uses bbp_get_form_topic_tags() To get the value of topic tags field
    39443950 */
    … …  
    39493955         * Return value of topic tags field
    39503956         *
    3951          * @since bbPress (r2976)
     3957         * @since 2.0.0 bbPress (r2976)
    39523958         *
    39533959         * @uses bbp_is_topic_edit() To check if it's the topic edit page
    … …  
    40044010 * Output value of topic forum
    40054011 *
    4006  * @since bbPress (r2976)
     4012 * @since 2.0.0 bbPress (r2976)
    40074013 *
    40084014 * @uses bbp_get_form_topic_forum() To get the topic's forum id
    … …  
    40144020         * Return value of topic forum
    40154021         *
    4016          * @since bbPress (r2976)
     4022         * @since 2.0.0 bbPress (r2976)
    40174023         *
    40184024         * @uses bbp_is_topic_edit() To check if it's the topic edit page
    … …  
    40424048 * Output checked value of topic subscription
    40434049 *
    4044  * @since bbPress (r2976)
     4050 * @since 2.0.0 bbPress (r2976)
    40454051 *
    40464052 * @uses bbp_get_form_topic_subscribed() To get the subscribed checkbox value
    … …  
    40524058         * Return checked value of topic subscription
    40534059         *
    4054          * @since bbPress (r2976)
     4060         * @since 2.0.0 bbPress (r2976)
    40554061         *
    40564062         * @uses bbp_is_topic_edit() To check if it's the topic edit page
    … …  
    41004106 * Output checked value of topic log edit field
    41014107 *
    4102  * @since bbPress (r2976)
     4108 * @since 2.0.0 bbPress (r2976)
    41034109 *
    41044110 * @uses bbp_get_form_topic_log_edit() To get the topic log edit value
    … …  
    41104116         * Return checked value of topic log edit field
    41114117         *
    4112          * @since bbPress (r2976)
     4118         * @since 2.0.0 bbPress (r2976)
    41134119         *
    41144120         * @uses apply_filters() Calls 'bbp_get_form_topic_log_edit' with the
    … …  
    41364142 * Output the value of the topic edit reason
    41374143 *
    4138  * @since bbPress (r2976)
     4144 * @since 2.0.0 bbPress (r2976)
    41394145 *
    41404146 * @uses bbp_get_form_topic_edit_reason() To get the topic edit reason value
    … …  
    41464152         * Return the value of the topic edit reason
    41474153         *
    4148          * @since bbPress (r2976)
     4154         * @since 2.0.0 bbPress (r2976)
    41494155         *
    41504156         * @uses apply_filters() Calls 'bbp_get_form_topic_edit_reason' with the
    … …  
    41744180 * @see bbp_topic_form_fields()
    41754181 *
    4176  * @since bbPress (r5558)
     4182 * @since 2.6.0 bbPress (r5558)
     4183 *
    41774184 * @return boolean True if is a post request with valid nonce
    41784185 */
Note: See TracChangeset for help on using the changeset viewer.