Changeset 56194 for trunk/src/wp-includes/theme.php

Timestamp:

07/10/2023 11:09:16 PM (15 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].

Props costdev, audrasjb.
See #58459.

File:

• trunk/src/wp-includes/theme.php (modified) (10 diffs)

trunk/src/wp-includes/theme.php

@@ -46 +46 @@
 
     if ( is_array( $wp_theme_directories ) && count( $wp_theme_directories ) > 1 ) {
-        // Make sure the active theme wins out, in case search_theme_directories() picks the wrong
-        // one in the case of a conflict. (Normally, last registered theme root wins.)
+        /*
+         * Make sure the active theme wins out, in case search_theme_directories() picks the wrong
+         * one in the case of a conflict. (Normally, last registered theme root wins.)
+         */
         $current_theme = get_stylesheet();
         if ( isset( $theme_directories[ $current_theme ] ) ) {
@@ -511 +513 @@
             }
             if ( file_exists( $theme_root . '/' . $dir . '/style.css' ) ) {
-                // wp-content/themes/a-single-theme
-                // wp-content/themes is $theme_root, a-single-theme is $dir.
+                /*
+                 * wp-content/themes/a-single-theme
+                 * wp-content/themes is $theme_root, a-single-theme is $dir.
+                 */
                 $found_themes[ $dir ] = array(
                     'theme_file' => $dir . '/style.css',
@@ -519 +523 @@
             } else {
                 $found_theme = false;
-                // wp-content/themes/a-folder-of-themes/*
-                // wp-content/themes is $theme_root, a-folder-of-themes is $dir, then themes are $sub_dirs.
+                /*
+                 * wp-content/themes/a-folder-of-themes/*
+                 * wp-content/themes is $theme_root, a-folder-of-themes is $dir, then themes are $sub_dirs.
+                 */
                 $sub_dirs = @ scandir( $theme_root . '/' . $dir );
                 if ( ! $sub_dirs ) {
@@ -539 +545 @@
                     $found_theme                           = true;
                 }
-                // Never mind the above, it's just a theme missing a style.css.
-                // Return it; WP_Theme will catch the error.
+                /*
+                 * Never mind the above, it's just a theme missing a style.css.
+                 * Return it; WP_Theme will catch the error.
+                 */
                 if ( ! $found_theme ) {
                     $found_themes[ $dir ] = array(
@@ -588 +596 @@
         $theme_root = get_raw_theme_root( $stylesheet_or_template );
         if ( $theme_root ) {
-            // Always prepend WP_CONTENT_DIR unless the root currently registered as a theme directory.
-            // This gives relative theme roots the benefit of the doubt when things go haywire.
+            /*
+             * Always prepend WP_CONTENT_DIR unless the root currently registered as a theme directory.
+             * This gives relative theme roots the benefit of the doubt when things go haywire.
+             */
             if ( ! in_array( $theme_root, (array) $wp_theme_directories, true ) ) {
                 $theme_root = WP_CONTENT_DIR . $theme_root;
@@ -1833 +1843 @@
     $background = set_url_scheme( get_background_image() );
 
-    // $color is the saved custom color.
-    // A default has to be specified in style.css. It will not be printed here.
+    /*
+     * $color is the saved custom color.
+     * A default has to be specified in style.css. It will not be printed here.
+     */
     $color = get_background_color();
 
@@ -2508 +2520 @@
                 break;
 
-            // All that's left now are posts (besides attachments).
-            // Not a default case for the sake of clarity and future work.
+            /*
+             * All that's left now are posts (besides attachments).
+             * Not a default case for the sake of clarity and future work.
+             */
             case 'posts':
                 foreach ( $config[ $type ] as $id => $item ) {
@@ -2736 +2750 @@
             unset( $args[0]['__jit'] );
 
-            // Merge in data from previous add_theme_support() calls.
-            // The first value registered wins. (A child theme is set up first.)
+            /*
+             * Merge in data from previous add_theme_support() calls.
+             * The first value registered wins. (A child theme is set up first.)
+             */
             if ( isset( $_wp_theme_features['custom-header'] ) ) {
                 $args[0] = wp_parse_args( $_wp_theme_features['custom-header'][0], $args[0] );
             }
 
-            // Load in the defaults at the end, as we need to insure first one wins.
-            // This will cause all constants to be defined, as each arg will then be set to the default.
+            /*
+             * Load in the defaults at the end, as we need to insure first one wins.
+             * This will cause all constants to be defined, as each arg will then be set to the default.
+             */
             if ( $jit ) {
                 $args[0] = wp_parse_args( $args[0], $defaults );
@@ -2790 +2808 @@
             }
 
-            // If headers are supported, and we still don't have a defined width or height,
-            // we have implicit flex sizes.
+            /*
+             * If headers are supported, and we still don't have a defined width or height,
+             * we have implicit flex sizes.
+             */
             if ( $jit ) {
                 if ( empty( $args[0]['width'] ) && empty( $args[0]['flex-width'] ) ) {
@@ -3488 +3508 @@
     $messenger_channel = null;
 
-    // Value false indicates UUID should be determined after_setup_theme
-    // to either re-use existing saved changeset or else generate a new UUID if none exists.
+    /*
+     * Value false indicates UUID should be determined after_setup_theme
+     * to either re-use existing saved changeset or else generate a new UUID if none exists.
+     */
     $changeset_uuid = false;
 
-    // Set initially fo false since defaults to true for back-compat;
-    // can be overridden via the customize_changeset_branching filter.
+    /*
+     * Set initially fo false since defaults to true for back-compat;
+     * can be overridden via the customize_changeset_branching filter.
+     */
     $branching = false;