Make WordPress Core


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

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

See #51800

File:
1 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.
Note: See TracChangeset for help on using the changeset viewer.