Changeset 54391

Timestamp:

10/04/2022 10:59:58 PM (4 years ago)

Author:

audrasjb

Message:

Docs: Various docblock fixes in WP_Rewrite class, as per documentation standards.

See #55646.

File:

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

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

@@ -414 +414 @@
 
         /**
-         * Retrieves all page and attachments for pages URIs.
+         * Retrieves all pages and attachments for pages URIs.
          *
          * The attachments are for those that have pages as parents and will be
@@ -617 +617 @@
 
         /**
-         * Retrieve the permalink structure for tags.
+         * Retrieves the permalink structure for tags.
          *
          * If the tag_base property has no value, then the tag structure will have
@@ -862 +862 @@
          * @param bool   $paged               Optional. Whether archive pagination rules should be added for the structure.
          *                                    Default true.
-         * @param bool   $feed                Optional Whether feed rewrite rules should be added for the structure.
+         * @param bool   $feed                Optional. Whether feed rewrite rules should be added for the structure.
          *                                    Default true.
          * @param bool   $forcomments         Optional. Whether the feed rules should be a query for a comments feed.
@@ -1246 +1246 @@
          * @param bool   $walk_dirs           Optional. Whether to create list of directories to walk over.
          *                                    Default false.
-         * @return array
+         * @return array An array of rewrite rules keyed by their regex pattern.
          */
         public function generate_rewrite_rule( $permalink_structure, $walk_dirs = false ) {