Changeset 58706 for trunk

Timestamp:

07/11/2024 06:22:51 AM (2 years ago)

Author:

SergeyBiryukov

Message:

Docs: Fix typos in various REST API DocBlocks and comments.

Follow-up to [34928], [43739], [46422], [50717], [51973], [54528].

Props antonvlasenko.
Fixes #61593.

Location:

trunk/src/wp-includes/rest-api

Files:

• class-wp-rest-request.php (modified) (1 diff)
• endpoints/class-wp-rest-attachments-controller.php (modified) (4 diffs)
• endpoints/class-wp-rest-posts-controller.php (modified) (2 diffs)
• endpoints/class-wp-rest-terms-controller.php (modified) (1 diff)
• endpoints/class-wp-rest-url-details-controller.php (modified) (5 diffs)
• search/class-wp-rest-post-search-handler.php (modified) (1 diff)

trunk/src/wp-includes/rest-api/class-wp-rest-request.php

@@ -166 +166 @@
          *
          * Ensures that header names are always treated the same regardless of
-         * source. Header names are always case insensitive.
+         * source. Header names are always case-insensitive.
          *
          * Note that we treat `-` (dashes) and `_` (underscores) as the same

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php

@@ -451 +451 @@
 
         /**
-         * Performs post processing on an attachment.
+         * Performs post-processing on an attachment.
          *
          * @since 5.3.0
@@ -472 +472 @@
 
         /**
-         * Checks if a given request can perform post processing on an attachment.
+         * Checks if a given request can perform post-processing on an attachment.
          *
          * @since 5.3.0
@@ -602 +602 @@
                         switch ( $modifier['type'] ) {
                                 case 'rotate':
-                                        // Rotation direction: clockwise vs. counter clockwise.
+                                        // Rotation direction: clockwise vs. counterclockwise.
                                         $rotate = 0 - $args['angle'];
 
@@ -662 +662 @@
                 $filename = "{$image_name}.{$image_ext}";
 
-                // Create the uploads sub-directory if needed.
+                // Create the uploads subdirectory if needed.
                 $uploads = wp_upload_dir();
 

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

@@ -184 +184 @@
          * @param bool    $required Whether the post requires a password check.
          * @param WP_Post $post     The post been password checked.
-         * @return bool Result of password check taking in to account REST API considerations.
+         * @return bool Result of password check taking into account REST API considerations.
          */
         public function check_password_required( $required, $post ) {
@@ -2052 +2052 @@
          * By default, WordPress will show password protected posts with a title of
          * "Protected: %s", as the REST API communicates the protected status of a post
-         * in a machine readable format, we remove the "Protected: " prefix.
+         * in a machine-readable format, we remove the "Protected: " prefix.
          *
          * @since 4.7.0

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php

@@ -165 +165 @@
                 }
 
-                // Otherwise grant access if the post is readable by the logged in user.
+                // Otherwise grant access if the post is readable by the logged-in user.
                 if ( current_user_can( 'read_post', $post->ID ) ) {
                         return true;

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-url-details-controller.php

@@ -348 +348 @@
          *
          * @param array $meta_elements {
-         *     A multi-dimensional indexed array on success, else empty array.
+         *     A multidimensional indexed array on success, else empty array.
          *
          *     @type string[] $0 Meta elements with a content attribute.
@@ -384 +384 @@
          *
          * @param array  $meta_elements {
-         *     A multi-dimensional indexed array on success, else empty array.
+         *     A multidimensional indexed array on success, else empty array.
          *
          *     @type string[] $0 Meta elements with a content attribute.
@@ -526 +526 @@
          * @param string $html The string of HTML to be parsed.
          * @return array {
-         *     A multi-dimensional indexed array on success, else empty array.
+         *     A multidimensional indexed array on success, else empty array.
          *
          *     @type string[] $0 Meta elements with a content attribute.
@@ -589 +589 @@
                                 /*
                                 * These are the options:
-                                * - i : case insensitive
+                                * - i : case-insensitive
                                 * - s : allows newline characters for the . match (needed for multiline elements)
                                 * - U means non-greedy matching
@@ -638 +638 @@
                                 /*
                                  * These are the options:
-                                 * - i : case insensitive
+                                 * - i : case-insensitive
                                  * - s : allows newline characters for the . match (needed for multiline elements)
                                  * - U means non-greedy matching

trunk/src/wp-includes/rest-api/search/class-wp-rest-post-search-handler.php

@@ -188 +188 @@
          * By default, WordPress will show password protected posts with a title of
          * "Protected: %s". As the REST API communicates the protected status of a post
-         * in a machine readable format, we remove the "Protected: " prefix.
+         * in a machine-readable format, we remove the "Protected: " prefix.
          *
          * @since 5.0.0