WordPress.org

Make WordPress Core

Changeset 45735


Ignore:
Timestamp:
08/04/2019 01:18:54 AM (4 months ago)
Author:
SergeyBiryukov
Message:

Docs: Add missing description for $wp_rewrite global.

See #45604, #47110.

Location:
trunk/src
Files:
20 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/misc.php

    r45696 r45735  
    236236 * @since 1.5.0
    237237 *
    238  * @global WP_Rewrite $wp_rewrite
     238 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    239239 *
    240240 * @return bool|null True on write success, false on failure. Null in multisite.
     
    273273 * @since 2.8.0
    274274 *
    275  * @global WP_Rewrite $wp_rewrite
     275 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    276276 *
    277277 * @return bool|null True on write success, false on failure. Null in multisite.
  • trunk/src/wp-admin/includes/schema.php

    r45734 r45735  
    948948 * @since 3.0.0
    949949 *
    950  * @global wpdb       $wpdb
     950 * @global wpdb       $wpdb         WordPress database abstraction object.
    951951 * @global object     $current_site
    952  * @global WP_Rewrite $wp_rewrite
     952 * @global WP_Rewrite $wp_rewrite   WordPress rewrite component.
    953953 *
    954954 * @param int    $network_id        ID of network to populate.
  • trunk/src/wp-admin/includes/upgrade.php

    r45734 r45735  
    131131     *
    132132     * @global wpdb       $wpdb         WordPress database abstraction object.
    133      * @global WP_Rewrite $wp_rewrite
     133     * @global WP_Rewrite $wp_rewrite   WordPress rewrite component.
    134134     * @global string     $table_prefix
    135135     *
  • trunk/src/wp-includes/author-template.php

    r45674 r45735  
    335335 * @since 2.1.0
    336336 *
    337  * @global WP_Rewrite $wp_rewrite
     337 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    338338 *
    339339 * @param int    $author_id       Author ID.
  • trunk/src/wp-includes/canonical.php

    r45734 r45735  
    2929 * @since 2.3.0
    3030 *
    31  * @global WP_Rewrite $wp_rewrite
     31 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    3232 * @global bool $is_IIS
    3333 * @global WP_Query $wp_query
     
    729729 * @since 3.4.0
    730730 *
    731  * @global WP_Rewrite $wp_rewrite
     731 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    732732 */
    733733function wp_redirect_admin_locations() {
  • trunk/src/wp-includes/category-template.php

    r45723 r45735  
    122122 * @since 1.5.1
    123123 *
    124  * @global WP_Rewrite $wp_rewrite
     124 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    125125 *
    126126 * @param string $separator Optional. Separator between the categories. By default, the links are placed
  • trunk/src/wp-includes/class-wp-post-type.php

    r41162 r45735  
    527527     * @since 4.6.0
    528528     *
    529      * @global WP_Rewrite $wp_rewrite WordPress Rewrite Component.
     529     * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    530530     * @global WP         $wp         Current WordPress environment instance.
    531531     */
  • trunk/src/wp-includes/class-wp.php

    r45611 r45735  
    127127     * @since 2.0.0
    128128     *
    129      * @global WP_Rewrite $wp_rewrite
     129     * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    130130     *
    131131     * @param array|string $extra_query_vars Set the extra query variables.
  • trunk/src/wp-includes/comment-template.php

    r45734 r45735  
    688688 * @see get_page_of_comment()
    689689 *
    690  * @global WP_Rewrite $wp_rewrite
     690 * @global WP_Rewrite $wp_rewrite      WordPress rewrite component.
    691691 * @global bool       $in_comment_loop
    692692 *
  • trunk/src/wp-includes/general-template.php

    r45734 r45735  
    39273927 *
    39283928 * @global WP_Query   $wp_query
    3929  * @global WP_Rewrite $wp_rewrite
     3929 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    39303930 *
    39313931 * @param string|array $args {
  • trunk/src/wp-includes/link-template.php

    r45590 r45735  
    3838 * @since 2.2.0
    3939 *
    40  * @global WP_Rewrite $wp_rewrite
     40 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    4141 *
    4242 * @param string $string      URL with or without a trailing slash.
     
    253253 * @since 3.0.0
    254254 *
    255  * @global WP_Rewrite $wp_rewrite
     255 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    256256 *
    257257 * @param int|WP_Post $id        Optional. Post ID or post object. Default is the global `$post`.
     
    356356 * @access private
    357357 *
    358  * @global WP_Rewrite $wp_rewrite
     358 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    359359 *
    360360 * @param int|WP_Post $post      Optional. Post ID or object. Default uses the global `$post`.
     
    402402 * @since 2.0.0
    403403 *
    404  * @global WP_Rewrite $wp_rewrite
     404 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    405405 *
    406406 * @param int|object $post      Optional. Post ID or object. Default uses the global `$post`.
     
    463463 * @since 1.5.0
    464464 *
    465  * @global WP_Rewrite $wp_rewrite
     465 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    466466 *
    467467 * @param int|bool $year False for current year or year for permalink.
     
    497497 * @since 1.0.0
    498498 *
    499  * @global WP_Rewrite $wp_rewrite
     499 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    500500 *
    501501 * @param bool|int $year  False for current year. Integer of year.
     
    537537 * @since 1.0.0
    538538 *
    539  * @global WP_Rewrite $wp_rewrite
     539 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    540540 *
    541541 * @param bool|int $year  False for current year. Integer of year.
     
    607607 * @since 1.5.0
    608608 *
    609  * @global WP_Rewrite $wp_rewrite
     609 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    610610 *
    611611 * @param string $feed Optional. Feed type. Default empty.
     
    10771077 * @since  3.0.0
    10781078 *
    1079  * @global WP_Rewrite $wp_rewrite
     1079 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    10801080 *
    10811081 * @param string $query Optional. The query string to use. If empty the current query is used. Default empty.
     
    11181118 * @since 2.5.0
    11191119 *
    1120  * @global WP_Rewrite $wp_rewrite
     1120 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    11211121 *
    11221122 * @param string $search_query Optional. Search query. Default empty.
     
    11581158 * @since 2.5.0
    11591159 *
    1160  * @global WP_Rewrite $wp_rewrite
     1160 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    11611161 *
    11621162 * @param string $search_query Optional. Search query. Default empty.
     
    11911191 * @since 4.5.0 Support for posts was added.
    11921192 *
    1193  * @global WP_Rewrite $wp_rewrite
     1193 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    11941194 *
    11951195 * @param string $post_type Post type.
     
    21972197 * @since 1.5.0
    21982198 *
    2199  * @global WP_Rewrite $wp_rewrite
     2199 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    22002200 *
    22012201 * @param int  $pagenum Optional. Page number. Default 1.
     
    27562756 * @since 2.7.0
    27572757 *
    2758  * @global WP_Rewrite $wp_rewrite
     2758 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    27592759 *
    27602760 * @param int $pagenum  Optional. Page number. Default 1.
     
    29132913 * @since 2.7.0
    29142914 *
    2915  * @global WP_Rewrite $wp_rewrite
     2915 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    29162916 *
    29172917 * @param string|array $args Optional args. See paginate_links(). Default empty array.
  • trunk/src/wp-includes/nav-menu-template.php

    r45590 r45735  
    296296 *
    297297 * @global WP_Query   $wp_query
    298  * @global WP_Rewrite $wp_rewrite
     298 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    299299 *
    300300 * @param array $menu_items The current menu item objects to which to add the class property information.
  • trunk/src/wp-includes/post-formats.php

    r43592 r45735  
    184184 * @since 3.1.0
    185185 *
    186  * @global WP_Rewrite $wp_rewrite
     186 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    187187 *
    188188 * @param string $link
  • trunk/src/wp-includes/post-template.php

    r45667 r45735  
    10291029 * @access private
    10301030 *
    1031  * @global WP_Rewrite $wp_rewrite
     1031 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    10321032 *
    10331033 * @param int $i Page number.
  • trunk/src/wp-includes/post.php

    r45724 r45735  
    41984198 * @since 2.8.0
    41994199 *
    4200  * @global wpdb       $wpdb WordPress database abstraction object.
    4201  * @global WP_Rewrite $wp_rewrite
     4200 * @global wpdb       $wpdb       WordPress database abstraction object.
     4201 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    42024202 *
    42034203 * @param string $slug        The desired slug (post_name).
  • trunk/src/wp-includes/rest-api.php

    r45632 r45735  
    152152 *
    153153 * @see add_rewrite_rule()
    154  * @global WP_Rewrite $wp_rewrite
     154 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    155155 */
    156156function rest_api_register_rewrites() {
     
    339339 *
    340340 * @todo Check if this is even necessary
    341  * @global WP_Rewrite $wp_rewrite
     341 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    342342 *
    343343 * @param int    $blog_id Optional. Blog ID. Default of null returns URL for current blog.
  • trunk/src/wp-includes/rewrite.php

    r45699 r45735  
    128128 * @since 4.4.0 Array support was added to the `$query` parameter.
    129129 *
    130  * @global WP_Rewrite $wp_rewrite WordPress Rewrite Component.
     130 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    131131 *
    132132 * @param string       $regex Regular expression to match request against.
     
    150150 * @since 2.1.0
    151151 *
    152  * @global WP_Rewrite $wp_rewrite
     152 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    153153 * @global WP         $wp
    154154 *
     
    239239 * @since 2.1.0
    240240 *
    241  * @global WP_Rewrite $wp_rewrite
     241 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    242242 *
    243243 * @param string   $feedname Feed name.
     
    267267 * @since 3.0.0
    268268 *
    269  * @global WP_Rewrite $wp_rewrite
     269 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    270270 *
    271271 * @param bool $hard Whether to update .htaccess (hard flush) or just update
     
    305305 * @since 4.3.0 Added support for skipping query var registration by passing `false` to `$query_var`.
    306306 *
    307  * @global WP_Rewrite $wp_rewrite
     307 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    308308 *
    309309 * @param string      $name      Name of the endpoint.
     
    460460 * @since 1.0.0
    461461 *
    462  * @global WP_Rewrite $wp_rewrite
     462 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    463463 * @global WP         $wp
    464464 *
  • trunk/src/wp-includes/taxonomy.php

    r45734 r45735  
    2020 * @since 2.8.0
    2121 *
    22  * @global WP_Rewrite $wp_rewrite The WordPress rewrite class.
     22 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    2323 */
    2424function create_initial_taxonomies() {
     
    41694169 * @since 2.5.0
    41704170 *
    4171  * @global WP_Rewrite $wp_rewrite
     4171 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    41724172 *
    41734173 * @param object|int|string $term     The term object, ID, or slug whose link will be retrieved.
  • trunk/src/wp-includes/template.php

    r45734 r45735  
    688688 * @global bool       $wp_did_header
    689689 * @global WP_Query   $wp_query
    690  * @global WP_Rewrite $wp_rewrite
     690 * @global WP_Rewrite $wp_rewrite    WordPress rewrite component.
    691691 * @global wpdb       $wpdb          WordPress database abstraction object.
    692692 * @global string     $wp_version
  • trunk/src/wp-settings.php

    r45734 r45735  
    424424 * Holds the WordPress Rewrite object for creating pretty URLs
    425425 *
    426  * @global WP_Rewrite $wp_rewrite
     426 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    427427 * @since 1.5.0
    428428 */
Note: See TracChangeset for help on using the changeset viewer.