コンテンツへスキップ

要素グラバー

AIコーディングアシスタントを使うとき、ページ上の特定の要素をどのテンプレートファイルが描画しているかを伝える必要がよくあります。要素グラバーは照準器のような要素セレクターで、1回の操作で要素の詳細なコンテキストをクリップボードにコピーします。

有効化

要素グラバーはクエリパラメーターで制御されます。任意のフロントエンドURLに?blockstudio-devtoolsを追加すると有効になります:

コード
https://example.com/?blockstudio-devtools
https://example.com/?p=123&blockstudio-devtools

クエリパラメーターがない場合、スクリプトもデータ属性も読み込まれません。

設定

テーマのblockstudio.jsonで要素グラバーを有効にします:

JSON
{
  "dev": {
    "grab": {
      "enabled": true
    }
  }
}
プロパティ 型 デフォルト 説明
enabled boolean false 要素グラバーを有効にします。

この設定はフィルターからも利用できます:

PHP
add_filter('blockstudio/settings/dev/grab/enabled', '__return_true');

使い方

  1. edit_posts権限のあるユーザーとしてログインし、?blockstudio-devtoolsを付けて任意のフロントエンドページを開きます。
  2. Cmd+C(Mac)またはCtrl+C(Windows)を100ms押し続けると、グラバーが起動します。
  3. 照準器型のセレクターが起動し、キャンバスオーバーレイでカーソルを合わせたBlockstudioブロックをハイライト表示します。
  4. ラベルが2つ表示されます。1つはブロックのテンプレートファイルパス、もう1つはHTML要素のタグ名を示します。
  5. 要素をクリックして、そのコンテキストをクリップボードにコピーします。
  6. 結果をAIコーディングツールに貼り付けます。

コピーせずに終了するには、EscapeまたはCmd+Cをもう一度押します。100msより前にCmd+Cを離した場合は、通常のコピー動作が維持されます。

クリップボードの形式

要素をクリックすると、AIコーディングアシスタント向けに設計された詳細なコンテキスト文字列がコピーされます:

コード
@<div>

<div class="my-block">
  Hello world
</div>
  in theme-name/blockstudio/blocks/my-block/index.php

要素のタグ名、属性とコンテンツを含むHTMLのプレビュー、テンプレートファイルのパスが含まれます。

内部の仕組み

Blockstudioは、フロントエンドでuseBlockPropsを使用するすべてのブロックラッパー要素にdata-blockstudio-path属性を追加します。この属性には、そのブロックを描画するテンプレートファイルの絶対パスが格納されます。

軽量なバニラTypeScriptモジュール(ReactもWordPress依存関係もなし)が、ログイン中の編集者向けにフロントエンドで読み込まれます。document.elementsFromPoint()を使って、カーソル下の特定のHTML要素と親のBlockstudioブロックの両方を検出し、それぞれを別々にハイライト表示します。

セキュリティ

data-blockstudio-path属性とグラバースクリプトは、次の条件をすべて満たす場合にのみ出力されます:

  • ?blockstudio-devtoolsクエリパラメーターが指定されている。
  • dev.grab.enabled設定がtrueである。
  • 現在のユーザーがedit_posts権限を持っている。

公開ページの訪問者にファイルパスやグラバースクリプトが表示されることはありません。