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

    r6565 r6573  
    1818 * @since 2.0.0 bbPress (r2857)
    1919 *
    20  * @uses bbp_get_reply_post_type() To get the reply post type
    2120 */
    2221function bbp_reply_post_type() {
    … …  
    2827     * @since 2.0.0 bbPress (r2857)
    2928     *
    30      * @uses apply_filters() Calls 'bbp_get_forum_post_type' with the forum
    3129     *                        post type id
    3230     * @return string The unique reply post type id
    … …  
    112110 *
    113111 * @param array $args All the arguments supported by {@link WP_Query}
    114  * @uses bbp_show_lead_topic() Are we showing the topic as a lead?
    115  * @uses bbp_get_topic_id() To get the topic id
    116  * @uses bbp_get_reply_post_type() To get the reply post type
    117  * @uses bbp_get_topic_post_type() To get the topic post type
    118  * @uses get_option() To get the replies per page option
    119  * @uses bbp_get_paged() To get the current page value
    120  * @uses current_user_can() To check if the current user is capable of editing
    121  *                           others' replies
    122  * @uses WP_Query To make query and get the replies
    123  * @uses bbp_use_pretty_urls() To check if the site is using pretty URLs
    124  * @uses get_permalink() To get the permalink
    125  * @uses add_query_arg() To add custom args to the url
    126  * @uses apply_filters() Calls 'bbp_replies_pagination' with the pagination args
    127  * @uses paginate_links() To paginate the links
    128  * @uses apply_filters() Calls 'bbp_has_replies' with
    129  *                        bbPress::reply_query::have_posts()
    130  *                        and bbPress::reply_query
    131112 * @return object Multidimensional array of reply information
    132113 */
    … …  
    301282 * @since 2.0.0 bbPress (r2553)
    302283 *
    303  * @uses WP_Query bbPress::reply_query::have_posts() To check if there are more
    304  *                                                    replies available
    305284 * @return object Replies information
    306285 */
    … …  
    323302 * @since 2.0.0 bbPress (r2553)
    324303 *
    325  * @uses WP_Query bbPress::reply_query::the_post() To get the current reply
    326304 * @return object Reply information
    327305 */
    … …  
    336314 *
    337315 * @param $reply_id Optional. Used to check emptiness
    338  * @uses bbp_get_reply_id() To get the reply id
    339316 */
    340317function bbp_reply_id( $reply_id = 0 ) {
    … …  
    347324     *
    348325     * @param $reply_id Optional. Used to check emptiness
    349      * @uses bbPress::reply_query::post::ID To get the reply id
    350      * @uses bbp_is_reply() To check if the search result is a reply
    351      * @uses bbp_is_single_reply() To check if it's a reply page
    352      * @uses bbp_is_reply_edit() To check if it's a reply edit page
    353      * @uses get_post_field() To get the post's post type
    354      * @uses WP_Query::post::ID To get the reply id
    355      * @uses bbp_get_reply_post_type() To get the reply post type
    356      * @uses apply_filters() Calls 'bbp_get_reply_id' with the reply id and
    357      *                        supplied reply id
    358326     * @return int The reply id
    359327     */
    … …  
    400368 * @param string $output Optional. OBJECT, ARRAY_A, or ARRAY_N. Default = OBJECT
    401369 * @param string $filter Optional Sanitation filter. See {@link sanitize_post()}
    402  * @uses get_post() To get the reply
    403  * @uses bbp_get_reply_post_type() To get the reply post type
    404  * @uses apply_filters() Calls 'bbp_get_reply' with the reply, output type and
    405  *                        sanitation filter
    406370 * @return mixed Null if error or reply (in specified form) if success
    407371 */
    … …  
    442406 *
    443407 * @param int $reply_id Optional. Reply id
    444  * @uses bbp_get_reply_permalink() To get the reply permalink
    445408 */
    446409function bbp_reply_permalink( $reply_id = 0 ) {
    … …  
    453416     *
    454417     * @param int $reply_id Optional. Reply id
    455      * @uses bbp_get_reply_id() To get the reply id
    456      * @uses get_permalink() To get the permalink of the reply
    457      * @uses apply_filters() Calls 'bbp_get_reply_permalink' with the link
    458418     *                        and reply id
    459419     * @return string Permanent link to reply
    … …  
    465425        return apply_filters( 'bbp_get_reply_permalink', get_permalink( $reply_id ), $reply_id );
    466426    }
     427
    467428/**
    468429 * Output the paginated url to the reply in the reply loop
    … …  
    471432 *
    472433 * @param int $reply_id Optional. Reply id
    473  * @uses bbp_get_reply_url() To get the reply url
    474434 */
    475435function bbp_reply_url( $reply_id = 0 ) {
    … …  
    484444     * @param string $redirect_to Optional. Pass a redirect value for use with
    485445     *                              shortcodes and other fun things.
    486      * @uses bbp_get_reply_id() To get the reply id
    487      * @uses bbp_get_reply_topic_id() To get the reply topic id
    488      * @uses bbp_get_topic_permalink() To get the topic permalink
    489      * @uses bbp_get_reply_position() To get the reply position
    490      * @uses get_option() To get the replies per page option
    491      * @uses bbp_use_pretty_urls() To check if the site uses pretty URLs
    492      * @uses add_query_arg() To add custom args to the url
    493      * @uses apply_filters() Calls 'bbp_get_reply_url' with the reply url,
    494      *                        reply id and bool count hidden
    495446     * @return string Link to reply relative to paginated topic
    496447     */
    … …  
    546497 *
    547498 * @param int $reply_id Optional. Reply id
    548  * @uses bbp_get_reply_title() To get the reply title
    549499 */
    550500function bbp_reply_title( $reply_id = 0 ) {
    … …  
    558508     *
    559509     * @param int $reply_id Optional. Reply id
    560      * @uses bbp_get_reply_id() To get the reply id
    561      * @uses get_the_title() To get the reply title
    562      * @uses apply_filters() Calls 'bbp_get_reply_title' with the title and
    563      *                        reply id
    564510     * @return string Title of reply
    565511     */
    … …  
    579525     * @param string $post_title Required. Reply Title
    580526     * @param int $post_id Required. Reply ID
    581      * @uses bbp_get_reply_topic_title() To get the reply topic title
    582      * @uses apply_filters() Calls 'bbp_get_reply_title_fallback' with the title and reply ID
    583527     * @return string Title of reply
    584528     */
    … …  
    606550 *
    607551 * @param int $reply_id Optional. reply id
    608  * @uses bbp_get_reply_content() To get the reply content
    609552 */
    610553function bbp_reply_content( $reply_id = 0 ) {
    … …  
    617560     *
    618561     * @param int $reply_id Optional. reply id
    619      * @uses bbp_get_reply_id() To get the reply id
    620      * @uses post_password_required() To check if the reply requires pass
    621      * @uses get_the_password_form() To get the password form
    622      * @uses get_post_field() To get the content post field
    623      * @uses apply_filters() Calls 'bbp_get_reply_content' with the content
    624      *                        and reply id
    625562     * @return string Content of the reply
    626563     */
    … …  
    646583 * @param int $reply_id Optional. Reply id
    647584 * @param int $length Optional. Length of the excerpt. Defaults to 100 letters
    648  * @uses bbp_get_reply_excerpt() To get the reply excerpt
    649585 */
    650586function bbp_reply_excerpt( $reply_id = 0, $length = 100 ) {
    … …  
    659595     * @param int $length Optional. Length of the excerpt. Defaults to 100
    660596     *                     letters
    661      * @uses bbp_get_reply_id() To get the reply id
    662      * @uses get_post_field() To get the excerpt
    663      * @uses bbp_get_reply_content() To get the reply content
    664      * @uses apply_filters() Calls 'bbp_get_reply_excerpt' with the excerpt,
    665      *                        reply id and length
    666597     * @return string Reply Excerpt
    667598     */
    … …  
    701632 * @param bool $humanize Optional. Humanize output using time_since
    702633 * @param bool $gmt Optional. Use GMT
    703  * @uses bbp_get_reply_post_date() to get the output
    704634 */
    705635function bbp_reply_post_date( $reply_id = 0, $humanize = false, $gmt = false ) {
    … …  
    714644     * @param bool $humanize Optional. Humanize output using time_since
    715645     * @param bool $gmt Optional. Use GMT
    716      * @uses bbp_get_reply_id() To get the reply id
    717      * @uses get_post_time() to get the reply post time
    718      * @uses bbp_get_time_since() to maybe humanize the reply post time
    719646     * @return string
    720647     */
    … …  
    747674 * @param string $content Optional. Content to which we need to append the revisions to
    748675 * @param int $reply_id Optional. Reply id
    749  * @uses bbp_get_reply_revision_log() To get the reply revision log
    750  * @uses apply_filters() Calls 'bbp_reply_append_revisions' with the processed
    751  *                        content, original content and reply id
    752676 * @return string Content with the revisions appended
    753677 */
    … …  
    772696 *
    773697 * @param int $reply_id Optional. Reply id
    774  * @uses bbp_get_reply_revision_log() To get the reply revision log
    775698 */
    776699function bbp_reply_revision_log( $reply_id = 0 ) {
    … …  
    783706     *
    784707     * @param int $reply_id Optional. Reply id
    785      * @uses bbp_get_reply_id() To get the reply id
    786      * @uses bbp_get_reply_revisions() To get the reply revisions
    787      * @uses bbp_get_reply_raw_revision_log() To get the raw revision log
    788      * @uses bbp_get_reply_author_display_name() To get the reply author
    789      * @uses bbp_get_reply_author_link() To get the reply author link
    790      * @uses bbp_convert_date() To convert the date
    791      * @uses bbp_get_time_since() To get the time in since format
    792      * @uses apply_filters() Calls 'bbp_get_reply_revision_log' with the
    793      *                        log and reply id
    794708     * @return string Revision log of the reply
    795709     */
    … …  
    855769         *
    856770         * @param int $reply_id Optional. Reply id
    857          * @uses bbp_get_reply_id() To get the reply id
    858          * @uses get_post_meta() To get the revision log meta
    859          * @uses apply_filters() Calls 'bbp_get_reply_raw_revision_log'
    860          *                        with the log and reply id
    861771         * @return string Raw revision log of the reply
    862772         */
    … …  
    876786 *
    877787 * @param int $reply_id Optional. Reply id
    878  * @uses bbp_get_reply_id() To get the reply id
    879  * @uses wp_get_post_revisions() To get the reply revisions
    880  * @uses apply_filters() Calls 'bbp_get_reply_revisions'
    881  *                        with the revisions and reply id
    882788 * @return string reply revisions
    883789 */
    … …  
    897803 * @param int $reply_id Optional. Reply id
    898804 * @param boolean $integer Optional. Whether or not to format the result
    899  * @uses bbp_get_reply_revisions() To get the reply revisions
    900  * @uses apply_filters() Calls 'bbp_get_reply_revision_count'
    901  *                        with the revision count and reply id
    902805 * @return string reply revision count
    903806 */
    … …  
    918821 *
    919822 * @param int $reply_id Optional. Reply id
    920  * @uses bbp_get_reply_status() To get the reply status
    921823 */
    922824function bbp_reply_status( $reply_id = 0 ) {
    … …  
    929831     *
    930832     * @param int $reply_id Optional. Reply id
    931      * @uses bbp_get_reply_id() To get the reply id
    932      * @uses get_post_status() To get the reply status
    933      * @uses apply_filters() Calls 'bbp_get_reply_status' with the reply id
    934833     * @return string Status of reply
    935834     */
    … …  
    947846 *
    948847 * @param int $reply_id Optional. Topic id
    949  * @uses bbp_get_reply_id() To get the reply id
    950  * @uses bbp_get_reply_status() To get the reply status
    951848 * @return bool True if published, false if not.
    952849 */
    … …  
    966863 *
    967864 * @param int $reply_id Optional. Reply id
    968  * @uses bbp_get_reply_id() To get the reply id
    969  * @uses bbp_get_reply_status() To get the reply status
    970865 * @return bool True if spam, false if not.
    971866 */
    … …  
    985880 *
    986881 * @param int $reply_id Optional. Topic id
    987  * @uses bbp_get_reply_id() To get the reply id
    988  * @uses bbp_get_reply_status() To get the reply status
    989882 * @return bool True if spam, false if not.
    990883 */
    … …  
    1004897 *
    1005898 * @param int $reply_id Optional. Topic id
    1006  * @uses bbp_get_reply_id() To get the reply id
    1007  * @uses bbp_get_reply_status() To get the reply status
    1008  * @uses apply_filters() Calls 'bbp_is_reply_pending' with the reply id
    1009899 * @return bool True if pending, false if not.
    1010900 */
    … …  
    1024914 *
    1025915 * @param int $reply_id Optional. Topic id
    1026  * @uses bbp_get_reply_id() To get the reply id
    1027  * @uses bbp_get_reply_status() To get the reply status
    1028  * @uses apply_filters() Calls 'bbp_is_reply_private' with the reply id
    1029916 * @return bool True if private, false if not.
    1030917 */
    … …  
    1044931 *
    1045932 * @param int $reply_id Optional. Reply id
    1046  * @uses bbp_get_reply_id() To get the reply id
    1047  * @uses bbp_get_reply_author_id() To get the reply author id
    1048  * @uses get_post_meta() To get the anonymous name and email metas
    1049933 * @return bool True if the post is by an anonymous user, false if not.
    1050934 */
    … …  
    1077961 *
    1078962 * @param int $reply_id Optional. Reply id
    1079  * @uses bbp_get_reply_author() To get the reply author
    1080963 */
    1081964function bbp_reply_author( $reply_id = 0 ) {
    … …  
    1092975     *
    1093976     * @param int $reply_id Optional. Reply id
    1094      * @uses bbp_get_reply_id() To get the reply id
    1095      * @uses bbp_is_reply_anonymous() To check if the reply is by an
    1096      *                                 anonymous user
    1097      * @uses get_the_author_meta() To get the reply author display name
    1098      * @uses get_post_meta() To get the anonymous poster name
    1099      * @uses apply_filters() Calls 'bbp_get_reply_author' with the reply
    1100      *                        author and reply id
    1101977     * @return string Author of reply
    1102978     */
    … …  
    1120996 *
    1121997 * @param int $reply_id Optional. Reply id
    1122  * @uses bbp_get_reply_author_id() To get the reply author id
    1123998 */
    1124999function bbp_reply_author_id( $reply_id = 0 ) {
    … …  
    11311006     *
    11321007     * @param int $reply_id Optional. Reply id
    1133      * @uses bbp_get_reply_id() To get the reply id
    1134      * @uses get_post_field() To get the reply author id
    1135      * @uses apply_filters() Calls 'bbp_get_reply_author_id' with the author
    1136      *                        id and reply id
    11371008     * @return string Author id of reply
    11381009     */
    … …  
    11511022 *
    11521023 * @param int $reply_id Optional. Reply id
    1153  * @uses bbp_get_reply_author_display_name()
    11541024 */
    11551025function bbp_reply_author_display_name( $reply_id = 0 ) {
    … …  
    11621032     *
    11631033     * @param int $reply_id Optional. Reply id
    1164      * @uses bbp_get_reply_id() To get the reply id
    1165      * @uses bbp_is_reply_anonymous() To check if the reply is by an
    1166      *                                 anonymous user
    1167      * @uses bbp_get_reply_author_id() To get the reply author id
    1168      * @uses get_the_author_meta() To get the reply author's display name
    1169      * @uses get_post_meta() To get the anonymous poster's name
    1170      * @uses apply_filters() Calls 'bbp_get_reply_author_display_name' with
    1171      *                        the author display name and reply id
    11721034     * @return string The display name of the author of the reply
    11731035     */
    … …  
    12151077 * @param int $reply_id Optional. Reply id
    12161078 * @param int $size Optional. Size of the avatar. Defaults to 40
    1217  * @uses bbp_get_reply_author_avatar() To get the reply author id
    12181079 */
    12191080function bbp_reply_author_avatar( $reply_id = 0, $size = 40 ) {
    … …  
    12271088     * @param int $reply_id Optional. Reply id
    12281089     * @param int $size Optional. Size of the avatar. Defaults to 40
    1229      * @uses bbp_get_reply_id() To get the reply id
    1230      * @uses bbp_is_reply_anonymous() To check if the reply is by an
    1231      *                                 anonymous user
    1232      * @uses bbp_get_reply_author_id() To get the reply author id
    1233      * @uses get_post_meta() To get the anonymous poster's email id
    1234      * @uses get_avatar() To get the avatar
    1235      * @uses apply_filters() Calls 'bbp_get_reply_author_avatar' with the
    1236      *                        author avatar, reply id and size
    12371090     * @return string Avatar of author of the reply
    12381091     */
    … …  
    12601113 *
    12611114 * @param array $args Optional. If it is an integer, it is used as reply id.
    1262  * @uses bbp_get_reply_author_link() To get the reply author link
    12631115 */
    12641116function bbp_reply_author_link( $args = array() ) {
    … …  
    12711123     *
    12721124     * @param array $args Optional. If an integer, it is used as reply id.
    1273      * @uses bbp_get_reply_id() To get the reply id
    1274      * @uses bbp_is_reply_anonymous() To check if the reply is by an
    1275      *                                 anonymous user
    1276      * @uses bbp_get_reply_author_url() To get the reply author url
    1277      * @uses bbp_get_reply_author_avatar() To get the reply author avatar
    1278      * @uses bbp_get_reply_author_display_name() To get the reply author display
    1279      *                                      name
    1280      * @uses bbp_get_user_display_role() To get the reply author display role
    1281      * @uses bbp_get_reply_author_id() To get the reply author id
    1282      * @uses apply_filters() Calls 'bbp_get_reply_author_link' with the
    1283      *                        author link and args
    12841125     * @return string Author link of reply
    12851126     */
    … …  
    13711212 *
    13721213 * @param int $reply_id Optional. Reply id
    1373  * @uses bbp_get_reply_author_url() To get the reply author url
    13741214 */
    13751215function bbp_reply_author_url( $reply_id = 0 ) {
    … …  
    13821222     *
    13831223     * @param int $reply_id Optional. Reply id
    1384      * @uses bbp_get_reply_id() To get the reply id
    1385      * @uses bbp_is_reply_anonymous() To check if the reply is by an anonymous
    1386      *                                 user
    1387      * @uses bbp_user_has_profile() To check if the user has a profile
    1388      * @uses bbp_get_reply_author_id() To get the reply author id
    1389      * @uses bbp_get_user_profile_url() To get the user profile url
    1390      * @uses get_post_meta() To get the anonymous poster's website url
    1391      * @uses apply_filters() Calls bbp_get_reply_author_url with the author
    1392      *                        url & reply id
    13931224     * @return string Author URL of the reply
    13941225     */
    … …  
    14161247 *
    14171248 * @param int $reply_id Optional. Reply id
    1418  * @uses bbp_get_reply_author_email() To get the reply author email
    14191249 */
    14201250function bbp_reply_author_email( $reply_id = 0 ) {
    … …  
    14271257     *
    14281258     * @param int $reply_id Optional. Reply id
    1429      * @uses bbp_get_reply_id() To get the reply id
    1430      * @uses bbp_is_reply_anonymous() To check if the reply is by an anonymous
    1431      *                                 user
    1432      * @uses bbp_get_reply_author_id() To get the reply author id
    1433      * @uses get_userdata() To get the user data
    1434      * @uses get_post_meta() To get the anonymous poster's website email
    1435      * @uses apply_filters() Calls bbp_get_reply_author_email with the author
    1436      *                        email & reply id
    14371259     * @return string Reply author email address
    14381260     */
    … …  
    14701292 *
    14711293 * @param array $args Optional.
    1472  * @uses bbp_get_reply_author_role() To get the reply author role
    14731294 */
    14741295function bbp_reply_author_role( $args = array() ) {
    … …  
    14811302     *
    14821303     * @param array $args Optional.
    1483      * @uses bbp_get_reply_id() To get the reply id
    1484      * @uses bbp_get_user_display_role() To get the user display role
    1485      * @uses bbp_get_reply_author_id() To get the reply author id
    1486      * @uses apply_filters() Calls bbp_get_reply_author_role with the author
    1487      *                        role & args
    14881304     * @return string Reply author role
    14891305     */
    … …  
    15211337 *
    15221338 * @param int $reply_id Optional. Reply id
    1523  * @uses bbp_get_reply_topic_title() To get the reply topic title
    15241339 */
    15251340function bbp_reply_topic_title( $reply_id = 0 ) {
    … …  
    15321347     *
    15331348     * @param int $reply_id Optional. Reply id
    1534      * @uses bbp_get_reply_id() To get the reply id
    1535      * @uses bbp_get_reply_topic_id() To get the reply topic id
    1536      * @uses bbp_get_topic_title() To get the reply topic title
    1537      * @uses apply_filters() Calls 'bbp_get_reply_topic_title' with the
    1538      *                        topic title and reply id
    15391349     * @return string The topic title of the reply
    15401350     */
    … …  
    15531363 *
    15541364 * @param int $reply_id Optional. Reply id
    1555  * @uses bbp_get_reply_topic_id() To get the reply topic id
    15561365 */
    15571366function bbp_reply_topic_id( $reply_id = 0 ) {
    … …  
    15641373     *
    15651374     * @param int $reply_id Optional. Reply id
    1566      * @uses bbp_get_reply_id() To get the reply id
    1567      * @uses get_post_meta() To get the reply topic id from meta
    1568      * @uses bbp_get_topic_id() To get the topic id
    1569      * @uses apply_filters() Calls 'bbp_get_reply_topic_id' with the topic
    1570      *                        id and reply id
    15711375     * @return int The topic id of the reply
    15721376     */
    … …  
    15951399 *
    15961400 * @param int $reply_id Optional. Reply id
    1597  * @uses bbp_get_reply_forum_id() To get the reply forum id
    15981401 */
    15991402function bbp_reply_forum_id( $reply_id = 0 ) {
    … …  
    16061409     *
    16071410     * @param int $reply_id Optional. Reply id
    1608      * @uses bbp_get_reply_id() To get the reply id
    1609      * @uses get_post_meta() To get the reply forum id
    1610      * @uses apply_filters() Calls 'bbp_get_reply_forum_id' with the forum
    16111411     *                        id and reply id
    16121412     * @return int The forum id of the reply
    … …  
    16361436 *
    16371437 * @param int $reply_id Optional. Reply id
    1638  * @uses bbp_get_reply_ancestor_id() To get the ancestor id of the reply
    16391438 */
    16401439function bbp_reply_ancestor_id( $reply_id = 0 ) {
    … …  
    16471446     *
    16481447     * @param in $reply_id Reply id
    1649      * @uses bbp_get_reply_id() To get the reply id
    16501448     */
    16511449    function bbp_get_reply_ancestor_id( $reply_id = 0 ) {
    … …  
    16751473 *
    16761474 * @param int $reply_id Optional. Reply id
    1677  * @uses bbp_get_reply_to() To get the reply to id
    16781475 */
    16791476function bbp_reply_to( $reply_id = 0 ) {
    … …  
    16861483     *
    16871484     * @param int $reply_id Optional. Reply id
    1688      * @uses bbp_get_reply_id() To get the reply id
    1689      * @uses get_post_meta() To get the reply to id
    1690      * @uses apply_filters() Calls 'bbp_get_reply_to' with the reply to id and
    1691      *                        reply id
    16921485     * @return int The parent reply id of the reply
    16931486     */
    … …  
    17151508 *
    17161509 * @param array $args
    1717  * @uses bbp_get_reply_to_link() To get the reply to link
    17181510 */
    17191511function bbp_reply_to_link( $args = array() ) {
    … …  
    17271519     *
    17281520     * @param array $args Arguments
    1729      * @uses bbp_current_user_can_access_create_reply_form() To check permissions
    1730      * @uses bbp_get_reply_id() To validate the reply id
    1731      * @uses bbp_get_reply() To get the reply
    1732      * @uses apply_filters() Calls 'bbp_get_reply_to_link' with the formatted link,
    1733      *                        the arguments array, and the reply
    17341521     * @return string Link for a reply to a reply
    17351522     */
    … …  
    17931580 *
    17941581 * @since 2.4.0 bbPress (r4944)
    1795  *
    1796  * @uses bbp_get_cancel_reply_to_link() To get the reply cancellation link
    17971582 */
    17981583function bbp_cancel_reply_to_link( $text = '' ) {
    … …  
    18051590     *
    18061591     * @param string $text The cancel text
    1807      * @uses apply_filters() Calls 'bbp_get_cancel_reply_to_link' with the cancellation
    1808      *                        link and the cancel text
    18091592     * @return string The cancellation link
    18101593     */
    … …  
    18421625 * @param int $reply_id Optional. Reply id
    18431626 * @param int $topic_id Optional. Topic id
    1844  * @uses bbp_get_reply_position() To get the reply position
    18451627 */
    18461628function bbp_reply_position( $reply_id = 0, $topic_id = 0 ) {
    … …  
    18541636     * @param int $reply_id Optional. Reply id
    18551637     * @param int $topic_id Optional. Topic id
    1856      * @uses bbp_get_reply_id() To get the reply id
    1857      * @uses bbp_get_reply_topic_id() Get the topic id of the reply id
    1858      * @uses bbp_get_topic_reply_count() To get the topic reply count
    1859      * @uses bbp_get_reply_post_type() To get the reply post type
    1860      * @uses bbp_get_reply_position_raw() To get calculate the reply position
    1861      * @uses bbp_update_reply_position() To update the reply position
    1862      * @uses bbp_show_lead_topic() Bump the count if lead topic is included
    1863      * @uses apply_filters() Calls 'bbp_get_reply_position' with the reply
    1864      *                        position, reply id and topic id
    18651638     * @return int Reply position
    18661639     */
    … …  
    19121685 *
    19131686 * @param array $args See {@link bbp_get_reply_admin_links()}
    1914  * @uses bbp_get_reply_admin_links() To get the reply admin links
    19151687 */
    19161688function bbp_reply_admin_links( $args = array() ) {
    … …  
    19301702     *  - links: Array of the links to display. By default, edit, trash,
    19311703     *            spam, reply move, and topic split links are displayed
    1932      * @uses bbp_is_topic() To check if it's the topic page
    1933      * @uses bbp_is_reply() To check if it's the reply page
    1934      * @uses bbp_get_reply_id() To get the reply id
    1935      * @uses bbp_get_reply_edit_link() To get the reply edit link
    1936      * @uses bbp_get_reply_trash_link() To get the reply trash link
    1937      * @uses bbp_get_reply_spam_link() To get the reply spam link
    1938      * @uses bbp_get_reply_move_link() To get the reply move link
    1939      * @uses bbp_get_topic_split_link() To get the topic split link
    1940      * @uses current_user_can() To check if the current user can edit or
    1941      *                           delete the reply
    1942      * @uses apply_filters() Calls 'bbp_get_reply_admin_links' with the
    1943      *                        reply admin links and args
    19441704     * @return string Reply admin links
    19451705     */
    … …  
    20131773 *
    20141774 * @param array $args See {@link bbp_get_reply_edit_link()}
    2015  * @uses bbp_get_reply_edit_link() To get the reply edit link
    20161775 */
    20171776function bbp_reply_edit_link( $args = array() ) {
    … …  
    20291788     *  - link_after: HTML after the link
    20301789     *  - edit_text: Edit text. Defaults to 'Edit'
    2031      * @uses bbp_get_reply_id() To get the reply id
    2032      * @uses bbp_get_reply() To get the reply
    2033      * @uses current_user_can() To check if the current user can edit the
    2034      *                           reply
    2035      * @uses bbp_get_reply_edit_url() To get the reply edit url
    2036      * @uses apply_filters() Calls 'bbp_get_reply_edit_link' with the reply
    2037      *                        edit link and args
    20381790     * @return string Reply edit link
    20391791     */
    … …  
    20801832 *
    20811833 * @param int $reply_id Optional. Reply id
    2082  * @uses bbp_get_reply_edit_url() To get the reply edit url
    20831834 */
    20841835function bbp_reply_edit_url( $reply_id = 0 ) {
    … …  
    20911842     *
    20921843     * @param int $reply_id Optional. Reply id
    2093      * @uses bbp_get_reply_id() To get the reply id
    2094      * @uses bbp_get_reply() To get the reply
    2095      * @uses bbp_get_reply_post_type() To get the reply post type
    2096      * @uses add_query_arg() To add custom args to the url
    2097      * @uses apply_filters() Calls 'bbp_get_reply_edit_url' with the edit
    2098      *                        url and reply id
    20991844     * @return string Reply edit url
    21001845     */
    … …  
    21361881 *
    21371882 * @param array $args See {@link bbp_get_reply_trash_link()}
    2138  * @uses bbp_get_reply_trash_link() To get the reply trash link
    21391883 */
    21401884function bbp_reply_trash_link( $args = array() ) {
    … …  
    21551899     *  - restore_text: Restore text
    21561900     *  - delete_text: Delete text
    2157      * @uses bbp_get_reply_id() To get the reply id
    2158      * @uses bbp_get_reply() To get the reply
    2159      * @uses current_user_can() To check if the current user can delete the
    2160      *                           reply
    2161      * @uses bbp_is_reply_trash() To check if the reply is trashed
    2162      * @uses bbp_get_reply_status() To get the reply status
    2163      * @uses add_query_arg() To add custom args to the url
    2164      * @uses wp_nonce_url() To nonce the url
    2165      * @uses esc_url() To escape the url
    2166      * @uses bbp_get_reply_edit_url() To get the reply edit url
    2167      * @uses apply_filters() Calls 'bbp_get_reply_trash_link' with the reply
    2168      *                        trash link and args
    21691901     * @return string Reply trash link
    21701902     */
    … …  
    22201952 *
    22211953 * @param array $args See {@link bbp_get_reply_spam_link()}
    2222  * @uses bbp_get_reply_spam_link() To get the reply spam link
    22231954 */
    22241955function bbp_reply_spam_link( $args = array() ) {
    … …  
    22371968     *  - spam_text: Spam text
    22381969     *  - unspam_text: Unspam text
    2239      * @uses bbp_get_reply_id() To get the reply id
    2240      * @uses bbp_get_reply() To get the reply
    2241      * @uses current_user_can() To check if the current user can edit the
    2242      *                           reply
    2243      * @uses bbp_is_reply_spam() To check if the reply is marked as spam
    2244      * @uses add_query_arg() To add custom args to the url
    2245      * @uses wp_nonce_url() To nonce the url
    2246      * @uses esc_url() To escape the url
    2247      * @uses bbp_get_reply_edit_url() To get the reply edit url
    2248      * @uses apply_filters() Calls 'bbp_get_reply_spam_link' with the reply
    2249      *                        spam link and args
    22501970     * @return string Reply spam link
    22511971     */
    … …  
    22862006 *
    22872007 * @param array $args See {@link bbp_get_reply_move_link()}
    2288  * @uses bbp_get_reply_move_link() To get the reply move link
    22892008 */
    22902009function bbp_reply_move_link( $args = array() ) {
    … …  
    23052024     *  - move_text: Move text
    23062025     *  - move_title: Move title attribute
    2307      * @uses bbp_get_reply_id() To get the reply id
    2308      * @uses bbp_get_reply() To get the reply
    2309      * @uses current_user_can() To check if the current user can edit the
    2310      *                           topic
    2311      * @uses bbp_get_reply_topic_id() To get the reply topic id
    2312      * @uses bbp_get_reply_edit_url() To get the reply edit url
    2313      * @uses add_query_arg() To add custom args to the url
    2314      * @uses wp_nonce_url() To nonce the url
    2315      * @uses esc_url() To escape the url
    2316      * @uses apply_filters() Calls 'bbp_get_reply_move_link' with the reply
    2317      *                        move link and args
    23182026     * @return string Reply move link
    23192027     */
    … …  
    23572065 *
    23582066 * @param array $args See {@link bbp_get_topic_split_link()}
    2359  * @uses bbp_get_topic_split_link() To get the topic split link
    23602067 */
    23612068function bbp_topic_split_link( $args = array() ) {
    … …  
    23762083     *  - split_text: Split text
    23772084     *  - split_title: Split title attribute
    2378      * @uses bbp_get_reply_id() To get the reply id
    2379      * @uses bbp_get_reply() To get the reply
    2380      * @uses current_user_can() To check if the current user can edit the
    2381      *                           topic
    2382      * @uses bbp_get_reply_topic_id() To get the reply topic id
    2383      * @uses bbp_get_topic_edit_url() To get the topic edit url
    2384      * @uses add_query_arg() To add custom args to the url
    2385      * @uses wp_nonce_url() To nonce the url
    2386      * @uses esc_url() To escape the url
    2387      * @uses apply_filters() Calls 'bbp_get_topic_split_link' with the topic
    2388      *                        split link and args
    23892085     * @return string Topic split link
    23902086     */
    … …  
    24262122 *
    24272123 * @param array $args See {@link bbp_get_reply_approve_link()}
    2428  * @uses bbp_get_reply_approve_link() To get the reply approve link
    24292124 */
    24302125function bbp_reply_approve_link( $args = array() ) {
    … …  
    24442139     *  - approve_text: Approve text
    24452140     *  - unapprove_text: Unapprove text
    2446      * @uses bbp_get_reply_id() To get the reply id
    2447      * @uses bbp_get_reply() To get the reply
    2448      * @uses current_user_can() To check if the current user can approve the reply
    2449      * @uses bbp_is_reply_pending() To check if the reply is pending
    2450      * @uses add_query_arg() To add custom args to the url
    2451      * @uses wp_nonce_url() To nonce the url
    2452      * @uses esc_url() To escape the url
    2453      * @uses apply_filters() Calls 'bbp_get_reply_approve_link' with the link
    2454      *                        and args
    24552141     * @return string Reply approve link
    24562142     */
    … …  
    24912177 * @param int $reply_id Optional. Reply ID
    24922178 * @param array Extra classes you can pass when calling this function
    2493  * @uses bbp_get_reply_class() To get the reply class
    24942179 */
    24952180function bbp_reply_class( $reply_id = 0, $classes = array() ) {
    … …  
    25032188     * @param int $reply_id Optional. Reply ID
    25042189     * @param array Extra classes you can pass when calling this function
    2505      * @uses bbp_get_reply_id() To validate the reply id
    2506      * @uses bbp_get_reply_forum_id() To get the forum id of the reply
    2507      * @uses bbp_get_reply_topic_id() To get the topic id of the reply
    2508      * @uses get_post_class() To get all the classes including ours
    2509      * @uses apply_filters() Calls 'bbp_get_reply_class' with the classes
    25102190     * @return string Row class of the reply
    25112191     */
    … …  
    25342214 * @since 2.0.0 bbPress (r2519)
    25352215 *
    2536  * @uses bbp_get_topic_pagination_count() To get the topic pagination count
    25372216 */
    25382217function bbp_topic_pagination_count() {
    … …  
    25442223     * @since 2.0.0 bbPress (r2519)
    25452224     *
    2546      * @uses bbp_number_format() To format the number value
    2547      * @uses bbp_show_lead_topic() Are we showing the topic as a lead?
    2548      * @uses apply_filters() Calls 'bbp_get_topic_pagination_count' with the
    2549      *                        pagination count
    25502225     * @return string Topic pagination count
    25512226     */
    … …  
    26082283 *
    26092284 * @since 2.0.0 bbPress (r2519)
    2610  *
    2611  * @uses bbp_get_topic_pagination_links() To get the topic pagination links
    26122285 */
    26132286function bbp_topic_pagination_links() {
    … …  
    26192292     * @since 2.0.0 bbPress (r2519)
    26202293     *
    2621      * @uses apply_filters() Calls 'bbp_get_topic_pagination_links' with the
    2622      *                        pagination links
    26232294     * @return string Topic pagination links
    26242295     */
    … …  
    26402311 *
    26412312 * @since 2.0.0 bbPress (r3130)
    2642  *
    2643  * @uses bbp_get_form_reply_content() To get value of reply content field
    26442313 */
    26452314function bbp_form_reply_content() {
    … …  
    26512320     * @since 2.0.0 bbPress (r3130)
    26522321     *
    2653      * @uses bbp_is_reply_edit() To check if it's the reply edit page
    2654      * @uses apply_filters() Calls 'bbp_get_form_reply_content' with the content
    26552322     * @return string Value of reply content field
    26562323     */
    … …  
    26782345 *
    26792346 * @since 2.4.0 bbPress (r4944)
    2680  *
    2681  * @uses bbp_get_form_reply_to() To get value of the reply to field
    26822347 */
    26832348function bbp_form_reply_to() {
    … …  
    26902355     * @since 2.4.0 bbPress (r4944)
    26912356     *
    2692      * @uses bbp_get_reply_id() To validate the reply to
    2693      * @uses apply_filters() Calls 'bbp_get_form_reply_to' with the reply to
    26942357     * @return string Value of reply to field
    26952358     */
    … …  
    27312394     * @param int $reply_id
    27322395     *
    2733      * @uses BBP_Reply_Walker_Dropdown() As the default walker to generate the
    2734      *                                   dropdown
    2735      * @uses current_user_can()          To check if the current user can read
    2736      *                                   private forums
    2737      * @uses bbp_get_reply_id()          To get the reply ID
    2738      * @uses bbp_get_reply_to()          To get the reply to ID
    2739      * @uses bbp_get_reply_topic_id()    To get the replies topic ID
    2740      * @uses bbp_get_reply_post_type()   To get the reply post type
    2741      * @uses bbp_get_public_status_id()  To get the reply status
    2742      * @uses bbp_thread_replies_depth()  To get the threaded replies depth
    2743      *
    2744      * @uses apply_filters() Calls 'bbp_get_dropdown' with the dropdown
    2745      *                        and args
    27462396     * @return string The dropdown
    27472397     */
    … …  
    28072457 *
    28082458 * @since 2.0.0 bbPress (r3130)
    2809  *
    2810  * @uses bbp_get_form_reply_log_edit() To get the reply log edit value
    28112459 */
    28122460function bbp_form_reply_log_edit() {
    … …  
    28182466     * @since 2.0.0 bbPress (r3130)
    28192467     *
    2820      * @uses apply_filters() Calls 'bbp_get_form_reply_log_edit' with the
    2821      *                        log edit value
    28222468     * @return string Reply log edit checked value
    28232469     */
    … …  
    28442490 *
    28452491 * @since 2.0.0 bbPress (r3130)
    2846  *
    2847  * @uses bbp_get_form_reply_edit_reason() To get the reply edit reason value
    28482492 */
    28492493function bbp_form_reply_edit_reason() {
    … …  
    28552499     * @since 2.0.0 bbPress (r3130)
    28562500     *
    2857      * @uses apply_filters() Calls 'bbp_get_form_reply_edit_reason' with the
    2858      *                        reply edit reason value
    28592501     * @return string Reply edit reason value
    28602502     */
Note: See TracChangeset for help on using the changeset viewer.