Changeset 49670 for trunk/src/wp-includes/class-wp-rewrite.php

Timestamp:

11/19/2020 04:13:54 PM (5 years ago)

Author:

johnbillion

Message:

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

See #51800

File:

• trunk/src/wp-includes/class-wp-rewrite.php (modified) (3 diffs)

trunk/src/wp-includes/class-wp-rewrite.php

@@ -841 +841 @@
      * @param string $permalink_structure The permalink structure.
      * @param int    $ep_mask             Optional. Endpoint mask defining what endpoints are added to the structure.
-     *                                    Accepts `EP_NONE`, `EP_PERMALINK`, `EP_ATTACHMENT`, `EP_DATE`, `EP_YEAR`,
-     *                                    `EP_MONTH`, `EP_DAY`, `EP_ROOT`, `EP_COMMENTS`, `EP_SEARCH`, `EP_CATEGORIES`,
-     *                                    `EP_TAGS`, `EP_AUTHORS`, `EP_PAGES`, `EP_ALL_ARCHIVES`, and `EP_ALL`.
+     *                                    Accepts a mask of:
+     *                                    - `EP_ALL`
+     *                                    - `EP_NONE`
+     *                                    - `EP_ALL_ARCHIVES`
+     *                                    - `EP_ATTACHMENT`
+     *                                    - `EP_AUTHORS`
+     *                                    - `EP_CATEGORIES`
+     *                                    - `EP_COMMENTS`
+     *                                    - `EP_DATE`
+     *                                    - `EP_DAY`
+     *                                    - `EP_MONTH`
+     *                                    - `EP_PAGES`
+     *                                    - `EP_PERMALINK`
+     *                                    - `EP_ROOT`
+     *                                    - `EP_SEARCH`
+     *                                    - `EP_TAGS`
+     *                                    - `EP_YEAR`
      *                                    Default `EP_NONE`.
      * @param bool   $paged               Optional. Whether archive pagination rules should be added for the structure.
@@ -1683 +1697 @@
      * @param string      $name      Name of the endpoint.
      * @param int         $places    Endpoint mask describing the places the endpoint should be added.
+     *                               Accepts a mask of:
+     *                               - `EP_ALL`
+     *                               - `EP_NONE`
+     *                               - `EP_ALL_ARCHIVES`
+     *                               - `EP_ATTACHMENT`
+     *                               - `EP_AUTHORS`
+     *                               - `EP_CATEGORIES`
+     *                               - `EP_COMMENTS`
+     *                               - `EP_DATE`
+     *                               - `EP_DAY`
+     *                               - `EP_MONTH`
+     *                               - `EP_PAGES`
+     *                               - `EP_PERMALINK`
+     *                               - `EP_ROOT`
+     *                               - `EP_SEARCH`
+     *                               - `EP_TAGS`
+     *                               - `EP_YEAR`
      * @param string|bool $query_var Optional. Name of the corresponding query variable. Pass `false` to
      *                               skip registering a query_var for this endpoint. Defaults to the
@@ -1726 +1757 @@
      *                             Default true.
      *     @type int  $ep_mask     The endpoint mask defining which endpoints are added to the structure.
-     *                             Accepts `EP_NONE`, `EP_PERMALINK`, `EP_ATTACHMENT`, `EP_DATE`, `EP_YEAR`,
-     *                             `EP_MONTH`, `EP_DAY`, `EP_ROOT`, `EP_COMMENTS`, `EP_SEARCH`, `EP_CATEGORIES`,
-     *                             `EP_TAGS`, `EP_AUTHORS`, `EP_PAGES`, `EP_ALL_ARCHIVES`, and `EP_ALL`.
+     *                             Accepts a mask of:
+     *                             - `EP_ALL`
+     *                             - `EP_NONE`
+     *                             - `EP_ALL_ARCHIVES`
+     *                             - `EP_ATTACHMENT`
+     *                             - `EP_AUTHORS`
+     *                             - `EP_CATEGORIES`
+     *                             - `EP_COMMENTS`
+     *                             - `EP_DATE`
+     *                             - `EP_DAY`
+     *                             - `EP_MONTH`
+     *                             - `EP_PAGES`
+     *                             - `EP_PERMALINK`
+     *                             - `EP_ROOT`
+     *                             - `EP_SEARCH`
+     *                             - `EP_TAGS`
+     *                             - `EP_YEAR`
      *                             Default `EP_NONE`.
      *     @type bool $paged       Whether archive pagination rules should be added for the structure.