Changeset 56195

Timestamp:

07/10/2023 11:17:05 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], [56192], [56193], [56194].

Props costdev, audrasjb.
See #58459.

Location:

trunk/src/wp-includes

Files:

• rest-api/endpoints/class-wp-rest-sidebars-controller.php (modified) (1 diff)
• rest-api/endpoints/class-wp-rest-templates-controller.php (modified) (3 diffs)
• rest-api/endpoints/class-wp-rest-users-controller.php (modified) (1 diff)
• rest-api/endpoints/class-wp-rest-widget-types-controller.php (modified) (1 diff)
• sitemaps/class-wp-sitemaps-provider.php (modified) (1 diff)

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

@@ -262 +262 @@
      */
     protected function do_permissions_check() {
-        // Verify if the current user has edit_theme_options capability.
-        // This capability is required to access the widgets screen.
+        /*
+         * Verify if the current user has edit_theme_options capability.
+         * This capability is required to access the widgets screen.
+         */
         if ( ! current_user_can( 'edit_theme_options' ) ) {
             return new WP_Error(

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

@@ -102 +102 @@
                 '/%s/(?P<id>%s%s)',
                 $this->rest_base,
-                // Matches theme's directory: `/themes/<subdirectory>/<theme>/` or `/themes/<theme>/`.
-                // Excludes invalid directory name characters: `/:<>*?"|`.
+                /*
+                 * Matches theme's directory: `/themes/<subdirectory>/<theme>/` or `/themes/<theme>/`.
+                 * Excludes invalid directory name characters: `/:<>*?"|`.
+                 */
                 '([^\/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)',
                 // Matches the template name.
@@ -178 +180 @@
      */
     protected function permissions_check( $request ) {
-        // Verify if the current user has edit_theme_options capability.
-        // This capability is required to edit/view/delete templates.
+        /*
+         * Verify if the current user has edit_theme_options capability.
+         * This capability is required to edit/view/delete templates.
+         */
         if ( ! current_user_can( 'edit_theme_options' ) ) {
             return new WP_Error(
@@ -503 +507 @@
             }
 
-            // (Note that internally this falls through to `wp_delete_post()`
-            // if the Trash is disabled.)
+            /*
+             * (Note that internally this falls through to `wp_delete_post()`
+             * if the Trash is disabled.)
+             */
             $result           = wp_trash_post( $id );
             $template->status = 'trash';

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

@@ -684 +684 @@
             $request_params = array_keys( $request->get_params() );
             sort( $request_params );
-            // If only 'id' and 'roles' are specified (we are only trying to
-            // edit roles), then only the 'promote_user' cap is required.
+            /*
+             * If only 'id' and 'roles' are specified (we are only trying to
+             * edit roles), then only the 'promote_user' cap is required.
+             */
             if ( array( 'id', 'roles' ) === $request_params ) {
                 return true;

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

@@ -465 +465 @@
         }
 
-        // Set the widget's number so that the id attributes in the HTML that we
-        // return are predictable.
+        /*
+         * Set the widget's number so that the id attributes in the HTML that we
+         * return are predictable.
+         */
         if ( isset( $request['number'] ) && is_numeric( $request['number'] ) ) {
             $widget_object->_set( (int) $request['number'] );

trunk/src/wp-includes/sitemaps/class-wp-sitemaps-provider.php

@@ -70 +70 @@
         $object_subtypes = $this->get_object_subtypes();
 
-        // If there are no object subtypes, include a single sitemap for the
-        // entire object type.
+        /*
+         * If there are no object subtypes, include a single sitemap for the
+         * entire object type.
+         */
         if ( empty( $object_subtypes ) ) {
             $sitemap_data[] = array(