コンテンツへスキップ

3ファイルで独自ブロックを作成

JavaScript不要、ビルド工程不要、ボイラープレート不要。

JSONでフィールドを定義

blockstudioキーをblock.jsonに追加します。text、toggle、colorなどの型で属性を定義します。BlockstudioがエディターUIを自動生成し、テキスト入力からリピーターやコードエディターまで、27のフィールド型に加え、自分で登録したフィールド型も利用できます。

JSONスキーマを完全にサポートし、VS Code、PhpStorm、および互換性のあるすべてのエディターで入力補完と検証を利用できます。

すべてのフィールドで、新しいブロック用のdefaultと、フィールドが空のときにテンプレートへ渡すfallbackを設定できます。

block.json
{
  "name": "starter/hero",
  "title": "Hero",
  "blockstudio": {
    "attributes": [
      { "id": "heading", "type": "text", "label": "Heading" },
      { "id": "showCta", "type": "toggle", "label": "Show CTA" },
      { "id": "background", "type": "color", "label": "Background" }
    ]
  }
}

3ファイルのワークフロー

フィールド用のblock.json、マークアップ用のテンプレート、任意のスタイルシート。

PHP内のReact

RichText、InnerBlocks、useBlockPropsは、PHP、Twig、Bladeでそのまま使えます。

SCSSとTailwind

CSS、SCSS、またはTailwindを使用します。SCSSはインポートパスと共通のプレリュードに対応しており、入れ子になったパーシャルを編集すると、それをインポートしているすべてのファイルが再コンパイルされます。

27種類のフィールド

テキスト、色、画像、リピーター、選択欄、コードエディターなどをJSONで設定できます。

JSON Schema

VS Code、PhpStorm、および互換性のあるエディターで入力補完と検証を利用できます。

3つのテンプレート言語

PHP、Twig、Bladeは同じ変数とコンポーネントを共有します。

npmのインポート

script.jsでパッケージをインポートできます。本番環境ではローカルで、エディターではCDN経由で読み込みます。

Interactivity API

フラグを1つ設定するだけでWordPress Interactivity APIを有効にできます。

PHPテンプレート内のReactコンポーネント

1つのテンプレート内で、インライン編集と静的フロントエンドHTMLには<RichText />、子ブロックには<InnerBlocks />、ラッパーにはuseBlockPropsを使用できます。

エディターでは、これらは実際のReactコンポーネントになります。フロントエンドではサーバー側HTMLとしてレンダリングされ、訪問者にJavaScriptは送信されません。

index.php
<div useBlockProps class="container">
  <RichText
    class="text-xl font-semibold"
    tag="h1"
    attribute="headline"
    placeholder="Enter headline"
  />

  <?php if ($a['showCta']): ?>
    <a href="<?= esc_url($a['ctaUrl']) ?>">
      <?= esc_html($a['ctaLabel']) ?>
    </a>
  <?php endif; ?>

  <InnerBlocks class="mt-4 p-4 border" />
</div>

PHP、Twig、またはBladeで記述

使い慣れたテンプレート言語を使えます。PHPは標準で動作し、Timberのインストール後はTwigを使えます。また、illuminate/view 8から12ではBlockstudio\Blade_Renderer経由でBladeを使えます。変数、コンポーネント、動作はどれも同じです。

$a(属性)、$b(ブロック)、$c(コンテキスト)、$innerBlocksは、どの言語でも利用できます。

Twigテンプレートも完全なTimberコンテキストを受け取ります。Bladeは、ページ、パターン、サイトエディターのテンプレートもレンダリングします。以前のjenssegers/bladeラッパーはilluminate/view10以降では機能しないため、代わりにBlade_Rendererを使用してください。

index.twig
<div useBlockProps class="card">
  <RichText tag="h2" attribute="title" placeholder="Card title" />
  {% if a.image %}
    <img src="{{ a.image.url|esc_url }}"
      alt="{{ a.image.alt|esc_attr }}" />
  {% endif %}
  <div class="card__body">{{ a.description|esc_html }}</div>
  <InnerBlocks allowedBlocks='["core/button"]' />
</div>

条件分岐と動的な選択肢

