ユースケース

ブロックサポートを[https://developer.wordpress.org/reference/classes/wp_block_supports/register/]で登録する際、ブロックサポート設定配列に「apply」コールバックを渡すことで、「class」や「style」プロパティを持つブロックサポート属性を追加または拡張することが可能です。

ブロックがブロックサポートにオプトインしている場合、フロントエンドHTMLでレンダリングされる際に「class」と「style」の値がブロック要素の「class」と「style」属性に適用されます。これはサーバーサイドでレンダリングされたブロックにのみ適用されることに注意してください。例えば、サイトタイトルブロックです。

コールバックは$block_type$block_attributesを引数として受け取ります。style内の$block_attributes属性は、ブロックに設定されたスタイルがある場合、原始的なスタイルオブジェクトのみを含み、ブロックのHTML要素に適用されるCSSやクラス名は含まれません。

ここでwp_style_engine_get_stylesが役立ちます:これはCSSを生成し、適切であれば、最終的にレンダリングされたブロックマークアップの「style」と「class」HTML属性に追加されるクラス名を生成します。

以下は、カラー ブロック サポートがどのように機能するかの非常に簡略化されたバージョンです:

  1. function gutenberg_apply_colors_support( $block_type, $block_attributes ) {
  2. // Get the color styles from the style object.
  3. $block_color_styles = isset( $block_attributes['style']['color'] ) ? $block_attributes['style']['color'] : null;
  4. // Since we only want the color styles, pass the color styles only to the Style Engine.
  5. $styles = wp_style_engine_get_styles( array( 'color' => $block_color_styles ) );
  6. // Return the generated styles to be applied to the block's HTML element.
  7. return array(
  8. 'style' => $styles['css'],
  9. 'class' => $styles['classnames']
  10. );
  11. }
  12. // Register the block support.
  13. WP_Block_Supports::get_instance()->register(
  14. 'colors',
  15. array(
  16. 'register_attribute' => 'gutenberg_register_colors_support',
  17. 'apply' => 'gutenberg_apply_colors_support',
  18. )
  19. );

現時点では、スタイルエンジンは以下のコアブロックサポートのスタイルのみを生成することに注意してください:

  • ボーダー
  • カラー
  • スペーシング
  • タイポグラフィ

将来のリリースでは、このリストを拡張することが可能になります。

ブロックサポートの確認とシリアル化のスキップ

スタイルエンジンにブロックスタイルオブジェクトを渡す前に、考慮すべき点があります:

  • 1. テーマが特定のブロックスタイルをサポートすることを選択したかどうか、
  • 2. ブロックがその特定のブロックスタイルの「シリアル化をスキップする」ことを選択したかどうか、つまり、ブロックの要素にスタイルを自動的に適用することをオプトアウトしたかどうか(通常はブロックの内部を介して行うため)。詳細については、ブロックAPIドキュメントを参照してください。

ブロックが次のいずれかの場合:

  • スタイルのサポートがない、または
  • そのスタイルのシリアル化をスキップする

スタイルエンジンに渡す前に、スタイルオブジェクトからこれらのスタイル値を削除したいと思うでしょう。これには、次の2つの関数を使用します:

これで、ブロックがサポートを持ち、シリアル化をスキップしない場合にのみ「style」と「class」を返すように、上記の「apply」コールバックコードを更新できます:

  1. function gutenberg_apply_colors_support( $block_type, $block_attributes ) {
  2. // The return value.
  3. $attributes = array();
  4. // Return early if the block skips all serialization for block supports.
  5. if ( gutenberg_should_skip_block_supports_serialization( $block_type, 'color' ) ) {
  6. return $attributes;
  7. }
  8. // Checks for support and skip serialization.
  9. $has_text_support = block_has_support( $block_type, array( 'color', 'text' ), false );
  10. $has_background_support = block_has_support( $block_type, array( 'color', 'background' ), false );
  11. $skips_serialization_of_color_text = wp_should_skip_block_supports_serialization( $block_type, 'color', 'text' );
  12. $skips_serialization_of_color_background = wp_should_skip_block_supports_serialization( $block_type, 'color', 'background' );
  13. // Get the color styles from the style object.
  14. $block_color_styles = isset( $block_attributes['style']['color'] ) ? $block_attributes['style']['color'] : null;
  15. // The mutated styles object we're going to pass to wp_style_engine_get_styles().
  16. $color_block_styles = array();
  17. // Set the color style values according to whether the block has support and does not skip serialization.
  18. $spacing_block_styles['text'] = null;
  19. $spacing_block_styles['background'] = null;
  20. if ( $has_text_support && ! $skips_serialization_of_color_text ) {
  21. $spacing_block_styles['text'] = $block_color_styles['text'] ?? null;
  22. }
  23. if $has_background_support && ! $skips_serialization_of_color_background ) {
  24. $spacing_block_styles['background'] = $block_color_styles['background'] ?? null;
  25. }
  26. // Pass the color styles, excluding those that have no support or skip serialization, to the Style Engine.
  27. $styles = wp_style_engine_get_styles( array( 'color' => $block_color_styles ) );
  28. // Return the generated styles to be applied to the block's HTML element.
  29. return array(
  30. 'style' => $styles['css'],
  31. 'class' => $styles['classnames']
  32. );
  33. }

