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

    r6498 r6573  
    2121 * @since 2.1.0 bbPress (r3979)
    2222 *
    23  * @uses bbp_get_forums_url() To get the forums URL
    2423 * @param string $path Additional path with leading slash
    2524 */
     
    3231     * @since 2.1.0 bbPress (r3979)
    3332     *
    34      * @uses home_url() To get the home URL
    35      * @uses bbp_get_root_slug() To get the forum root location
    3633     * @param string $path Additional path with leading slash
    3734     */
     
    4542 * @since 2.1.0 bbPress (r3979)
    4643 *
    47  * @uses bbp_get_topics_url() To get the topics URL
    4844 * @param string $path Additional path with leading slash
    4945 */
     
    5652     * @since 2.1.0 bbPress (r3979)
    5753     *
    58      * @uses home_url() To get the home URL
    59      * @uses bbp_get_topic_archive_slug() To get the topics archive location
    6054     * @param string $path Additional path with leading slash
    6155     * @return The URL to the topics archive
     
    7165 *
    7266 * @since 2.0.0 bbPress (r2464)
    73  *
    74  * @uses do_action() Calls 'bbp_head'
    75 */
     67 */
    7668function bbp_head() {
    7769    do_action( 'bbp_head' );
     
    8274 *
    8375 * @since 2.0.0 bbPress (r2464)
    84  *
    85  * @uses do_action() Calls 'bbp_footer'
    8676 */
    8777function bbp_footer() {
     
    9787 *
    9888 * @param int $site_id
    99  * @uses get_current_blog_id()
    100  * @uses get_blog_option()
    101  * @uses apply_filters()
    10289 * @return bool True if site is public, false if private
    10390 */
     
    122109 *
    123110 * @param int $post_id Possible post_id to check
    124  * @uses bbp_get_forum_post_type() To get the forum post type
    125111 * @return bool True if it's a forum page, false if not
    126112 */
     
    144130 * @since 2.0.0 bbPress (r3251)
    145131 *
    146  * @uses is_post_type_archive() To check if we are looking at the forum archive
    147  * @uses bbp_get_forum_post_type() To get the forum post type ID
    148  *
    149132 * @return bool
    150133 */
     
    168151 *
    169152 * @since 2.0.0 bbPress (r3338)
    170  *
    171  * @uses is_single()
    172  * @uses bbp_get_forum_post_type()
    173  * @uses get_post_type()
    174  * @uses apply_filters()
    175153 *
    176154 * @return bool
     
    200178 * @since 2.1.0 bbPress (r3553)
    201179 *
    202  * @uses WP_Query Checks if WP_Query::bbp_is_forum_edit is true
    203180 * @return bool True if it's the forum edit page, false if not
    204181 */
     
    228205 *
    229206 * @param int $post_id Possible post_id to check
    230  * @uses bbp_get_topic_post_type() To get the topic post type
    231  * @uses get_post_type() To get the post type of the post id
    232207 * @return bool True if it's a topic page, false if not
    233208 */
     
    250225 *
    251226 * @since 2.0.0 bbPress (r3338)
    252  *
    253  * @uses is_single()
    254  * @uses bbp_get_topic_post_type()
    255  * @uses get_post_type()
    256  * @uses apply_filters()
    257227 *
    258228 * @return bool
     
    282252 * @since 2.0.0 bbPress (r3251)
    283253 *
    284  * @uses is_post_type_archive() To check if we are looking at the topic archive
    285  * @uses bbp_get_topic_post_type() To get the topic post type ID
    286  *
    287254 * @return bool
    288255 */
     
    306273 * @since 2.0.0 bbPress (r2753)
    307274 *
    308  * @uses WP_Query Checks if WP_Query::bbp_is_topic_edit is true
    309275 * @return bool True if it's the topic edit page, false if not
    310276 */
     
    333299 * @since 2.0.0 bbPress (r2756)
    334300 *
    335  * @uses bbp_is_topic_edit() To check if it's a topic edit page
    336301 * @return bool True if it's the topic merge page, false if not
    337302 */
     
    355320 * @since 2.0.0 bbPress (r2756)
    356321 *
    357  * @uses bbp_is_topic_edit() To check if it's a topic edit page
    358322 * @return bool True if it's the topic split page, false if not
    359323 */
     
    408372 * @since 2.0.0 bbPress (r3346)
    409373 *
    410  * @uses WP_Query Checks if WP_Query::bbp_is_topic_tag_edit is true
    411374 * @return bool True if editing a topic tag, false if not
    412375 */
     
    441404 *
    442405 * @param mixed $the_post Optional. Post object or post ID.
    443  * @uses get_post_type()
    444  * @uses bbp_get_forum_post_type()
    445  * @uses bbp_get_topic_post_type()
    446  * @uses bbp_get_reply_post_type()
    447406 *
    448407 * @return bool
     
    472431 *
    473432 * @param int $post_id Possible post_id to check
    474  * @uses bbp_get_reply_post_type() To get the reply post type
    475  * @uses get_post_type() To get the post type of the post id
    476433 * @return bool True if it's a reply page, false if not
    477434 */
     
    495452 * @since 2.0.0 bbPress (r2753)
    496453 *
    497  * @uses WP_Query Checks if WP_Query::bbp_is_reply_edit is true
    498454 * @return bool True if it's the reply edit page, false if not
    499455 */
     
    520476 * Check if current page is a reply move page
    521477 *
    522  * @uses bbp_is_reply_move() To check if it's a reply move page
    523478 * @return bool True if it's the reply move page, false if not
    524479 */
     
    541496 *
    542497 * @since 2.0.0 bbPress (r3344)
    543  *
    544  * @uses is_single()
    545  * @uses bbp_get_reply_post_type()
    546  * @uses get_post_type()
    547  * @uses apply_filters()
    548498 *
    549499 * @return bool
     
    663613 * @since 2.0.0 bbPress (r2688)
    664614 *
    665  * @uses bbp_is_single_user() Check query variable
    666  * @uses is_user_logged_in() Must be logged in to be home
    667  * @uses bbp_get_displayed_user_id()
    668  * @uses bbp_get_current_user_id()
    669615 * @return bool True if it's the user's home, false if not
    670616 */
     
    689635 * @since 2.1.0 bbPress (r3918)
    690636 *
    691  * @uses bbp_is_single_user_edit() Check query variable
    692  * @uses is_user_logged_in() Must be logged in to be home
    693  * @uses bbp_get_displayed_user_id()
    694  * @uses bbp_get_current_user_id()
    695637 * @return bool True if it's the user's home, false if not
    696638 */
     
    713655 * @since 2.0.0 bbPress (r2688)
    714656 *
    715  * @uses WP_Query Checks if WP_Query::bbp_is_single_user is set to true
    716657 * @return bool True if it's a user's profile page, false if not
    717658 */
     
    736677 * @since 2.0.0 bbPress (r2688)
    737678 *
    738  * @uses WP_Query Checks if WP_Query::bbp_is_single_user_edit is set to true
    739679 * @return bool True if it's a user's profile edit page, false if not
    740680 */
     
    759699 * @since 2.2.0 bbPress (r4225)
    760700 *
    761  * @uses WP_Query Checks if WP_Query::bbp_is_single_user_profile is set to true
    762701 * @return bool True if it's a user's profile page, false if not
    763702 */
     
    782721 * @since 2.2.0 bbPress (r4225)
    783722 *
    784  * @uses WP_Query Checks if WP_Query::bbp_is_single_user_topics is set to true
    785723 * @return bool True if it's a user's topics page, false if not
    786724 */
     
    805743 * @since 2.2.0 bbPress (r4225)
    806744 *
    807  * @uses WP_Query Checks if WP_Query::bbp_is_single_user_replies is set to true
    808745 * @return bool True if it's a user's replies page, false if not
    809746 */
     
    828765 * @since 2.6.0 bbPress (r6320)
    829766 *
    830  * @uses WP_Query Checks if WP_Query::bbp_is_single_user_engagements is set to true
    831767 * @return bool True if it's a user's replies page, false if not
    832768 */
     
    852788 *
    853789 * @global WP_Query $wp_query To check if WP_Query::bbp_is_view is true
    854  * @uses bbp_is_query_name() To get the query name
    855790 * @return bool Is it a view page?
    856791 */
     
    881816 *
    882817 * @global WP_Query $wp_query To check if WP_Query::bbp_is_search is true
    883  * @uses bbp_is_query_name() To get the query name
    884818 * @return bool Is it a search page?
    885819 */
     
    920854 *
    921855 * @global WP_Query $wp_query To check if WP_Query::bbp_is_search is true
    922  * @uses bbp_is_query_name() To get the query name
    923856 * @return bool Is it a search page?
    924857 */
     
    958891 * @since 2.1.0 bbPress (r3585)
    959892 *
    960  * @uses WP_Query Checks if WP_Query::bbp_is_edit is true
    961893 * @return bool True if it's the edit page, false if not
    962894 */
     
    983915 * @param array $wp_classes
    984916 * @param array $custom_classes
    985  * @uses bbp_is_single_forum()
    986  * @uses bbp_is_single_topic()
    987  * @uses bbp_is_topic_edit()
    988  * @uses bbp_is_topic_merge()
    989  * @uses bbp_is_topic_split()
    990  * @uses bbp_is_single_reply()
    991  * @uses bbp_is_reply_edit()
    992  * @uses bbp_is_reply_move()
    993  * @uses bbp_is_single_view()
    994  * @uses bbp_is_single_user_edit()
    995  * @uses bbp_is_single_user()
    996  * @uses bbp_is_user_home()
    997  * @uses bbp_is_subscriptions()
    998  * @uses bbp_is_favorites()
    999  * @uses bbp_is_topics_created()
    1000  * @uses bbp_is_replies_created()
    1001  * @uses bbp_is_forum_archive()
    1002  * @uses bbp_is_topic_archive()
    1003  * @uses bbp_is_topic_tag()
    1004  * @uses bbp_is_topic_tag_edit()
    1005  * @uses bbp_get_topic_tag_tax_id()
    1006  * @uses bbp_get_topic_tag_slug()
    1007  * @uses bbp_get_topic_tag_id()
    1008917 * @return array Body Classes
    1009918 */
     
    11471056 * @since 2.6.0
    11481057 *
    1149  * @uses is_singular()
    1150  * @uses bbp_get_global_post_field()
    1151  * @uses has_shortcode();
    1152  *
    11531058 * @param string $text
    11541059 * @return bool
     
    11911096 * @since 2.0.0 bbPress (r3344)
    11921097 *
    1193  * @uses bbp_is_single_forum()
    1194  * @uses bbp_is_single_topic()
    1195  * @uses bbp_is_topic_edit()
    1196  * @uses bbp_is_topic_merge()
    1197  * @uses bbp_is_topic_split()
    1198  * @uses bbp_is_single_reply()
    1199  * @uses bbp_is_reply_edit()
    1200  * @uses bbp_is_reply_move()
    1201  * @uses bbp_is_single_view()
    1202  * @uses bbp_is_single_user_edit()
    1203  * @uses bbp_is_single_user()
    1204  * @uses bbp_is_user_home()
    1205  * @uses bbp_is_subscriptions()
    1206  * @uses bbp_is_favorites()
    1207  * @uses bbp_is_topics_created()
    1208  * @uses bbp_is_replies_created()
    1209  * @uses bbp_has_shortcode()
    1210  *
    12111098 * @return bool In a bbPress page
    12121099 */
     
    13171204 *  - action: The action being taken
    13181205 *  - context: The context the action is being taken from
    1319  * @uses add_query_arg() To add a arg to the url
    1320  * @uses site_url() Toget the site url
    1321  * @uses apply_filters() Calls 'bbp_wp_login_action' with the url and args
    13221206 */
    13231207function bbp_wp_login_action( $args = array() ) {
     
    13331217     *  - action: The action being taken
    13341218     *  - context: The context the action is being taken from
    1335      * @uses add_query_arg() To add a arg to the url
    1336      * @uses site_url() Toget the site url
    1337      * @uses apply_filters() Calls 'bbp_wp_login_action' with the url and args
    13381219     */
    13391220    function bbp_get_wp_login_action( $args = array() ) {
     
    13661247 *
    13671248 * @param string $redirect_to Pass a URL to redirect to
    1368  *
    1369  * @uses wp_get_referer() To get the referer
    1370  * @uses esc_attr() To escape the url
    1371  * @uses apply_filters() Calls 'bbp_redirect_to_field', passes field and to
    13721249 */
    13731250function bbp_redirect_to_field( $redirect_to = '' ) {
     
    14011278 * @param string $input_type Type of input. Default: text. Accepts:
    14021279 *                            textarea|password|select|radio|checkbox
    1403  * @uses bbp_get_sanitize_val() To sanitize the value.
    14041280 */
    14051281function bbp_sanitize_val( $request = '', $input_type = 'text' ) {
     
    14171293     * @param string $input_type Type of input. Default: text. Accepts:
    14181294     *                            textarea|password|select|radio|checkbox
    1419      * @uses esc_attr() To escape the string
    1420      * @uses apply_filters() Calls 'bbp_get_sanitize_val' with the sanitized
    1421      *                        value, request and input type
     1295     *
    14221296     * @return string Sanitized value ready for screen display
    14231297     */
     
    14831357     *
    14841358     * @link https://bbpress.trac.wordpress.org/attachment/ticket/2714 Trac Ticket
    1485      * @uses apply_filters Allows return value to be filtered
    14861359     * @param int $auto_increment Optional. Default true. Set to false to
    14871360     *                             prevent the increment
     
    15811454     *  - disable_categories: Disable forum categories and closed forums?
    15821455     *                         Defaults to true. Only for forums and when
    1583      *                         the category option is displayed.
    1584      * @uses BBP_Walker_Dropdown() As the default walker to generate the
    1585      *                              dropdown
    1586      * @uses current_user_can() To check if the current user can read
    1587      *                           private forums
    1588      * @uses bbp_get_forum_post_type() To get the forum post type
    1589      * @uses bbp_get_topic_post_type() To get the topic post type
    1590      * @uses walk_page_dropdown_tree() To generate the dropdown using the
    1591      *                                  walker
    1592      * @uses apply_filters() Calls 'bbp_get_dropdown' with the dropdown
    1593      *                        and args
    15941456     * @return string The dropdown
    15951457     */
     
    17331595 *
    17341596 * @since 2.1.0 bbPress (r3553)
    1735  *
    1736  * @uses bbp_is_forum_edit() To check if it's the forum edit page
    1737  * @uses wp_nonce_field() To generate hidden nonce fields
    1738  * @uses bbp_forum_id() To output the forum id
    1739  * @uses bbp_is_single_forum() To check if it's a forum page
    1740  * @uses bbp_forum_id() To output the forum id
    17411597 */
    17421598function bbp_forum_form_fields() {
     
    17761632 *
    17771633 * @since 2.0.0 bbPress (r2753)
    1778  *
    1779  * @uses bbp_is_topic_edit() To check if it's the topic edit page
    1780  * @uses wp_nonce_field() To generate hidden nonce fields
    1781  * @uses bbp_topic_id() To output the topic id
    1782  * @uses bbp_is_single_forum() To check if it's a forum page
    1783  * @uses bbp_forum_id() To output the forum id
    17841634 */
    17851635function bbp_topic_form_fields() {
     
    18191669 *
    18201670 * @since 2.0.0 bbPress (r2753)
    1821  *
    1822  * @uses bbp_is_reply_edit() To check if it's the reply edit page
    1823  * @uses wp_nonce_field() To generate hidden nonce fields
    1824  * @uses bbp_reply_id() To output the reply id
    1825  * @uses bbp_topic_id() To output the topic id
    1826  * @uses bbp_forum_id() To output the forum id
    18271671 */
    18281672function bbp_reply_form_fields() {
     
    18621706 *
    18631707 * @since 2.0.0 bbPress (r2690)
    1864  *
    1865  * @uses bbp_displayed_user_id() To output the displayed user id
    1866  * @uses wp_nonce_field() To generate a hidden referer field
    18671708 */
    18681709function bbp_edit_user_form_fields() {
     
    18811722 *
    18821723 * @since 2.0.0 bbPress (r2756)
    1883  *
    1884  * @uses wp_nonce_field() To generate a hidden nonce field
    1885  * @uses bbp_topic_id() To output the topic id
    18861724 */
    18871725function bbp_merge_topic_form_fields() {
     
    19001738 *
    19011739 * @since 2.0.0 bbPress (r2756)
    1902  *
    1903  * @uses wp_nonce_field() To generate a hidden nonce field
    19041740 */
    19051741function bbp_split_topic_form_fields() {
     
    19161752 *
    19171753 * Output the required hidden fields when moving a reply
    1918  *
    1919  * @uses wp_nonce_field() To generate a hidden nonce field
    19201754 */
    19211755function bbp_move_reply_form_fields() {
     
    19341768 *
    19351769 * @param array $args
    1936  * @uses bbp_get_the_content() To return the content to output
    19371770 */
    19381771function bbp_the_content( $args = array() ) {
     
    19451778     *
    19461779     * @param array $args
    1947      *
    1948      * @uses apply_filter() To filter args and output
    1949      * @uses wp_parse_pargs() To compare args
    1950      * @uses bbp_use_wp_editor() To see if WP editor is in use
    1951      * @uses bbp_is_edit() To see if we are editing something
    1952      * @uses wp_editor() To output the WordPress editor
    19531780     *
    19541781     * @return string HTML from output buffer
     
    21321959 *
    21331960 * @param string $view Optional. View id
    2134  * @uses bbp_get_view_id() To get the view id
    21351961 */
    21361962function bbp_view_id( $view = '' ) {
     
    21461972     *
    21471973     * @param string $view Optional. View id.
    2148      * @uses sanitize_title() To sanitize the view id
    2149      * @uses get_query_var() To get the view id query variable
    2150      * @uses bbp_get_view_rewrite_id() To get the view rewrite ID
    21511974     * @return bool|string ID on success, false on failure
    21521975     */
     
    21751998 *
    21761999 * @param string $view Optional. View id
    2177  * @uses bbp_get_view_title() To get the view title
    21782000 */
    21792001function bbp_view_title( $view = '' ) {
     
    21902012     *
    21912013     * @param string $view Optional. View id
    2192      * @uses bbp_get_view_id() To get the view id
    21932014     * @return bool|string Title on success, false on failure
    21942015     */
     
    22102031 *
    22112032 * @param string $view Optional. View id
    2212  * @uses bbp_get_view_url() To get the view url
    22132033 */
    22142034function bbp_view_url( $view = false ) {
     
    22212041     *
    22222042     * @param string $view Optional. View id
    2223      * @uses sanitize_title() To sanitize the view id
    2224      * @uses home_url() To get blog home url
    2225      * @uses add_query_arg() To add custom args to the url
    2226      * @uses apply_filters() Calls 'bbp_get_view_url' with the view url,
    22272043     *                        used view id
    22282044     * @return string View url (or home url if the view was not found)
     
    22592075 * @since 2.0.0 bbPress (r2980)
    22602076 *
    2261  * @uses bbp_get_query_name() Get the query var '_bbp_query_name'
    22622077 * @return bool True if match, false if not
    22632078 */
     
    22712086 * @since 2.0.0 bbPress (r2695)
    22722087 *
    2273  * @uses get_query_var() To get the query var '_bbp_query_name'
    22742088 * @return string To return the query var value
    22752089 */
     
    22842098 *
    22852099 * @param string $name What to set the query var to
    2286  * @uses set_query_var() To set the query var '_bbp_query_name'
    22872100 */
    22882101function bbp_set_query_name( $name = '' )  {
     
    22952108 * @since 2.0.0 bbPress (r2692)
    22962109 *
    2297  * @uses bbp_set_query_name() To set the query var '_bbp_query_name' value to ''
    22982110 */
    22992111function bbp_reset_query_name() {
     
    23112123 * @param bool $current_page Include the current item
    23122124 * @param bool $root Include the root page if one exists
    2313  * @uses bbp_get_breadcrumb() To get the breadcrumb
    23142125 */
    23152126function bbp_title_breadcrumb( $args = array() ) {
     
    23252136 * @param bool $current_page Include the current item
    23262137 * @param bool $root Include the root page if one exists
    2327  * @uses bbp_get_breadcrumb() To get the breadcrumb
    23282138 */
    23292139function bbp_breadcrumb( $args = array() ) {
     
    23392149     * @param bool $root Include the root page if one exists
    23402150     *
    2341      * @uses get_post() To get the post
    2342      * @uses bbp_get_forum_permalink() To get the forum link
    2343      * @uses bbp_get_topic_permalink() To get the topic link
    2344      * @uses bbp_get_reply_permalink() To get the reply link
    2345      * @uses get_permalink() To get the permalink
    2346      * @uses bbp_get_forum_post_type() To get the forum post type
    2347      * @uses bbp_get_topic_post_type() To get the topic post type
    2348      * @uses bbp_get_reply_post_type() To get the reply post type
    2349      * @uses bbp_get_forum_title() To get the forum title
    2350      * @uses bbp_get_topic_title() To get the topic title
    2351      * @uses bbp_get_reply_title() To get the reply title
    2352      * @uses get_the_title() To get the title
    2353      * @uses apply_filters() Calls 'bbp_get_breadcrumb' with the crumbs
    23542151     * @return string Breadcrumbs
    23552152     */
     
    26232420 *
    26242421 * @since 2.0.0 bbPress (r2780)
    2625  *
    2626  * @uses bbp_get_allowed_tags()
    26272422 */
    26282423function bbp_allowed_tags() {
     
    26372432     * @since 2.0.0 bbPress (r2780)
    26382433     *
    2639      * @uses bbp_kses_allowed_tags() To get the allowed tags
    2640      * @uses apply_filters() Calls 'bbp_allowed_tags' with the tags
    26412434     * @return string HTML allowed tags entity encoded.
    26422435     */
     
    26652458 *
    26662459 * @since 2.0.0 bbPress (r2688)
    2667  *
    2668  * @uses WP_Error bbPress::errors::get_error_codes() To get the error codes
    2669  * @uses WP_Error bbPress::errors::get_error_data() To get the error data
    2670  * @uses WP_Error bbPress::errors::get_error_messages() To get the error
    2671  *                                                       messages
    2672  * @uses is_wp_error() To check if it's a {@link WP_Error}
    26732460 */
    26742461function bbp_template_notices() {
     
    27322519 *
    27332520 * @param string $redirect_to Redirect to url
    2734  * @uses bbp_get_logout_link() To get the logout link
    27352521 */
    27362522function bbp_logout_link( $redirect_to = '' ) {
     
    27432529     *
    27442530     * @param string $redirect_to Redirect to url
    2745      * @uses wp_logout_url() To get the logout url
    2746      * @uses apply_filters() Calls 'bbp_get_logout_link' with the logout link and
    27472531     *                        redirect to url
    27482532     * @return string The logout link
     
    27682552 *                     various items within the page title.
    27692553 * @param string $seplocation Optional. Direction to display title, 'right'.
    2770  * @uses bbp_is_single_user() To check if it's a user profile page
    2771  * @uses bbp_is_single_user_edit() To check if it's a user profile edit page
    2772  * @uses bbp_is_user_home() To check if the profile page is of the current user
    2773  * @uses get_query_var() To get the user id
    2774  * @uses get_userdata() To get the user data
    2775  * @uses bbp_is_single_forum() To check if it's a forum
    2776  * @uses bbp_get_forum_title() To get the forum title
    2777  * @uses bbp_is_single_topic() To check if it's a topic
    2778  * @uses bbp_get_topic_title() To get the topic title
    2779  * @uses bbp_is_single_reply() To check if it's a reply
    2780  * @uses bbp_get_reply_title() To get the reply title
    2781  * @uses is_tax() To check if it's the tag page
    2782  * @uses get_queried_object() To get the queried object
    2783  * @uses bbp_is_single_view() To check if it's a view
    2784  * @uses bbp_get_view_title() To get the view title
    2785  * @uses apply_filters() Calls 'bbp_raw_title' with the title
    2786  * @uses apply_filters() Calls 'bbp_profile_page_wp_title' with the title,
    27872554 *                        separator and separator location
    27882555 * @return string The title
Note: See TracChangeset for help on using the changeset viewer.