Changeset 53892

Timestamp:

08/13/2022 10:36:27 PM (2 years ago)

Author:

johnbillion

Message:

Editor: Document the arguments for registering a block style.

See #55646

Location:

trunk/src/wp-includes

Files:

• blocks.php (modified) (1 diff)
• class-wp-block-styles-registry.php (modified) (1 diff)

trunk/src/wp-includes/blocks.php

@@ -991 +991 @@
  *
  * @since 5.3.0
+ *
+ * @link https://developer.wordpress.org/block-editor/reference-guides/block-api/block-styles/
  *
  * @param string $block_name       Block type name including namespace.

trunk/src/wp-includes/class-wp-block-styles-registry.php

@@ -35 +35 @@
      * Registers a block style for the given block type.
      *
+     * If the block styles are present in a standalone stylesheet, register it and pass
+     * its handle as the `style_handle` argument. If the block styles should be inline,
+     * use the `inline_style` argument. Usually, one of them would be used to pass CSS
+     * styles. However, you could also skip them and provide CSS styles in any stylesheet
+     * or with an inline tag.
+     *
      * @since 5.3.0
      *
+     * @link https://developer.wordpress.org/block-editor/reference-guides/block-api/block-styles/
+     *
      * @param string $block_name       Block type name including namespace.
-     * @param array  $style_properties Array containing the properties of the style name, label,
-     *                                 is_default, style_handle (name of the stylesheet to be enqueued),
-     *                                 inline_style (string containing the CSS to be added).
+     * @param array  $style_properties {
+     *     Array containing the properties of the style.
+     *
+     *     @type string $name         The identifier of the style used to compute a CSS class.
+     *     @type string $label        A human-readable label for the style.
+     *     @type string $inline_style Inline CSS code that registers the CSS class required
+     *                                for the style.
+     *     @type string $style_handle The handle to an already registered style that should be
+     *                                enqueued in places where block styles are needed.
+     *     @type bool   $is_default   Whether this is the default style for the block type.
+     * }
      * @return bool True if the block style was registered with success and false otherwise.
      */