==、!=、includes、emptyなどの演算子や比較条件を使って、フィールドの表示・非表示を切り替えられます。条件はORで組み合わせられます。

オプションは別のフィールドに依存させることができます。{attributes.post_type.value}をpopulate引数に指定すると、そのフィールドが変更されたときにリストが再読み込みされます。エディターの入力に合わせて投稿を検索するには、fetch: trueを追加します。

type: customとblockstudio/blocks/attributes/populateフィルターを使うと、複数のブロックで1つのオプションリストを共有できます。また、購入確認などの独自のグローバル条件をblockstudio/blocks/conditionsで登録できます。

block.json
{
  "name": "starter/posts",
  "title": "Posts",
  "blockstudio": {
    "attributes": [
      {
        "id": "post_type",
        "type": "select",
        "label": "Post type",
        "options": [
          { "value": "page", "label": "Pages" },
          { "value": "post", "label": "Posts" }
        ]
      },
      {
        "id": "selected_post",
        "type": "select",
        "label": "Post",
        "populate": {
          "type": "query",
          "query": "posts",
          "arguments": { "post_type": "{attributes.post_type.value}" }
        }
      },
      {
        "id": "style",
        "type": "select",
        "label": "Style",
        "populate": { "type": "custom", "custom": "cardStyles" },
        "conditions": [[
          { "type": "purchasedProduct", "operator": "==", "value": "yes" }
        ]]
      }
    ]
  }
}

管理しやすいリピーター

minとmaxを設定し、default行から新しいブロックを開始して、既存の行をminimizedで折りたためます。textMinimizedを使うと、名前など、その行自身のフィールドの値で折りたたんだ行にラベルを付けられます。

行ではタブ以外のすべてのフィールドタイプを使用でき、リピーターを入れ子にすることもできます。行内の条件から"context": "main"を使って行の外にあるフィールドを確認でき、<RichText />と<MediaPlaceholder />では、attributeがrepeaterId[index].fieldIdを指している場合に単一の行を編集できます。

block.json
{
  "name": "starter/team",
  "title": "Team",
  "blockstudio": {
    "attributes": [
      {
        "id": "members",
        "type": "repeater",
        "label": "Team members",
        "min": 1,
        "max": 12,
        "minimized": true,
        "textMinimized": { "id": "name", "fallback": "Team member" },
        "attributes": [
          { "id": "name", "type": "text", "label": "Name" },
          { "id": "bio", "type": "richtext", "label": "Bio" }
        ]
      }
    ]
  }
}

再利用可能なフィールドセット

field.jsonでフィールドのグループを一度定義し、"type": "custom/cta"でどのブロックからでも参照できます。フィールドはインライン化されるため、テンプレートでは他の属性と同じように読み取れます。

hero_{id}などのidStructureを使えば、同じセットを2回使用できます。overridesを使うと、ブロックごとにラベル、デフォルト値、条件を変更できます。blockフィールドタイプもブロック全体に対して同じように機能し、そのブロックのフィールドをインライン展開して、レンダリング済みのHTMLを返します。

fields/cta/field.json
{
  "name": "cta",
  "title": "Call to action",
  "attributes": [
    { "id": "label", "type": "text", "label": "Button label", "default": "Learn more" },
    { "id": "url", "type": "link", "label": "Button URL" }
  ]
}

ビルド工程なしのESモジュール

script.jsを追加すると、ESモジュールとして読み込まれます。npm:プレフィックスを使ってnpmパッケージをインポートすると、Blockstudioが本番環境用にローカルへダウンロードします。

エディターでは即座にプレビューでき、フロントエンドでは外部依存のないローカルモジュールを使い、一度だけ読み込みます。

スタイルシートも同じ方法でインポートできます。import "npm:swiper@11.0.0/swiper.min.css"はファイルをダウンロードし、複数のブロックで使用されている場合でも、バージョンごとに一度だけキューに登録します。

script.js
import Swiper from "npm:swiper@11.0.0";
import "npm:swiper@11.0.0/swiper.min.css";

for (const el of document.querySelectorAll(".swiper")) {
  new Swiper(el, {
    slidesPerView: 3,
    spaceBetween: 20,
    loop: true,
  });
}

