Changeset 59328 for trunk

Timestamp:

10/30/2024 11:50:03 PM (22 months ago)

Author:

SergeyBiryukov

Message:

Docs: Correct DocBlock formatting in wp-includes/class-wp-theme-json.php.

Follow-up to [52049], [54118], [54162], [55008], [55349], [55959], [55986], [56058], [57496], [58354], [58413].

Props mukesh27, ramonopoly.
See #62279.

File:

• trunk/src/wp-includes/class-wp-theme-json.php (modified) (17 diffs)

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

@@ -228 +228 @@
          * @since 6.6.0 Added `background-[image|position|repeat|size]` properties.
          * @since 6.7.0 Added `background-attachment` property.
-         *
          * @var array
          */
@@ -308 +307 @@
          * @since 6.2.0
          * @since 6.6.0 Added background-image properties.
-         *
          * @var array
          */
@@ -340 +338 @@
          *
          * @since 5.9.0
+         * @var array
          */
         const PROTECTED_PROPERTIES = array(
@@ -476 +475 @@
          *
          * @since 6.5.0
-         *
          * @var array
          */
@@ -518 +516 @@
          * @since 6.5.0 Added support for `dimensions.aspectRatio`.
          * @since 6.6.0 Added `background` sub properties to top-level only.
-         *
          * @var array
          */
@@ -592 +589 @@
          * @since 6.1.0
          * @since 6.2.0 Added support for ':link' and ':any-link'.
+         * @var array
          */
         const VALID_ELEMENT_PSEUDO_SELECTORS = array(
@@ -939 +937 @@
          */
         protected static function sanitize( $input, $valid_block_names, $valid_element_names, $valid_variations ) {
-
                 $output = array();
 
@@ -2312 +2309 @@
          * @param string  $selector The style block selector.
          * @param boolean $use_root_padding Whether to add custom properties at root level.
-         * @return array  Returns the modified $declarations.
+         * @return array Returns the modified $declarations.
          */
         protected static function compute_style_properties( $styles, $settings = array(), $properties = null, $theme_json = null, $selector = null, $use_root_padding = null ) {
@@ -2816 +2813 @@
          *
          * @param array $block_metadata Metadata about the block to get styles for.
-         *
          * @return string Styles for the block.
          */
@@ -3041 +3037 @@
 
                 /*
-                * If there are content and wide widths in theme.json, output them
-                * as custom properties on the body element so all blocks can use them.
-                */
+                 * If there are content and wide widths in theme.json, output them
+                 * as custom properties on the body element so all blocks can use them.
+                 */
                 if ( isset( $settings['layout']['contentSize'] ) || isset( $settings['layout']['wideSize'] ) ) {
                         $content_size = isset( $settings['layout']['contentSize'] ) ? $settings['layout']['contentSize'] : $settings['layout']['wideSize'];
@@ -3054 +3050 @@
 
                 /*
-                * Reset default browser margin on the body element.
-                * This is set on the body selector **before** generating the ruleset
-                * from the `theme.json`. This is to ensure that if the `theme.json` declares
-                * `margin` in its `spacing` declaration for the `body` element then these
-                * user-generated values take precedence in the CSS cascade.
-                * @link https://github.com/WordPress/gutenberg/issues/36147.
-                */
+                 * Reset default browser margin on the body element.
+                 * This is set on the body selector **before** generating the ruleset
+                 * from the `theme.json`. This is to ensure that if the `theme.json` declares
+                 * `margin` in its `spacing` declaration for the `body` element then these
+                 * user-generated values take precedence in the CSS cascade.
+                 * @link https://github.com/WordPress/gutenberg/issues/36147.
+                 */
                 $css .= ':where(body) { margin: 0; }';
 
@@ -3470 +3466 @@
          *
          * @param array  $theme_json Structure to sanitize.
-         * @param string $origin    Optional. What source of data this object represents.
-         *                          One of 'blocks', 'default', 'theme', or 'custom'. Default 'theme'.
+         * @param string $origin     Optional. What source of data this object represents.
+         *                           One of 'blocks', 'default', 'theme', or 'custom'. Default 'theme'.
          * @return array Sanitized structure.
          */
@@ -4203 +4199 @@
          *
          * @since 6.3.0
+         *
          * @param string $value The variable such as var:preset|color|vivid-green-cyan to convert.
          * @return string The converted variable.
@@ -4228 +4225 @@
          *
          * @since 6.3.0
-         * @param array $tree   Input to process.
+         *
+         * @param array $tree Input to process.
          * @return array The modified $tree.
          */
@@ -4252 +4250 @@
          * @param object $block_type    The block type.
          * @param string $root_selector The block's root selector.
-         *
          * @return array The custom selectors set by the block.
          */
@@ -4311 +4308 @@
          * @param object $metadata The related block metadata containing selectors.
          * @param object $node     A merged theme.json node for block or variation.
-         *
          * @return array The style declarations for the node's features with custom
-         * selectors.
+         *               selectors.
          */
         protected function get_feature_declarations_for_node( $metadata, &$node ) {
@@ -4471 +4467 @@
          *
          * @since 6.3.0
+         *
          * @param WP_Theme_JSON $theme_json The theme json resolver.
-         *
          * @return WP_Theme_JSON The $theme_json with resolved variables.
          */