Changeset 51168

Timestamp:

06/16/2021 09:41:44 AM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: Update syntax for some multi-line comments per the documentation standards.

Follow-up to [51003], [51149].

See #52628.

Location:

trunk/src/wp-includes

Files:

• block-template.php (modified) (2 diffs)
• class-wp-theme-json.php (modified) (1 diff)
• theme-templates.php (modified) (1 diff)

trunk/src/wp-includes/block-template.php

@@ -24 +24 @@
 
     if ( $template ) {
-        // locate_template() has found a PHP template at the path specified by $template.
-        // That means that we have a fallback candidate if we cannot find a block template
-        // with higher specificity.
-        // Thus, before looking for matching block themes, we shorten our list of candidate
-        // templates accordingly.
+        /*
+         * locate_template() has found a PHP template at the path specified by $template.
+         * That means that we have a fallback candidate if we cannot find a block template
+         * with higher specificity.
+         *
+         * Thus, before looking for matching block themes, we shorten our list of candidate
+         * templates accordingly.
+         */
 
         // Locate the index of $template (without the theme directory path) in $templates.
@@ -219 +222 @@
 function _block_template_render_without_post_block_context( $context ) {
     /*
-     * When loading a template directly and not through a page
-     * that resolves it, the top-level post ID and type context get set to that
-     * of the template. Templates are just the structure of a site, and
-     * they should not be available as post context because blocks like Post
-     * Content would recurse infinitely.
+     * When loading a template directly and not through a page that resolves it,
+     * the top-level post ID and type context get set to that of the template.
+     * Templates are just the structure of a site, and they should not be available
+     * as post context because blocks like Post Content would recurse infinitely.
      */
     if ( isset( $context['postType'] ) && 'wp_template' === $context['postType'] ) {

trunk/src/wp-includes/class-wp-theme-json.php

@@ -1099 +1099 @@
         $this->theme_json = array_replace_recursive( $this->theme_json, $incoming_data );
 
-        // The array_replace_recursive algorithm merges at the leaf level.
-        // For leaf values that are arrays it will use the numeric indexes for replacement.
-        // In those cases, we want to replace the existing with the incoming value, if it exists.
+        /*
+         * The array_replace_recursive() algorithm merges at the leaf level.
+         * For leaf values that are arrays it will use the numeric indexes for replacement.
+         * In those cases, we want to replace the existing with the incoming value, if it exists.
+         */
         $to_replace   = array();
         $to_replace[] = array( 'custom' );

trunk/src/wp-includes/theme-templates.php

@@ -23 +23 @@
     }
 
-    // Template slugs must be unique within the same theme.
-    // TODO - Figure out how to update this to work for a multi-theme
-    // environment.  Unfortunately using `get_the_terms` for the 'wp-theme'
-    // term does not work in the case of new entities since is too early in
-    // the process to have been saved to the entity.  So for now we use the
-    // currently activated theme for creation.
+    /*
+     * Template slugs must be unique within the same theme.
+     * TODO - Figure out how to update this to work for a multi-theme environment.
+     * Unfortunately using `get_the_terms()` for the 'wp-theme' term does not work
+     * in the case of new entities since is too early in the process to have been saved
+     * to the entity. So for now we use the currently activated theme for creation.
+     */
     $theme = wp_get_theme()->get_stylesheet();
     $terms = get_the_terms( $post_ID, 'wp_theme' );