テンプレート以外のブロックタグ

blockstudio.jsonで短いプレフィックスを名前空間に割り当てるか、エイリアスフィルターを使って1つのタグを1つのブロックに割り当てると、<acme-card>でacme/cardをレンダリングできます。blockTags.enabledを有効にすると、allowおよびdenyパターンで制限したうえで、投稿コンテンツやウィジェット内のタグもレンダリングできます。

data-*属性はブロックのルート要素に渡され、html-*属性はプレフィックスなしで渡されます。blockstudio/block_tags/buildersで独自のタグビルダーを追加し、migrate-block-tagsコマンドで略記を移植可能な<bs:acme-card>形式に書き換えられます。

blockstudio.json
{
  "blockTags": {
    "enabled": true,
    "prefixes": {
      "acme": ["acme"],
      "ui": ["acme-ui"]
    },
    "deny": ["acme-ui/admin-*"]
  }
}

カスタムフィールド型

独自のフィールドコントロールを登録し、組み込みフィールドと同じように使えます。

ブロックアイランド

ページ全体をキャッシュし、訪問者のリクエスト時に1つのブロックをレンダリングします。

条件付き登録

投稿タイプ、ユーザーロール、その他のグローバル条件に応じてブロックを登録したり、必要なプラグインまたはそのバージョンが見つからない場合に登録をスキップしたりできます。

投稿メタとオプション

ブロック属性とともに、投稿メタまたはオプションに値を保存します。

条件分岐

等価性、包含、空値、比較条件を使って、値に応じたフィールドを表示します。

動的な選択肢

投稿、ユーザー、ターム、関数、APIから選択肢を取得できます。

上書き

共有ブロックの名前とともにoverride: trueを設定すると、IDごとに属性をマージし、ファイル名が一致するアセットを置き換え、テンプレートを差し替えられます。Twigテンプレートでは、extendsを使って個別のブロックをオーバーライドできます。

バリエーション

block.jsonでフィールド値をあらかじめ設定するバリエーションを宣言し、それを制御するフィールドはhiddenで非表示にします。

コンポーネント

PHPまたはブロックタグからのみレンダリングするブロックには、component: trueを設定します。フィールド、テンプレート、アセット、Tailwindは保持されますが、インサーターには表示されません。

InnerBlocksのルール

namespace/*、category:、@themeトークンを持つブロックを許可し、セレクトオプションから内部テンプレートを切り替え、フィルターでフロントエンドのラッパーを取り除けます。

コードフィールドのアセット

codeフィールドにasset: trueを設定すると、エディターの入力がそのブロック用のCSS、SCSS、またはJavaScriptになり、%selector%を通じてインスタンスごとにスコープされます。

ファイル名でアセットを読み込み

*.view.jsはフロントエンドでのみ読み込まれます。また、global-、admin-、block-editor-の各プレフィックスを付けると、ファイルはすべてのページ、wp-admin、またはブロックエディターで読み込まれます。

アイコンとブロックフォルダー

ブロックにカスタムSVGまたはHTMLアイコンを設定し、blockstudio/pathフィルターで検出場所を変更し、Blockstudio\Build::init()でフォルダーを追加できます。

ACFとMeta Boxの値

テンプレートは$post_idを受け取るため、get_field()とrwmb_get_value()は編集済みの投稿を読み取ります。また、refreshOnを設定すると、保存後にプレビューが再読み込みされます。

Query Loopのコンテキスト

Query Loop内では、$block[‘context’][‘postId’]は現在の項目に従う一方、$block[‘postId’]は表示中の投稿を示します。

WPML

wp bs wpml configを実行すると、テキストフィールドを翻訳可能としてマークするwpml-config.xmlが書き込まれます。また、フィールドに保存された画像は、代替テキストやキャプションとともにWPML翻訳ジョブに含まれます。

Plus

公式拡張キット

プレミアムサイトテンプレート、AIシステム指示、会員限定Discordコミュニティ。買い切りで、アップデートは生涯無料です。

  • 500+のサイトテンプレート
  • AIシステム向け指示
  • 無期限アップデート
  • 非公開Discordコミュニティ