Skip to:
Content

bbPress.org


Ignore:
Timestamp:
12/05/2025 02:27:53 AM (6 months ago)
Author:
johnjamesjacoby
Message:

Tools - Code Improvement: docs & code formatting improvements.

Props johnjamesjacoby, noruzzaman.

Fixes #3659.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/includes/replies/template.php

    r7379 r7380  
    22
    33/**
    4  * bbPress Reply Template Tags
     4 * bbPress Reply Template Tags.
    55 *
    66 * @package bbPress
    … …  
    1414
    1515/**
    16  * Return the unique id of the custom post type for replies
     16 * Return the unique id of the custom post type for replies.
    1717 *
    1818 * @since 2.0.0 bbPress (r2857)
    … …  
    2424
    2525/**
    26  * Return the unique id of the custom post type for replies
     26 * Return the unique id of the custom post type for replies.
    2727 *
    2828 * @since 2.0.0 bbPress (r2857)
    2929 *
    30  *                        post type id
    31  * @return string The unique reply post type id
     30 * @return string The unique reply post type id.
    3231 */
    3332function bbp_get_reply_post_type() {
    … …  
    3837
    3938/**
    40  * Return array of labels used by the reply post type
     39 * Return array of labels used by the reply post type.
    4140 *
    4241 * @since 2.5.0 bbPress (r5129)
    … …  
    8786
    8887/**
    89  * Return array of reply post type rewrite settings
     88 * Return array of reply post type rewrite settings.
    9089 *
    9190 * @since 2.5.0 bbPress (r5129)
    … …  
    106105
    107106/**
    108  * Return array of features the reply post type supports
     107 * Return array of features the reply post type supports.
    109108 *
    110109 * @since 2.5.0 bbPress (r5129)
    … …  
    128127
    129128/**
    130  * The main reply loop. WordPress makes this easy for us
     129 * The main reply loop. WordPress makes this easy for us.
    131130 *
    132131 * @since 2.0.0 bbPress (r2553)
    133132 *
    134  * @param array $args All the arguments supported by {@link WP_Query}
    135  * @return object Multidimensional array of reply information
     133 * @param array $args All the arguments supported by {@link WP_Query}.
     134 * @return object Multidimensional array of reply information.
    136135 */
    137136function bbp_has_replies( $args = array() ) {
    … …  
    275274
    276275/**
    277  * Whether there are more replies available in the loop
     276 * Whether there are more replies available in the loop.
    278277 *
    279278 * @since 2.0.0 bbPress (r2553)
    280279 *
    281  * @return object Replies information
     280 * @return object Replies information.
    282281 */
    283282function bbp_replies() {
    … …  
    295294
    296295/**
    297  * Loads up the current reply in the loop
     296 * Loads up the current reply in the loop.
    298297 *
    299298 * @since 2.0.0 bbPress (r2553)
    300299 *
    301  * @return object Reply information
     300 * @return object Reply information.
    302301 */
    303302function bbp_the_reply() {
    … …  
    306305
    307306/**
    308  * Output reply id
     307 * Output reply id.
    309308 *
    310309 * @since 2.0.0 bbPress (r2553)
    311310 *
    312  * @param $reply_id Optional. Used to check emptiness
     311 * @param $reply_id Optional. Used to check emptiness.
    313312 */
    314313function bbp_reply_id( $reply_id = 0 ) {
    … …  
    317316
    318317/**
    319  * Return the id of the reply in a replies loop
     318 * Return the id of the reply in a replies loop.
    320319 *
    321320 * @since 2.0.0 bbPress (r2553)
    322321 *
    323  * @param $reply_id Optional. Used to check emptiness
    324  * @return int The reply id
     322 * @param $reply_id Optional. Used to check emptiness.
     323 * @return int The reply id.
    325324 */
    326325function bbp_get_reply_id( $reply_id = 0 ) {
    … …  
    358357
    359358/**
    360  * Gets a reply
     359 * Gets a reply.
    361360 *
    362361 * @since 2.0.0 bbPress (r2787)
    363362 *
    364  * @param int|object $reply reply id or reply object
    365  * @param string $output Optional. OBJECT, ARRAY_A, or ARRAY_N. Default = OBJECT
    366  * @param string $filter Optional Sanitation filter. See {@link sanitize_post()}
    367  * @return mixed Null if error or reply (in specified form) if success
     363 * @param int|object $reply reply id or reply object.
     364 * @param string $output Optional. OBJECT, ARRAY_A, or ARRAY_N. Default = OBJECT.
     365 * @param string $filter Optional Sanitation filter. See {@link sanitize_post()}.
     366 * @return mixed Null if error or reply (in specified form) if success.
    368367 */
    369368function bbp_get_reply( $reply, $output = OBJECT, $filter = 'raw' ) {
    … …  
    402401
    403402/**
    404  * Output the link to the reply in the reply loop
     403 * Output the link to the reply in the reply loop.
    405404 *
    406405 * @since 2.0.0 bbPress (r2553)
    407406 *
    408  * @param int $reply_id Optional. Reply id
     407 * @param int $reply_id Optional. Reply id.
    409408 */
    410409function bbp_reply_permalink( $reply_id = 0 ) {
    … …  
    413412
    414413/**
    415  * Return the link to the reply
     414 * Return the link to the reply.
    416415 *
    417416 * @since 2.0.0 bbPress (r2553)
    418417 *
    419  * @param int $reply_id Optional. Reply id
    420  *
    421  * @return string Permanent link to reply
     418 * @param int $reply_id Optional. Reply id.
     419 *
     420 * @return string Permanent link to reply.
    422421 */
    423422function bbp_get_reply_permalink( $reply_id = 0 ) {
    … …  
    429428
    430429/**
    431  * Output the paginated url to the reply in the reply loop
     430 * Output the paginated url to the reply in the reply loop.
    432431 *
    433432 * @since 2.0.0 bbPress (r2679)
    434433 *
    435  * @param int $reply_id Optional. Reply id
     434 * @param int $reply_id Optional. Reply id.
    436435 */
    437436function bbp_reply_url( $reply_id = 0 ) {
    … …  
    440439
    441440/**
    442  * Return the paginated url to the reply in the reply loop
     441 * Return the paginated url to the reply in the reply loop.
    443442 *
    444443 * @since 2.0.0 bbPress (r2679)
    445444 *
    446  * @param int $reply_id Optional. Reply id
     445 * @param int $reply_id Optional. Reply id.
    447446 * @param string $redirect_to Optional. Pass a redirect value for use with
    448447 *                              shortcodes and other fun things.
    449  * @return string Link to reply relative to paginated topic
     448 * @return string Link to reply relative to paginated topic.
    450449 */
    451450function bbp_get_reply_url( $reply_id = 0, $redirect_to = '' ) {
    … …  
    521520
    522521/**
    523  * Output the title of the reply
     522 * Output the title of the reply.
    524523 *
    525524 * @since 2.0.0 bbPress (r2553)
    526525 *
    527  * @param int $reply_id Optional. Reply id
     526 * @param int $reply_id Optional. Reply id.
    528527 */
    529528function bbp_reply_title( $reply_id = 0 ) {
    … …  
    532531
    533532/**
    534  * Return the title of the reply
     533 * Return the title of the reply.
    535534 *
    536535 * @since 2.0.0 bbPress (r2553)
    537536 *
    538  * @param int $reply_id Optional. Reply id
    539  * @return string Title of reply
     537 * @param int $reply_id Optional. Reply id.
     538 * @return string Title of reply.
    540539 */
    541540function bbp_get_reply_title( $reply_id = 0 ) {
    … …  
    553552 * @since 2.5.0 bbPress (r5177)
    554553 *
    555  * @param string $post_title Required. Reply Title
    556  * @param int $post_id Required. Reply ID
    557  * @return string Title of reply
     554 * @param string $post_title Required. Reply Title.
     555 * @param int $post_id Required. Reply ID.
     556 * @return string Title of reply.
    558557 */
    559558function bbp_get_reply_title_fallback( $post_title = '', $post_id = 0 ) {
    … …  
    579578
    580579/**
    581  * Output the content of the reply
     580 * Output the content of the reply.
    582581 *
    583582 * @since 2.0.0 bbPress (r2553)
    584583 *
    585  * @param int $reply_id Optional. reply id
     584 * @param int $reply_id Optional. reply id.
    586585 */
    587586function bbp_reply_content( $reply_id = 0 ) {
    … …  
    590589
    591590/**
    592  * Return the content of the reply
     591 * Return the content of the reply.
    593592 *
    594593 * @since 2.0.0 bbPress (r2780)
    595594 *
    596  * @param int $reply_id Optional. reply id
    597  * @return string Content of the reply
     595 * @param int $reply_id Optional. reply id.
     596 * @return string Content of the reply.
    598597 */
    599598function bbp_get_reply_content( $reply_id = 0 ) {
    … …  
    612611
    613612/**
    614  * Output the excerpt of the reply
     613 * Output the excerpt of the reply.
    615614 *
    616615 * @since 2.0.0 bbPress (r2751)
    617616 *
    618  * @param int $reply_id Optional. Reply id
    619  * @param int $length Optional. Length of the excerpt. Defaults to 100 letters
     617 * @param int $reply_id Optional. Reply id.
     618 * @param int $length Optional. Length of the excerpt. Defaults to 100 letters.
    620619 */
    621620function bbp_reply_excerpt( $reply_id = 0, $length = 100 ) {
    … …  
    624623
    625624/**
    626  * Return the excerpt of the reply
     625 * Return the excerpt of the reply.
    627626 *
    628627 * @since 2.0.0 bbPress (r2751)
    629628 *
    630  * @param int $reply_id Optional. Reply id
     629 * @param int $reply_id Optional. Reply id.
    631630 * @param int $length Optional. Length of the excerpt. Defaults to 100
    632  *                     letters
    633  * @return string Reply Excerpt
     631 *                     letters.
     632 * @return string Reply Excerpt.
    634633 */
    635634function bbp_get_reply_excerpt( $reply_id = 0, $length = 100 ) {
    … …  
    661660
    662661/**
    663  * Output the post date and time of a reply
     662 * Output the post date and time of a reply.
    664663 *
    665664 * @since 2.2.0 bbPress (r4155)
    666665 *
    667666 * @param int $reply_id Optional. Reply id.
    668  * @param bool $humanize Optional. Humanize output using time_since
    669  * @param bool $gmt Optional. Use GMT
     667 * @param bool $humanize Optional. Humanize output using time_since.
     668 * @param bool $gmt Optional. Use GMT.
    670669 */
    671670function bbp_reply_post_date( $reply_id = 0, $humanize = false, $gmt = false ) {
    … …  
    674673
    675674/**
    676  * Return the post date and time of a reply
     675 * Return the post date and time of a reply.
    677676 *
    678677 * @since 2.2.0 bbPress (r4155)
    679678 *
    680679 * @param int $reply_id Optional. Reply id.
    681  * @param bool $humanize Optional. Humanize output using time_since
    682  * @param bool $gmt Optional. Use GMT
     680 * @param bool $humanize Optional. Humanize output using time_since.
     681 * @param bool $gmt Optional. Use GMT.
    683682 * @return string
    684683 */
    … …  
    706705
    707706/**
    708  * Append revisions to the reply content
     707 * Append revisions to the reply content.
    709708 *
    710709 * @since 2.0.0 bbPress (r2782)
    711710 *
    712  * @param string $content Optional. Content to which we need to append the revisions to
    713  * @param int $reply_id Optional. Reply id
    714  * @return string Content with the revisions appended
     711 * @param string $content Optional. Content to which we need to append the revisions to.
     712 * @param int $reply_id Optional. Reply id.
     713 * @return string Content with the revisions appended.
    715714 */
    716715function bbp_reply_content_append_revisions( $content = '', $reply_id = 0 ) {
    … …  
    729728
    730729/**
    731  * Output the revision log of the reply
     730 * Output the revision log of the reply.
    732731 *
    733732 * @since 2.0.0 bbPress (r2782)
    734733 *
    735  * @param int $reply_id Optional. Reply id
     734 * @param int $reply_id Optional. Reply id.
    736735 */
    737736function bbp_reply_revision_log( $reply_id = 0 ) {
    … …  
    740739
    741740/**
    742  * Return the formatted revision log of the reply
     741 * Return the formatted revision log of the reply.
    743742 *
    744743 * @since 2.0.0 bbPress (r2782)
    745744 *
    746  * @param int $reply_id Optional. Reply id
    747  * @return string Revision log of the reply
     745 * @param int $reply_id Optional. Reply id.
     746 * @return string Revision log of the reply.
    748747 */
    749748function bbp_get_reply_revision_log( $reply_id = 0 ) {
    … …  
    812811
    813812/**
    814  * Return the raw revision log of the reply
     813 * Return the raw revision log of the reply.
    815814 *
    816815 * @since 2.0.0 bbPress (r2782)
    817816 *
    818  * @param int $reply_id Optional. Reply id
    819  * @return string Raw revision log of the reply
     817 * @param int $reply_id Optional. Reply id.
     818 * @return string Raw revision log of the reply.
    820819 */
    821820function bbp_get_reply_raw_revision_log( $reply_id = 0 ) {
    … …  
    831830
    832831/**
    833  * Return the revisions of the reply
     832 * Return the revisions of the reply.
    834833 *
    835834 * @since 2.0.0 bbPress (r2782)
    836835 *
    837  * @param int $reply_id Optional. Reply id
    838  * @return WP_Post[]|int[] reply revisions
     836 * @param int $reply_id Optional. Reply id.
     837 * @return WP_Post[]|int[] reply revisions.
    839838 */
    840839function bbp_get_reply_revisions( $reply_id = 0 ) {
    … …  
    847846
    848847/**
    849  * Return the revision count of the reply
     848 * Return the revision count of the reply.
    850849 *
    851850 * @since 2.0.0 bbPress (r2782)
    852851 *
    853  * @param int $reply_id Optional. Reply id
    854  * @param boolean $integer Optional. Whether or not to format the result
    855  * @return string reply revision count
     852 * @param int $reply_id Optional. Reply id.
     853 * @param boolean $integer Optional. Whether or not to format the result.
     854 * @return string reply revision count.
    856855 */
    857856function bbp_get_reply_revision_count( $reply_id = 0, $integer = false ) {
    … …  
    866865
    867866/**
    868  * Output the status of the reply
     867 * Output the status of the reply.
    869868 *
    870869 * @since 2.0.0 bbPress (r2667)
    871870 *
    872  * @param int $reply_id Optional. Reply id
     871 * @param int $reply_id Optional. Reply id.
    873872 */
    874873function bbp_reply_status( $reply_id = 0 ) {
    … …  
    877876
    878877/**
    879  * Return the status of the reply
     878 * Return the status of the reply.
    880879 *
    881880 * @since 2.0.0 bbPress (r2667)
    882881 *
    883  * @param int $reply_id Optional. Reply id
    884  * @return string Status of reply
     882 * @param int $reply_id Optional. Reply id.
     883 * @return string Status of reply.
    885884 */
    886885function bbp_get_reply_status( $reply_id = 0 ) {
    … …  
    898897 * @since 2.6.0 bbPress (r6391)
    899898 *
    900  * @param int $reply_id Optional. Reply id
     899 * @param int $reply_id Optional. Reply id.
    901900 * @return bool True if public, false if not.
    902901 */
    … …  
    917916 * @since 2.6.0 bbPress (r6922) Returns false if topic is also not published
    918917 *
    919  * @param int $reply_id Optional. Topic id
     918 * @param int $reply_id Optional. Topic id.
    920919 * @return bool True if published, false if not.
    921920 */
    … …  
    937936 * @since 2.0.0 bbPress (r2740)
    938937 *
    939  * @param int $reply_id Optional. Reply id
     938 * @param int $reply_id Optional. Reply id.
    940939 * @return bool True if spam, false if not.
    941940 */
    … …  
    954953 * @since 2.0.0 bbPress (r2884)
    955954 *
    956  * @param int $reply_id Optional. Topic id
     955 * @param int $reply_id Optional. Topic id.
    957956 * @return bool True if spam, false if not.
    958957 */
    … …  
    971970 * @since 2.6.0 bbPress (r5507)
    972971 *
    973  * @param int $reply_id Optional. Topic id
     972 * @param int $reply_id Optional. Topic id.
    974973 * @return bool True if pending, false if not.
    975974 */
    … …  
    988987 * @since 2.6.0 bbPress (r5507)
    989988 *
    990  * @param int $reply_id Optional. Topic id
     989 * @param int $reply_id Optional. Topic id.
    991990 * @return bool True if private, false if not.
    992991 */
    … …  
    10051004 * @since 2.0.0 bbPress (r2753)
    10061005 *
    1007  * @param int $reply_id Optional. Reply id
     1006 * @param int $reply_id Optional. Reply id.
    10081007 * @return bool True if the post is by an anonymous user, false if not.
    10091008 */
    … …  
    10291028 * Deprecated. Use bbp_reply_author_display_name() instead.
    10301029 *
    1031  * Output the author of the reply
     1030 * Output the author of the reply.
    10321031 *
    10331032 * @since 2.0.0 bbPress (r2667)
    … …  
    10351034 * @deprecated 2.5.0 bbPress (r5119)
    10361035 *
    1037  * @param int $reply_id Optional. Reply id
     1036 * @param int $reply_id Optional. Reply id.
    10381037 */
    10391038function bbp_reply_author( $reply_id = 0 ) {
    … …  
    10441043 * Deprecated. Use bbp_get_reply_author_display_name() instead.
    10451044 *
    1046  * Return the author of the reply
     1045 * Return the author of the reply.
    10471046 *
    10481047 * @since 2.0.0 bbPress (r2667)
    … …  
    10501049 * @deprecated 2.5.0 bbPress (r5119)
    10511050 *
    1052  * @param int $reply_id Optional. Reply id
    1053  * @return string Author of reply
     1051 * @param int $reply_id Optional. Reply id.
     1052 * @return string Author of reply.
    10541053 */
    10551054function bbp_get_reply_author( $reply_id = 0 ) {
    … …  
    10671066
    10681067/**
    1069  * Output the author ID of the reply
     1068 * Output the author ID of the reply.
    10701069 *
    10711070 * @since 2.0.0 bbPress (r2667)
    10721071 *
    1073  * @param int $reply_id Optional. Reply id
     1072 * @param int $reply_id Optional. Reply id.
    10741073 */
    10751074function bbp_reply_author_id( $reply_id = 0 ) {
    … …  
    10781077
    10791078/**
    1080  * Return the author ID of the reply
     1079 * Return the author ID of the reply.
    10811080 *
    10821081 * @since 2.0.0 bbPress (r2667)
    10831082 *
    1084  * @param int $reply_id Optional. Reply id
    1085  * @return string Author id of reply
     1083 * @param int $reply_id Optional. Reply id.
     1084 * @return string Author id of reply.
    10861085 */
    10871086function bbp_get_reply_author_id( $reply_id = 0 ) {
    … …  
    10941093
    10951094/**
    1096  * Output the author display_name of the reply
     1095 * Output the author display_name of the reply.
    10971096 *
    10981097 * @since 2.0.0 bbPress (r2667)
    10991098 *
    1100  * @param int $reply_id Optional. Reply id
     1099 * @param int $reply_id Optional. Reply id.
    11011100 */
    11021101function bbp_reply_author_display_name( $reply_id = 0 ) {
    … …  
    11051104
    11061105/**
    1107  * Return the author display_name of the reply
     1106 * Return the author display_name of the reply.
    11081107 *
    11091108 * @since 2.0.0 bbPress (r2667)
    11101109 *
    1111  * @param int $reply_id Optional. Reply id
    1112  * @return string The display name of the author of the reply
     1110 * @param int $reply_id Optional. Reply id.
     1111 * @return string The display name of the author of the reply.
    11131112 */
    11141113function bbp_get_reply_author_display_name( $reply_id = 0 ) {
    … …  
    11441143
    11451144/**
    1146  * Output the author avatar of the reply
     1145 * Output the author avatar of the reply.
    11471146 *
    11481147 * @since 2.0.0 bbPress (r2667)
    11491148 *
    1150  * @param int $reply_id Optional. Reply id
    1151  * @param int $size Optional. Size of the avatar. Defaults to 40
     1149 * @param int $reply_id Optional. Reply id.
     1150 * @param int $size Optional. Size of the avatar. Defaults to 40.
    11521151 */
    11531152function bbp_reply_author_avatar( $reply_id = 0, $size = 40 ) {
    … …  
    11561155
    11571156/**
    1158  * Return the author avatar of the reply
     1157 * Return the author avatar of the reply.
    11591158 *
    11601159 * @since 2.0.0 bbPress (r2667)
    11611160 *
    11621161 * @param int $reply_id Optional. Reply id
    1163  * @param int $size Optional. Size of the avatar. Defaults to 40
    1164  * @return string Avatar of author of the reply
     1162 * @param int $size Optional. Size of the avatar. Defaults to 40.
     1163 * @return string Avatar of author of the reply.
    11651164 */
    11661165function bbp_get_reply_author_avatar( $reply_id = 0, $size = 40 ) {
    … …  
    11841183
    11851184/**
    1186  * Output the author link of the reply
     1185 * Output the author link of the reply.
    11871186 *
    11881187 * @since 2.0.0 bbPress (r2717)
    … …  
    11951194
    11961195/**
    1197  * Return the author link of the reply
     1196 * Return the author link of the reply.
    11981197 *
    11991198 * @since 2.0.0 bbPress (r2717)
    12001199 *
    12011200 * @param array $args Optional. If an integer, it is used as reply id.
    1202  * @return string Author link of reply
     1201 * @return string Author link of reply.
    12031202 */
    12041203function bbp_get_reply_author_link( $args = array() ) {
    … …  
    13011300
    13021301/**
    1303  * Output the author url of the reply
     1302 * Output the author url of the reply.
    13041303 *
    13051304 * @since 2.0.0 bbPress (r2667)
    13061305 *
    1307  * @param int $reply_id Optional. Reply id
     1306 * @param int $reply_id Optional. Reply id.
    13081307 */
    13091308function bbp_reply_author_url( $reply_id = 0 ) {
    … …  
    13121311
    13131312/**
    1314  * Return the author url of the reply
     1313 * Return the author url of the reply.
    13151314 *
    13161315 * @since 2.0.0 bbPress (r2667)
    13171316 *
    1318  * @param int $reply_id Optional. Reply id
    1319  * @return string Author URL of the reply
     1317 * @param int $reply_id Optional. Reply id.
     1318 * @return string Author URL of the reply.
    13201319 */
    13211320function bbp_get_reply_author_url( $reply_id = 0 ) {
    … …  
    13381337
    13391338/**
    1340  * Output the reply author email address
     1339 * Output the reply author email address.
    13411340 *
    13421341 * @since 2.0.0 bbPress (r3445)
    13431342 *
    1344  * @param int $reply_id Optional. Reply id
     1343 * @param int $reply_id Optional. Reply id.
    13451344 */
    13461345function bbp_reply_author_email( $reply_id = 0 ) {
    … …  
    13491348
    13501349/**
    1351  * Return the reply author email address
     1350 * Return the reply author email address.
    13521351 *
    13531352 * @since 2.0.0 bbPress (r3445)
    13541353 *
    1355  * @param int $reply_id Optional. Reply id
    1356  * @return string Reply author email address
     1354 * @param int $reply_id Optional. Reply id.
     1355 * @return string Reply author email address.
    13571356 */
    13581357function bbp_get_reply_author_email( $reply_id = 0 ) {
    … …  
    13841383
    13851384/**
    1386  * Output the reply author role
     1385 * Output the reply author role.
    13871386 *
    13881387 * @since 2.1.0 bbPress (r3860)
    … …  
    13951394
    13961395/**
    1397  * Return the reply author role
     1396 * Return the reply author role.
    13981397 *
    13991398 * @since 2.1.0 bbPress (r3860)
    14001399 *
    14011400 * @param array $args Optional.
    1402  * @return string Reply author role
     1401 * @return string Reply author role.
    14031402 */
    14041403function bbp_get_reply_author_role( $args = array() ) {
    … …  
    14401439
    14411440/**
    1442  * Output the topic title a reply belongs to
     1441 * Output the topic title a reply belongs to.
    14431442 *
    14441443 * @since 2.0.0 bbPress (r2553)
    14451444 *
    1446  * @param int $reply_id Optional. Reply id
     1445 * @param int $reply_id Optional. Reply id.
    14471446 */
    14481447function bbp_reply_topic_title( $reply_id = 0 ) {
    … …  
    14511450
    14521451/**
    1453  * Return the topic title a reply belongs to
     1452 * Return the topic title a reply belongs to.
    14541453 *
    14551454 * @since 2.0.0 bbPress (r2553)
    14561455 *
    1457  * @param int $reply_id Optional. Reply id
    1458  * @return string The topic title of the reply
     1456 * @param int $reply_id Optional. Reply id.
     1457 * @return string The topic title of the reply.
    14591458 */
    14601459function bbp_get_reply_topic_title( $reply_id = 0 ) {
    … …  
    14681467
    14691468/**
    1470  * Output the topic id a reply belongs to
     1469 * Output the topic id a reply belongs to.
    14711470 *
    14721471 * @since 2.0.0 bbPress (r2553)
    14731472 *
    1474  * @param int $reply_id Optional. Reply id
     1473 * @param int $reply_id Optional. Reply id.
    14751474 */
    14761475function bbp_reply_topic_id( $reply_id = 0 ) {
    … …  
    14791478
    14801479/**
    1481  * Return the topic id a reply belongs to
     1480 * Return the topic id a reply belongs to.
    14821481 *
    14831482 * @since 2.0.0 bbPress (r2553)
    14841483 *
    1485  * @param int $reply_id Optional. Reply id
    1486  * @return int The topic id of the reply
     1484 * @param int $reply_id Optional. Reply id.
     1485 * @return int The topic id of the reply.
    14871486 */
    14881487function bbp_get_reply_topic_id( $reply_id = 0 ) {
    … …  
    15051504
    15061505/**
    1507  * Output the forum id a reply belongs to
     1506 * Output the forum id a reply belongs to.
    15081507 *
    15091508 * @since 2.0.0 bbPress (r2679)
    15101509 *
    1511  * @param int $reply_id Optional. Reply id
     1510 * @param int $reply_id Optional. Reply id.
    15121511 */
    15131512function bbp_reply_forum_id( $reply_id = 0 ) {
    … …  
    15161515
    15171516/**
    1518  * Return the forum id a reply belongs to
     1517 * Return the forum id a reply belongs to.
    15191518 *
    15201519 * @since 2.0.0 bbPress (r2679)
    15211520 *
    1522  * @param int $reply_id Optional. Reply id
    1523  *
    1524  * @return int The forum id of the reply
     1521 * @param int $reply_id Optional. Reply id.
     1522 *
     1523 * @return int The forum id of the reply.
    15251524 */
    15261525function bbp_get_reply_forum_id( $reply_id = 0 ) {
    … …  
    15441543
    15451544/**
    1546  * Output the ancestor reply id of a reply
     1545 * Output the ancestor reply id of a reply.
    15471546 *
    15481547 * @since 2.4.0 bbPress (r4944)
    15491548 *
    1550  * @param int $reply_id Optional. Reply id
     1549 * @param int $reply_id Optional. Reply id.
    15511550 */
    15521551function bbp_reply_ancestor_id( $reply_id = 0 ) {
    … …  
    15551554
    15561555/**
    1557  * Return the ancestor reply id of a reply
     1556 * Return the ancestor reply id of a reply.
    15581557 *
    15591558 * @since 2.4.0 bbPress (r4944)
    15601559 *
    1561  * @param in $reply_id Reply id
     1560 * @param in $reply_id Reply id.
    15621561 */
    15631562function bbp_get_reply_ancestor_id( $reply_id = 0 ) {
    … …  
    15851584
    15861585/**
    1587  * Output the reply to id of a reply
     1586 * Output the reply to id of a reply.
    15881587 *
    15891588 * @since 2.4.0 bbPress (r4944)
    15901589 *
    1591  * @param int $reply_id Optional. Reply id
     1590 * @param int $reply_id Optional. Reply id.
    15921591 */
    15931592function bbp_reply_to( $reply_id = 0 ) {
    … …  
    15961595
    15971596/**
    1598  * Return the reply to id of a reply
     1597 * Return the reply to id of a reply.
    15991598 *
    16001599 * @since 2.4.0 bbPress (r4944)
    16011600 *
    1602  * @param int $reply_id Optional. Reply id
    1603  * @return int The parent reply id of the reply
     1601 * @param int $reply_id Optional. Reply id.
     1602 * @return int The parent reply id of the reply.
    16041603 */
    16051604function bbp_get_reply_to( $reply_id = 0 ) {
    … …  
    16211620
    16221621/**
    1623  * Output the link for the reply to
     1622 * Output the link for the reply to.
    16241623 *
    16251624 * @since 2.4.0 bbPress (r4944)
    … …  
    16321631
    16331632/**
    1634  * Return the link for a reply to a reply
     1633 * Return the link for a reply to a reply.
    16351634 *
    16361635 * @since 2.4.0 bbPress (r4944)
    16371636 *
    1638  * @param array $args Arguments
    1639  * @return string Link for a reply to a reply
     1637 * @param array $args Arguments.
     1638 * @return string Link for a reply to a reply.
    16401639 */
    16411640function bbp_get_reply_to_link( $args = array() ) {
    … …  
    17001699
    17011700/**
    1702  * Output the reply to a reply cancellation link
     1701 * Output the reply to a reply cancellation link.
    17031702 *
    17041703 * @since 2.4.0 bbPress (r4944)
    … …  
    17091708
    17101709/**
    1711  * Return the cancellation link for a reply to a reply
     1710 * Return the cancellation link for a reply to a reply.
    17121711 *
    17131712 * @since 2.4.0 bbPress (r4944)
    17141713 *
    1715  * @param string $text The cancel text
    1716  * @return string The cancellation link
     1714 * @param string $text The cancel text.
     1715 * @return string The cancellation link.
    17171716 */
    17181717function bbp_get_cancel_reply_to_link( $text = '' ) {
    … …  
    17431742
    17441743/**
    1745  * Output the numeric position of a reply within a topic
     1744 * Output the numeric position of a reply within a topic.
    17461745 *
    17471746 * @since 2.0.0 bbPress (r2984)
    17481747 *
    1749  * @param int $reply_id Optional. Reply id
    1750  * @param int $topic_id Optional. Topic id
     1748 * @param int $reply_id Optional. Reply id.
     1749 * @param int $topic_id Optional. Topic id.
    17511750 */
    17521751function bbp_reply_position( $reply_id = 0, $topic_id = 0 ) {
    … …  
    17551754
    17561755/**
    1757  * Return the numeric position of a reply within a topic
     1756 * Return the numeric position of a reply within a topic.
    17581757 *
    17591758 * @since 2.0.0 bbPress (r2984)
    17601759 *
    1761  * @param int $reply_id Optional. Reply id
    1762  * @param int $topic_id Optional. Topic id
    1763  * @return int Reply position
     1760 * @param int $reply_id Optional. Reply id.
     1761 * @param int $topic_id Optional. Topic id.
     1762 * @return int Reply position.
    17641763 */
    17651764function bbp_get_reply_position( $reply_id = 0, $topic_id = 0 ) {
    … …  
    18051804
    18061805/**
    1807  * Output admin links for reply
     1806 * Output admin links for reply.
    18081807 *
    18091808 * @since 2.0.0 bbPress (r2667)
    … …  
    18161815
    18171816/**
    1818  * Return admin links for reply
     1817 * Return admin links for reply.
    18191818 *
    18201819 * @since 2.0.0 bbPress (r2667)
    … …  
    18281827 *  - links: Array of the links to display. By default, edit, trash,
    18291828 *            spam, reply move, and topic split links are displayed
    1830  * @return string Reply admin links
     1829 * @return string Reply admin links.
    18311830 */
    18321831function bbp_get_reply_admin_links( $args = array() ) {
    … …  
    19021901
    19031902/**
    1904  * Output the edit link of the reply
     1903 * Output the edit link of the reply.
    19051904 *
    19061905 * @since 2.0.0 bbPress (r2740)
    19071906 *
    1908  * @param array $args See {@link bbp_get_reply_edit_link()}
     1907 * @param array $args See {@link bbp_get_reply_edit_link()}.
    19091908 */
    19101909function bbp_reply_edit_link( $args = array() ) {
    … …  
    19131912
    19141913/**
    1915  * Return the edit link of the reply
     1914 * Return the edit link of the reply.
    19161915 *
    19171916 * @since 2.0.0 bbPress (r2740)
    … …  
    19221921 *  - link_after: HTML after the link
    19231922 *  - edit_text: Edit text. Defaults to 'Edit'
    1924  * @return string Reply edit link
     1923 * @return string Reply edit link.
    19251924 */
    19261925function bbp_get_reply_edit_link( $args = array() ) {
    … …  
    19651964
    19661965/**
    1967  * Output URL to the reply edit page
     1966 * Output URL to the reply edit page.
    19681967 *
    19691968 * @since 2.0.0 bbPress (r2753)
    19701969 *
    1971  * @param int $reply_id Optional. Reply id
     1970 * @param int $reply_id Optional. Reply id.
    19721971 */
    19731972function bbp_reply_edit_url( $reply_id = 0 ) {
    … …  
    19761975
    19771976/**
    1978  * Return URL to the reply edit page
     1977 * Return URL to the reply edit page.
    19791978 *
    19801979 * @since 2.0.0 bbPress (r2753)
    19811980 *
    1982  * @param int $reply_id Optional. Reply id
    1983  * @return string Reply edit url
     1981 * @param int $reply_id Optional. Reply id.
     1982 * @return string Reply edit url.
    19841983 */
    19851984function bbp_get_reply_edit_url( $reply_id = 0 ) {
    … …  
    20182017
    20192018/**
    2020  * Output the trash link of the reply
     2019 * Output the trash link of the reply.
    20212020 *
    20222021 * @since 2.0.0 bbPress (r2740)
    20232022 *
    2024  * @param array $args See {@link bbp_get_reply_trash_link()}
     2023 * @param array $args See {@link bbp_get_reply_trash_link()}.
    20252024 */
    20262025function bbp_reply_trash_link( $args = array() ) {
    … …  
    20292028
    20302029/**
    2031  * Return the trash link of the reply
     2030 * Return the trash link of the reply.
    20322031 *
    20332032 * @since 2.0.0 bbPress (r2740)
    … …  
    20412040 *  - restore_text: Restore text
    20422041 *  - delete_text: Delete text
    2043  * @return string Reply trash link
     2042 * @return string Reply trash link.
    20442043 */
    20452044function bbp_get_reply_trash_link( $args = array() ) {
    … …  
    21082107
    21092108/**
    2110  * Output the spam link of the reply
     2109 * Output the spam link of the reply.
    21112110 *
    21122111 * @since 2.0.0 bbPress (r2740)
    21132112 *
    2114  * @param array $args See {@link bbp_get_reply_spam_link()}
     2113 * @param array $args See {@link bbp_get_reply_spam_link()}.
    21152114 */
    21162115function bbp_reply_spam_link( $args = array() ) {
    … …  
    21192118
    21202119/**
    2121  * Return the spam link of the reply
     2120 * Return the spam link of the reply.
    21222121 *
    21232122 * @since 2.0.0 bbPress (r2740)
    … …  
    21292128 *  - spam_text: Spam text
    21302129 *  - unspam_text: Unspam text
    2131  * @return string Reply spam link
     2130 * @return string Reply spam link.
    21322131 */
    21332132function bbp_get_reply_spam_link( $args = array() ) {
    … …  
    21722171
    21732172/**
    2174  * Move reply link
    2175  *
    2176  * Output the move link of the reply
     2173 * Move reply link.
     2174 *
     2175 * Output the move link of the reply.
    21772176 *
    21782177 * @since 2.3.0 bbPress (r4521)
    21792178 *
    2180  * @param array $args See {@link bbp_get_reply_move_link()}
     2179 * @param array $args See {@link bbp_get_reply_move_link()}.
    21812180 */
    21822181function bbp_reply_move_link( $args = array() ) {
    … …  
    21852184
    21862185/**
    2187  * Get move reply link
    2188  *
    2189  * Return the move link of the reply
     2186 * Get move reply link.
     2187 *
     2188 * Return the move link of the reply.
    21902189 *
    21912190 * @since 2.3.0 bbPress (r4521)
    … …  
    21972196 *  - move_text: Move text
    21982197 *  - move_title: Move title attribute
    2199  * @return string Reply move link
     2198 * @return string Reply move link.
    22002199 */
    22012200function bbp_get_reply_move_link( $args = array() ) {
    … …  
    22382237
    22392238/**
    2240  * Split topic link
    2241  *
    2242  * Output the split link of the topic (but is bundled with each reply)
     2239 * Split topic link.
     2240 *
     2241 * Output the split link of the topic (but is bundled with each reply).
    22432242 *
    22442243 * @since 2.0.0 bbPress (r2756)
    22452244 *
    2246  * @param array $args See {@link bbp_get_topic_split_link()}
     2245 * @param array $args See {@link bbp_get_topic_split_link()}.
    22472246 */
    22482247function bbp_topic_split_link( $args = array() ) {
    … …  
    22512250
    22522251/**
    2253  * Get split topic link
    2254  *
    2255  * Return the split link of the topic (but is bundled with each reply)
     2252 * Get split topic link.
     2253 *
     2254 * Return the split link of the topic (but is bundled with each reply).
    22562255 *
    22572256 * @since 2.0.0 bbPress (r2756)
    … …  
    22632262 *  - split_text: Split text
    22642263 *  - split_title: Split title attribute
    2265  * @return string Topic split link
     2264 * @return string Topic split link.
    22662265 */
    22672266function bbp_get_topic_split_link( $args = array() ) {
    … …  
    23042303
    23052304/**
    2306  * Output the approve link of the reply
     2305 * Output the approve link of the reply.
    23072306 *
    23082307 * @since 2.6.0 bbPress (r5507)
    23092308 *
    2310  * @param array $args See {@link bbp_get_reply_approve_link()}
     2309 * @param array $args See {@link bbp_get_reply_approve_link()}.
    23112310 */
    23122311function bbp_reply_approve_link( $args = array() ) {
    … …  
    23152314
    23162315/**
    2317  * Return the approve link of the reply
     2316 * Return the approve link of the reply.
    23182317 *
    23192318 * @since 2.6.0 bbPress (r5507)
    … …  
    23262325 *  - approve_text: Approve text
    23272326 *  - unapprove_text: Unapprove text
    2328  * @return string Reply approve link
     2327 * @return string Reply approve link.
    23292328 */
    23302329function bbp_get_reply_approve_link( $args = array() ) {
    … …  
    23702369
    23712370/**
    2372  * Output the row class of a reply
     2371 * Output the row class of a reply.
    23732372 *
    23742373 * @since 2.0.0 bbPress (r2678)
    23752374 *
    2376  * @param int $reply_id Optional. Reply ID
    2377  * @param array Extra classes you can pass when calling this function
     2375 * @param int $reply_id Optional. Reply ID.
     2376 * @param array Extra classes you can pass when calling this function.
    23782377 */
    23792378function bbp_reply_class( $reply_id = 0, $classes = array() ) {
    … …  
    23822381
    23832382/**
    2384  * Return the row class of a reply
     2383 * Return the row class of a reply.
    23852384 *
    23862385 * @since 2.0.0 bbPress (r2678)
    23872386 *
    2388  * @param int $reply_id Optional. Reply ID
    2389  * @param array Extra classes you can pass when calling this function
    2390  * @return string Row class of the reply
     2387 * @param int $reply_id Optional. Reply ID.
     2388 * @param array Extra classes you can pass when calling this function.
     2389 * @return string Row class of the reply.
    23912390 */
    23922391function bbp_get_reply_class( $reply_id = 0, $classes = array() ) {
    … …  
    24432442
    24442443/**
    2445  * Return the base URL used inside of pagination links
     2444 * Return the base URL used inside of pagination links.
    24462445 *
    24472446 * @since 2.6.0 bbPress (r6679)
    24482447 *
    2449  * @param int $topic_id
     2448 * @param int $topic_id Topic id.
    24502449 * @return string
    24512450 */
    … …  
    24842483
    24852484/**
    2486  * Output the topic pagination count
     2485 * Output the topic pagination count.
    24872486 *
    24882487 * The results are unescaped by design, to allow them to be filtered freely via
    … …  
    24972496
    24982497/**
    2499  * Return the topic pagination count
     2498 * Return the topic pagination count.
    25002499 *
    25012500 * @since 2.0.0 bbPress (r2519)
    25022501 *
    2503  * @return string Topic pagination count
     2502 * @return string Topic pagination count.
    25042503 */
    25052504function bbp_get_topic_pagination_count() {
    … …  
    25702569
    25712570/**
    2572  * Output topic pagination links
     2571 * Output topic pagination links.
    25732572 *
    25742573 * @since 2.0.0 bbPress (r2519)
    … …  
    25792578
    25802579/**
    2581  * Return topic pagination links
     2580 * Return topic pagination links.
    25822581 *
    25832582 * @since 2.0.0 bbPress (r2519)
    25842583 *
    2585  * @return string Topic pagination links
     2584 * @return string Topic pagination links.
    25862585 */
    25872586function bbp_get_topic_pagination_links() {
    … …  
    25992598
    26002599/**
    2601  * Output the value of reply content field
     2600 * Output the value of reply content field.
    26022601 *
    26032602 * @since 2.0.0 bbPress (r3130)
    … …  
    26082607
    26092608/**
    2610  * Return the value of reply content field
     2609 * Return the value of reply content field.
    26112610 *
    26122611 * @since 2.0.0 bbPress (r3130)
    26132612 *
    2614  * @return string Value of reply content field
     2613 * @return string Value of reply content field.
    26152614 */
    26162615function bbp_get_form_reply_content() {
    … …  
    26342633
    26352634/**
    2636  * Output the value of the reply to field
     2635 * Output the value of the reply to field.
    26372636 *
    26382637 * @since 2.4.0 bbPress (r4944)
    … …  
    26432642
    26442643/**
    2645  * Return the value of reply to field
     2644 * Return the value of reply to field.
    26462645 *
    26472646 * @since 2.4.0 bbPress (r4944)
    26482647 *
    2649  * @return string Value of reply to field
     2648 * @return string Value of reply to field.
    26502649 */
    26512650function bbp_get_form_reply_to() {
    … …  
    26742673 * @since 2.6.0 bbPress (r5387)
    26752674 *
    2676  * @param int $reply_id
     2675 * @param int $reply_id Reply id.
    26772676 */
    26782677function bbp_reply_to_dropdown( $reply_id = 0 ) {
    … …  
    26852684 * @since 2.6.0 bbPress (r5387)
    26862685 *
    2687  * @param int $reply_id
    2688  *
    2689  * @return string The dropdown
     2686 * @param int $reply_id Reply id.
     2687 *
     2688 * @return string The dropdown.
    26902689 */
    26912690function bbp_get_reply_to_dropdown( $reply_id = 0 ) {
    … …  
    27522751
    27532752/**
    2754  * Output checked value of reply log edit field
     2753 * Output checked value of reply log edit field.
    27552754 *
    27562755 * @since 2.0.0 bbPress (r3130)
    … …  
    27612760
    27622761/**
    2763  * Return checked value of reply log edit field
     2762 * Return checked value of reply log edit field.
    27642763 *
    27652764 * @since 2.0.0 bbPress (r3130)
    27662765 *
    2767  * @return string Reply log edit checked value
     2766 * @return string Reply log edit checked value.
    27682767 */
    27692768function bbp_get_form_reply_log_edit() {
    … …  
    27862785
    27872786/**
    2788  * Output the value of the reply edit reason
     2787 * Output the value of the reply edit reason.
    27892788 *
    27902789 * @since 2.0.0 bbPress (r3130)
    … …  
    27952794
    27962795/**
    2797  * Return the value of the reply edit reason
     2796 * Return the value of the reply edit reason.
    27982797 *
    27992798 * @since 2.0.0 bbPress (r3130)
    28002799 *
    2801  * @return string Reply edit reason value
     2800 * @return string Reply edit reason value.
    28022801 */
    28032802function bbp_get_form_reply_edit_reason() {
    … …  
    28172816
    28182817/**
    2819  * Output value reply status dropdown
     2818 * Output value reply status dropdown.
    28202819 *
    28212820 * @since 2.6.0 bbPress (r5399)
    … …  
    28322831
    28332832/**
    2834  * Returns reply status dropdown
     2833 * Returns reply status dropdown.
    28352834 *
    28362835 * This dropdown is only intended to be seen by users with the 'moderate'
    … …  
    29082907 * @since 2.6.0 bbPress (r5558)
    29092908 *
    2910  * @return boolean True if is a post request with valid nonce
     2909 * @return boolean True if is a post request with valid nonce.
    29112910 */
    29122911function bbp_is_reply_form_post_request() {
Note: See TracChangeset for help on using the changeset viewer.