プリセットからのクラス名とCSSカスタムセレクタの生成

theme.jsonの多くのプリセットは、フロントエンドでCSSカスタムプロパティとCSSルール(セレクタとCSS宣言から成る)を生成します。

これらのプリセットを使用してブロックにスタイルを適用するには、通常、セレクタをブロックの「className」属性に追加します。

テキストカラーやフォントファミリーなど、プリセット値を持つスタイルの場合、スタイルエンジンはプリセットスラッグを使用してクラス名を構築する方法を知っています。

プリセット値とCSS値を区別するために、スタイルエンジンは特別なフォーマットを期待します。

プリセット値はvar:preset|<PRESET_TYPE>|<PRESET_SLUG>のパターンに従う必要があります。

スタイルエンジンがこれらの値に遭遇すると、それを解析し、var(--wp--preset--font-size--small)のCSS値を作成し、必要に応じてクラス名を生成します。

例:

  1. // Let's say the block attributes styles contain a fontSize preset slug of "small".
  2. // $block_attributes['fontSize'] = 'var:preset|font-size|small';
  3. $preset_font_size = "var:preset|font-size|{$block_attributes['fontSize']}";
  4. // Now let's say the block attributes styles contain a backgroundColor preset slug of "blue".
  5. // $block_attributes['backgroundColor'] = 'var:preset|color|blue';
  6. $preset_background_color = "var:preset|color|{$block_attributes['backgroundColor']}";
  7. $block_styles = array(
  8. 'typography' => array( 'fontSize' => $preset_font_size ),
  9. 'color' => array( 'background' => $preset_background_color ),
  10. 'spacing' => array( 'padding' => '10px', 'margin' => array( 'top' => '1em') ),
  11. );
  12. $styles = wp_style_engine_get_styles(
  13. $block_styles
  14. );
  15. print_r( $styles );
  16. /*
  17. array(
  18. 'css' => 'background-color:var(--wp--preset--color--blue);padding:10px;margin-top:1em;font-size:var(--wp--preset--font-size--small);',
  19. 'declarations' => array(
  20. 'background-color' => 'var(--wp--preset--color--blue)',
  21. 'padding' => '10px',
  22. 'margin-top' => '1em',
  23. 'font-size' => 'var(--wp--preset--font-size--small)',
  24. ),
  25. 'classnames' => 'has-background has-blue-background-color has-small-font-size',
  26. )
  27. */

スタイルエンジンが生成されたCSS文字列にCSSカスタム変数を出力しないようにしたい場合、つまり、CSSルールとクラス名の両方をブロック要素に適用する場合は、オプション配列に'convert_vars_to_classnames' => trueを渡すことができます。

このフラグは「変数をクラス名に変換し、CSSに変数を出力しない」という意味です。したがって、スタイルエンジンは必要なクラス名のみを生成し、CSS内のCSSカスタム変数を省略します。

上記の例のコードを使用して、オプションを渡したときの異なる出力を観察してください:

  1. $options = array(
  2. 'convert_vars_to_classnames' => true,
  3. );
  4. $styles = wp_style_engine_get_styles(
  5. $block_styles,
  6. $options
  7. );
  8. print_r( $styles );
  9. /*
  10. array(
  11. 'css' => 'padding:10px;margin-top:1em;',
  12. 'declarations' => array(
  13. 'padding' => '10px',
  14. 'margin-top' => '1em',
  15. ),
  16. 'classnames' => 'has-background has-blue-background-color has-small-font-size',
  17. )
  18. */

グローバルスタイルや[https://developer.wordpress.org/block-editor/how-to-guides/themes/global-settings-and-styles.md#css-custom-properties-presets-custom]のプリセットCSSカスタムプロパティ、[テーマサポート](/read/wordpress/a79eb3e4eb9df7a2.md)についてさらに詳しく読む。