WordPress.org

Make WordPress Core

Changeset 33236


Ignore:
Timestamp:
07/13/2015 09:53:02 PM (6 years ago)
Author:
DrewAPicture
Message:

Add better line wrapping and syntax improvements to the description for wp_resolve_numeric_slug_conflicts(), added in 4.3.

Also properly mark $query_vars as optional in the parameter description.

See [32648]. See #32891.

File:
1 edited

Legend:

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

    r33235 r33236  
    288288 * Resolve numeric slugs that collide with date permalinks.
    289289 *
    290  * Permalinks of posts with numeric slugs can sometimes look to `WP_Query::parse_query()` like a date archive,
    291  * as when your permalink structure is `/%year%/%postname%/` and a post with post_name '05' has the URL
    292  * `/2015/05/`. This function detects conflicts of this type and resolves them in favor of the post permalink.
    293  *
    294  * Note that, since 4.3.0, `wp_unique_post_slug()` prevents the creation of post slugs that would result in a date
    295  * archive conflict. The resolution performed in this function is primarily for legacy content, as well as cases when
    296  * the admin has changed the site's permalink structure in a way that introduces URL conflicts.
     290 * Permalinks of posts with numeric slugs can sometimes look to WP_Query::parse_query()
     291 * like a date archive, as when your permalink structure is `/%year%/%postname%/` and
     292 * a post with post_name '05' has the URL `/2015/05/`.
     293 *
     294 * This function detects conflicts of this type and resolves them in favor of the
     295 * post permalink.
     296 *
     297 * Note that, since 4.3.0, wp_unique_post_slug() prevents the creation of post slugs
     298 * that would result in a date archive conflict. The resolution performed in this
     299 * function is primarily for legacy content, as well as cases when the admin has changed
     300 * the site's permalink structure in a way that introduces URL conflicts.
    297301 *
    298302 * @since 4.3.0
    299303 *
    300  * @param array $query_vars Query variables for setting up the loop, as determined in `WP::parse_request()`.
     304 * @param array $query_vars Optional. Query variables for setting up the loop, as determined in
     305 *                          WP::parse_request(). Default empty array.
    301306 * @return array Returns the original array of query vars, with date/post conflicts resolved.
    302307 */
Note: See TracChangeset for help on using the changeset viewer.