Changeset 56192 for trunk/src/wp-includes/rest-api.php

Timestamp:

07/10/2023 10:46:22 PM (14 months ago)

Author:

audrasjb

Message:

Docs: Replace multiple single line comments with multi-line comments.

This changeset updates various comments as per WordPress PHP Inline Documentation Standards.
See ​https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#5-inline-comments.

Follow-up to [56174], [56175], [56176], [56177], [56178], [56179], [56180], [56191].

Props costdev, audrasjb.
See #58459.

File:

• trunk/src/wp-includes/rest-api.php (modified) (6 diffs)

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

@@ -474 +474 @@
     } else {
         $url = trailingslashit( get_home_url( $blog_id, '', $scheme ) );
-        // nginx only allows HTTP/1.0 methods when redirecting from / to /index.php.
-        // To work around this, we manually add index.php to the URL, avoiding the redirect.
+        /*
+         * nginx only allows HTTP/1.0 methods when redirecting from / to /index.php.
+         * To work around this, we manually add index.php to the URL, avoiding the redirect.
+         */
         if ( ! str_ends_with( $url, 'index.php' ) ) {
             $url .= 'index.php';
@@ -633 +635 @@
     }
 
-    // While WP_HTTP_Response is the base class of WP_REST_Response, it doesn't provide
-    // all the required methods used in WP_REST_Server::dispatch().
+    /*
+     * While WP_HTTP_Response is the base class of WP_REST_Response, it doesn't provide
+     * all the required methods used in WP_REST_Server::dispatch().
+     */
     if ( $response instanceof WP_HTTP_Response ) {
         return new WP_REST_Response(
@@ -946 +950 @@
 
     foreach ( $fields as $accepted_field ) {
-        // Check to see if $field is the parent of any item in $fields.
-        // A field "parent" should be accepted if "parent.child" is accepted.
+        /*
+         * Check to see if $field is the parent of any item in $fields.
+         * A field "parent" should be accepted if "parent.child" is accepted.
+         */
         if ( str_starts_with( $accepted_field, "$field." ) ) {
             return true;
         }
-        // Conversely, if "parent" is accepted, all "parent.child" fields
-        // should also be accepted.
+        /*
+         * Conversely, if "parent" is accepted, all "parent.child" fields
+         * should also be accepted.
+         */
         if ( str_starts_with( $field, "$accepted_field." ) ) {
             return true;
@@ -1610 +1618 @@
     );
 
-    // Both arrays and objects allow empty strings to be converted to their types.
-    // But the best answer for this type is a string.
+    /*
+     * Both arrays and objects allow empty strings to be converted to their types.
+     * But the best answer for this type is a string.
+     */
     if ( '' === $value && in_array( 'string', $types, true ) ) {
         return 'string';
@@ -2192 +2202 @@
     }
 
-    // The "format" keyword should only be applied to strings. However, for backward compatibility,
-    // we allow the "format" keyword if the type keyword was not specified, or was set to an invalid value.
+    /*
+     * The "format" keyword should only be applied to strings. However, for backward compatibility,
+     * we allow the "format" keyword if the type keyword was not specified, or was set to an invalid value.
+     */
     if ( isset( $args['format'] )
         && ( ! isset( $args['type'] ) || 'string' === $args['type'] || ! in_array( $args['type'], $allowed_types, true ) )
@@ -2859 +2871 @@
  */
 function rest_preload_api_request( $memo, $path ) {
-    // array_reduce() doesn't support passing an array in PHP 5.2,
-    // so we need to make sure we start with one.
+    /*
+     * array_reduce() doesn't support passing an array in PHP 5.2,
+     * so we need to make sure we start with one.
+     */
     if ( ! is_array( $memo ) ) {
         $memo = array();