WordPress.org

Make WordPress Core

Changeset 49670


Ignore:
Timestamp:
11/19/2020 04:13:54 PM (11 months ago)
Author:
johnbillion
Message:

Docs: Clarify and standardise on terminology used for rewrite rule endpoint masks.

See #51800

Location:
trunk/src/wp-includes
Files:
2 edited

Legend:

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

    r49184 r49670  
    841841     * @param string $permalink_structure The permalink structure.
    842842     * @param int    $ep_mask             Optional. Endpoint mask defining what endpoints are added to the structure.
    843      *                                    Accepts `EP_NONE`, `EP_PERMALINK`, `EP_ATTACHMENT`, `EP_DATE`, `EP_YEAR`,
    844      *                                    `EP_MONTH`, `EP_DAY`, `EP_ROOT`, `EP_COMMENTS`, `EP_SEARCH`, `EP_CATEGORIES`,
    845      *                                    `EP_TAGS`, `EP_AUTHORS`, `EP_PAGES`, `EP_ALL_ARCHIVES`, and `EP_ALL`.
     843     *                                    Accepts a mask of:
     844     *                                    - `EP_ALL`
     845     *                                    - `EP_NONE`
     846     *                                    - `EP_ALL_ARCHIVES`
     847     *                                    - `EP_ATTACHMENT`
     848     *                                    - `EP_AUTHORS`
     849     *                                    - `EP_CATEGORIES`
     850     *                                    - `EP_COMMENTS`
     851     *                                    - `EP_DATE`
     852     *                                    - `EP_DAY`
     853     *                                    - `EP_MONTH`
     854     *                                    - `EP_PAGES`
     855     *                                    - `EP_PERMALINK`
     856     *                                    - `EP_ROOT`
     857     *                                    - `EP_SEARCH`
     858     *                                    - `EP_TAGS`
     859     *                                    - `EP_YEAR`
    846860     *                                    Default `EP_NONE`.
    847861     * @param bool   $paged               Optional. Whether archive pagination rules should be added for the structure.
     
    16831697     * @param string      $name      Name of the endpoint.
    16841698     * @param int         $places    Endpoint mask describing the places the endpoint should be added.
     1699     *                               Accepts a mask of:
     1700     *                               - `EP_ALL`
     1701     *                               - `EP_NONE`
     1702     *                               - `EP_ALL_ARCHIVES`
     1703     *                               - `EP_ATTACHMENT`
     1704     *                               - `EP_AUTHORS`
     1705     *                               - `EP_CATEGORIES`
     1706     *                               - `EP_COMMENTS`
     1707     *                               - `EP_DATE`
     1708     *                               - `EP_DAY`
     1709     *                               - `EP_MONTH`
     1710     *                               - `EP_PAGES`
     1711     *                               - `EP_PERMALINK`
     1712     *                               - `EP_ROOT`
     1713     *                               - `EP_SEARCH`
     1714     *                               - `EP_TAGS`
     1715     *                               - `EP_YEAR`
    16851716     * @param string|bool $query_var Optional. Name of the corresponding query variable. Pass `false` to
    16861717     *                               skip registering a query_var for this endpoint. Defaults to the
     
    17261757     *                             Default true.
    17271758     *     @type int  $ep_mask     The endpoint mask defining which endpoints are added to the structure.
    1728      *                             Accepts `EP_NONE`, `EP_PERMALINK`, `EP_ATTACHMENT`, `EP_DATE`, `EP_YEAR`,
    1729      *                             `EP_MONTH`, `EP_DAY`, `EP_ROOT`, `EP_COMMENTS`, `EP_SEARCH`, `EP_CATEGORIES`,
    1730      *                             `EP_TAGS`, `EP_AUTHORS`, `EP_PAGES`, `EP_ALL_ARCHIVES`, and `EP_ALL`.
     1759     *                             Accepts a mask of:
     1760     *                             - `EP_ALL`
     1761     *                             - `EP_NONE`
     1762     *                             - `EP_ALL_ARCHIVES`
     1763     *                             - `EP_ATTACHMENT`
     1764     *                             - `EP_AUTHORS`
     1765     *                             - `EP_CATEGORIES`
     1766     *                             - `EP_COMMENTS`
     1767     *                             - `EP_DATE`
     1768     *                             - `EP_DAY`
     1769     *                             - `EP_MONTH`
     1770     *                             - `EP_PAGES`
     1771     *                             - `EP_PERMALINK`
     1772     *                             - `EP_ROOT`
     1773     *                             - `EP_SEARCH`
     1774     *                             - `EP_TAGS`
     1775     *                             - `EP_YEAR`
    17311776     *                             Default `EP_NONE`.
    17321777     *     @type bool $paged       Whether archive pagination rules should be added for the structure.
  • trunk/src/wp-includes/rewrite.php

    r49108 r49670  
    88
    99/**
    10  * Endpoint Mask for default, which is nothing.
     10 * Endpoint mask that matches nothing.
    1111 *
    1212 * @since 2.1.0
     
    1515
    1616/**
    17  * Endpoint Mask for Permalink.
     17 * Endpoint mask that matches post permalinks.
    1818 *
    1919 * @since 2.1.0
     
    2222
    2323/**
    24  * Endpoint Mask for Attachment.
     24 * Endpoint mask that matches attachment permalinks.
    2525 *
    2626 * @since 2.1.0
     
    2929
    3030/**
    31  * Endpoint Mask for date.
     31 * Endpoint mask that matches any date archives.
    3232 *
    3333 * @since 2.1.0
     
    3636
    3737/**
    38  * Endpoint Mask for year
     38 * Endpoint mask that matches yearly archives.
    3939 *
    4040 * @since 2.1.0
     
    4343
    4444/**
    45  * Endpoint Mask for month.
     45 * Endpoint mask that matches monthly archives.
    4646 *
    4747 * @since 2.1.0
     
    5050
    5151/**
    52  * Endpoint Mask for day.
     52 * Endpoint mask that matches daily archives.
    5353 *
    5454 * @since 2.1.0
     
    5757
    5858/**
    59  * Endpoint Mask for root.
     59 * Endpoint mask that matches the site root.
    6060 *
    6161 * @since 2.1.0
     
    6464
    6565/**
    66  * Endpoint Mask for comments.
     66 * Endpoint mask that matches comment feeds.
    6767 *
    6868 * @since 2.1.0
     
    7171
    7272/**
    73  * Endpoint Mask for searches.
     73 * Endpoint mask that matches searches.
     74 *
     75 * Note that this only matches a search at a "pretty" URL such as
     76 * `/search/my-search-term`, not `?s=my-search-term`.
    7477 *
    7578 * @since 2.1.0
     
    7881
    7982/**
    80  * Endpoint Mask for categories.
     83 * Endpoint mask that matches category archives.
    8184 *
    8285 * @since 2.1.0
     
    8588
    8689/**
    87  * Endpoint Mask for tags.
     90 * Endpoint mask that matches tag archives.
    8891 *
    8992 * @since 2.3.0
     
    9295
    9396/**
    94  * Endpoint Mask for authors.
     97 * Endpoint mask that matches author archives.
    9598 *
    9699 * @since 2.1.0
     
    99102
    100103/**
    101  * Endpoint Mask for pages.
     104 * Endpoint mask that matches pages.
    102105 *
    103106 * @since 2.1.0
     
    106109
    107110/**
    108  * Endpoint Mask for all archive views.
     111 * Endpoint mask that matches all archive views.
    109112 *
    110113 * @since 3.7.0
     
    113116
    114117/**
    115  * Endpoint Mask for everything.
     118 * Endpoint mask that matches everything.
    116119 *
    117120 * @since 2.1.0
     
    309312 * @param string      $name      Name of the endpoint.
    310313 * @param int         $places    Endpoint mask describing the places the endpoint should be added.
     314 *                               Accepts a mask of:
     315 *                               - `EP_ALL`
     316 *                               - `EP_NONE`
     317 *                               - `EP_ALL_ARCHIVES`
     318 *                               - `EP_ATTACHMENT`
     319 *                               - `EP_AUTHORS`
     320 *                               - `EP_CATEGORIES`
     321 *                               - `EP_COMMENTS`
     322 *                               - `EP_DATE`
     323 *                               - `EP_DAY`
     324 *                               - `EP_MONTH`
     325 *                               - `EP_PAGES`
     326 *                               - `EP_PERMALINK`
     327 *                               - `EP_ROOT`
     328 *                               - `EP_SEARCH`
     329 *                               - `EP_TAGS`
     330 *                               - `EP_YEAR`
    311331 * @param string|bool $query_var Name of the corresponding query variable. Pass `false` to skip registering a query_var
    312332 *                               for this endpoint. Defaults to the value of `$name`.
Note: See TracChangeset for help on using the changeset viewer.