セレクタ

areInnerBlocksControlled

指定されたブロックが制御された内部ブロックを持っているかどうかを確認します。

パラメータ

  • state Object: グローバルアプリケーションの状態。
  • clientId string: 確認するブロック。

戻り値

  • boolean: ブロックが制御された内部ブロックを持っている場合は真。

canEditBlock

指定されたブロックが編集可能かどうかを判断します。

パラメータ

  • state Object: エディタの状態。
  • clientId string: ブロックのクライアントID。

戻り値

  • boolean: 指定されたブロックが編集可能かどうか。

canInsertBlocks

指定されたブロックがブロックリストに挿入可能かどうかを判断します。

パラメータ

  • state Object: エディタの状態。
  • clientIds string: 挿入するブロックのクライアントID。
  • rootClientId ?string: オプションのブロックリストのルートクライアントID。

戻り値

  • boolean: 指定されたブロックが挿入可能かどうか。

canInsertBlockType

指定されたブロックタイプがブロックリストに挿入可能かどうかを判断します。

パラメータ

  • state Object: エディタの状態。
  • blockName string: ブロックタイプの名前、例：’ core/paragraph’。
  • rootClientId ?string: オプションのブロックリストのルートクライアントID。

戻り値

  • boolean: 指定されたブロックタイプが挿入可能かどうか。

canLockBlockType

指定されたブロックタイプがユーザーによってロック/ロック解除できるかどうかを判断します。

パラメータ

  • state Object: エディタの状態。
  • nameOrType (string|Object): ブロック名またはタイプオブジェクト。

戻り値

  • boolean: 指定されたブロックタイプがロック/ロック解除できるかどうか。

canMoveBlock

指定されたブロックが移動可能かどうかを判断します。

パラメータ

  • state Object: エディタの状態。
  • clientId string: ブロックのクライアントID。

戻り値

  • boolean: 指定されたブロックが移動可能かどうか。

canMoveBlocks

指定されたブロックが移動可能かどうかを判断します。

パラメータ

  • state Object: エディタの状態。
  • clientIds string: 移動するブロックのクライアントID。

戻り値

  • boolean: 指定されたブロックが移動可能かどうか。

canRemoveBlock

指定されたブロックが削除可能かどうかを判断します。

パラメータ

  • state Object: エディタの状態。
  • clientId string: ブロックのクライアントID。

戻り値

  • boolean: 指定されたブロックが削除可能かどうか。

canRemoveBlocks

指定されたブロックが削除可能かどうかを判断します。

パラメータ

  • state Object: エディタの状態。
  • clientIds string: 削除するブロックのクライアントID。

戻り値

  • boolean: 指定されたブロックが削除可能かどうか。

didAutomaticChange

最後の変更が自動的な変更であった場合は真を返し、そうでない場合は偽を返します。

パラメータ

  • state Object: グローバルアプリケーションの状態。

戻り値

  • boolean: 最後の変更が自動的であったかどうか。

getAdjacentBlockClientId

指定された参照の startClientId と修飾子の方向性に隣接するブロックのクライアントIDを返します。デフォルトでは startClientId を選択されたブロックに設定し、方向を次のブロックに設定します。隣接するブロックがない場合は null を返します。

パラメータ

  • state Object: エディタの状態。
  • startClientId ?string: 検索するブロックのオプションのクライアントID。
  • modifier ?number: 方向性の乗数 (1 次、-1 前)。

戻り値

  • ?string: ブロックのクライアントIDを返すか、存在しない場合は null を返します。

getAllowedBlocks

内部ブロックの子供に対して許可された挿入ブロックのリストを返します。

パラメータ

  • state Object: エディタの状態。
  • rootClientId ?string: オプションのブロックリストのルートクライアントID。

戻り値

  • Array?: 許可されたブロックタイプのリスト。

getBlock

クライアントIDに基づいてブロックを返します。これは、blockName、clientId、および現在の attributes 状態を含むブロックの解析されたコピーです。これはブロックの登録設定ではなく、ブロックモジュールの登録ストアから取得する必要があります。

getBlock は、すべての子ブロックが取得されるまで内部ブロックを再帰的に処理します。getBlock は、内部ブロックコントローラーの子内部ブロックを返さないことに注意してください。これは、内部ブロックコントローラーが自分のエンティティと同期するため、異なるエンティティのブロックに含めるべきではないからです。たとえば、getBlocks( TP ) を呼び出してテンプレートパートのブロックを取得する場合、別のテンプレートパートが TP の子である場合、ネストされたテンプレートパートの子ブロックは返されません。このようにして、テンプレートブロック自体は親の一部と見なされますが、子はそうではありません。

パラメータ

  • state Object: エディタの状態。
  • clientId string: ブロックのクライアントID。

戻り値

  • Object: 解析されたブロックオブジェクト。

getBlockAttributes

クライアントIDに基づいてブロックの属性を返します。クライアントIDに該当するブロックが存在しない場合は null を返します。

パラメータ

  • state Object: エディタの状態。
  • clientId string: ブロックのクライアントID。

戻り値

  • Object?: ブロックの属性。

getBlockCount

現在の投稿に存在するブロックの数を返します。

パラメータ

  • state Object: エディタの状態。
  • rootClientId ?string: オプションのブロックリストのルートクライアントID。

戻り値

  • number: 投稿内のブロックの数。

getBlockEditingMode

指定されたブロックのブロック編集モードを返します。

モードは次の3つのオプションのいずれかです:

  • 'disabled': ブロックの編集を完全に防止します。つまり、選択できません。
  • 'contentOnly': コンテンツ以外のすべてのUIを非表示にします。たとえば、ツールバーの補助コントロール、ブロックの移動、ブロック設定。
  • 'default': 通常通りブロックを編集できます。

ブロックは useBlockEditingMode フックを使用してモードを設定できます。

モードは、独自のモードを持たない限り、すべてのブロックの内部ブロックに継承されます。

テンプレートロックもモードを設定できます。テンプレートロックが 'contentOnly' の場合、ブロックのモードは、ブロックにコンテンツロール属性がある場合は 'contentOnly' にオーバーライドされ、それ以外の場合は 'disabled' になります。

関連

  • useBlockEditingMode

パラメータ

  • state Object: グローバルアプリケーションの状態。
  • clientId string: ブロックのクライアントID、または '' ルートコンテナのための。

戻り値

  • BlockEditingMode: ブロック編集モード。 'disabled'、'contentOnly'、または 'default' のいずれか。

getBlockHierarchyRootClientId

ブロックのクライアントIDが与えられた場合、ブロックがネストされている階層のルートを返します。ルートレベルのブロックの場合はブロック自体を返します。

パラメータ

  • state Object: エディタの状態。
  • clientId string: ルートクライアントIDを見つけるためのブロック。

戻り値

  • string: ルートクライアントID

getBlockIndex

指定されたクライアントIDに対応するブロックがブロック順序内で発生するインデックスを返します。ブロックが存在しない場合は -1 を返します。

パラメータ

  • state Object: エディタの状態。
  • clientId string: ブロックのクライアントID。

戻り値

  • number: ブロックが順序内に存在するインデックス。

getBlockInsertionPoint

挿入キューの位置を返します。デフォルトでは最後のインデックスです。

パラメータ

  • state Object: エディタの状態。

戻り値

  • Object: rootClientId、index を持つ挿入ポイントオブジェクト。

getBlockListSettings

ブロックのブロックリスト設定を返します。存在する場合。

パラメータ

  • state Object: エディタの状態。
  • clientId ?string: ブロックのクライアントID。

戻り値

  • ?Object: 設定されている場合のブロックの設定。

getBlockMode

ブロックの編集モードを返します。明示的に割り当てられていない場合は「ビジュアル」にデフォルト設定されます。

パラメータ

  • state Object: エディタの状態。
  • clientId string: ブロックのクライアントID。

戻り値

  • Object: ブロック編集モード。

getBlockName

クライアントIDに基づいてブロックの名前を返します。クライアントIDに該当するブロックが存在しない場合は null を返します。

パラメータ

  • state Object: エディタの状態。
  • clientId string: ブロックのクライアントID。

戻り値

  • string: ブロック名。

getBlockNamesByClientId

ブロックのクライアントIDの配列が与えられた場合、対応するブロック名の配列を返します。

パラメータ

  • state Object: エディタの状態。
  • clientIds string[]: ブロック名を返すためのクライアントID。

戻り値

  • string[]: ブロック名。

getBlockOrder

エディタ内のすべてのブロックのクライアントIDを、表示される順序で含む配列を返します。オプションで、順序を返すためのブロックリストのルートクライアントIDを受け入れ、デフォルトではトップレベルのブロック順序になります。

パラメータ

  • state Object: エディタの状態。
  • rootClientId ?string: オプションのブロックリストのルートクライアントID。

戻り値

  • Array: エディタブロックの順序付きクライアントID。

getBlockParents

ブロックのクライアントIDが与えられた場合、上から下までのすべての親のリストを返します。

パラメータ

  • state Object: エディタの状態。
  • clientId string: ルートクライアントIDを見つけるためのブロック。
  • ascending boolean: 結果を下から上に（true）または上から下に（false）並べ替えます。

戻り値

  • Array: 親ブロックのクライアントID。

getBlockParentsByBlockName

ブロックのクライアントIDとブロック名が与えられた場合、指定された名前でフィルタリングされた上から下までのすべての親のリストを返します。たとえば、ブロック名として ‘core/group’ を渡すと、グループブロックである親のみが返されます。[ 'core/group', 'core/cover'] をブロック名として渡すと、グループブロックとカバーブロックの親が返されます。

パラメータ

  • state Object: エディタの状態。
  • clientId string: ルートクライアントIDを見つけるためのブロック。
  • blockName string|string[]: フィルタリングするブロック名。
  • ascending boolean: 結果を下から上に（true）または上から下に（false）並べ替えます。

戻り値

  • Array: 親ブロックのクライアントID。

getBlockRootClientId

ブロックのクライアントIDが与えられた場合、ブロックがネストされているルートブロックを返します。トップレベルのブロックの場合は空の文字列、またはブロックが存在しない場合は null を返します。

パラメータ

  • state Object: エディタの状態。
  • clientId string: ルートクライアントIDを見つけるためのブロック。

戻り値

  • ?string: ルートクライアントIDが存在する場合

getBlocks

現在編集中の投稿のすべてのブロックオブジェクトを、投稿内に表示される順序で配列として返します。これは、ネストされた内部ブロックコントローラーの子ブロックを除外します。

パラメータ

  • state Object: エディタの状態。
  • rootClientId ?string: オプションのブロックリストのルートクライアントID。

戻り値

  • Object[]: 投稿ブロック。

getBlocksByClientId

ブロックのクライアントIDの配列が与えられた場合、対応するブロックオブジェクトの配列を返します。

パラメータ

  • state Object: エディタの状態。
  • clientIds string[]: ブロックを返すためのクライアントID。

戻り値

  • WPBlock[]: ブロックオブジェクト。

getBlocksByName

ブロック名に一致するすべてのブロックを返します。結果にはネストされたブロックが含まれます。

パラメータ

  • state Object: グローバルアプリケーションの状態。
  • blockName string[]: クライアントIDを返すためのブロック名。

戻り値

  • Array: ブロック名が blockName に等しいブロックのクライアントIDの配列。

getBlockSelectionEnd

現在のブロック選択の終了を返します。この値は null である可能性があり、単一のブロック選択または複数選択の終了を表す可能性があります。選択が単一である場合、開始と終了が一致します。

パラメータ

  • state Object: グローバルアプリケーションの状態。

戻り値

  • ?string: ブロック選択の終了のクライアントID。

getBlockSelectionStart

現在のブロック選択の開始を返します。この値は null である可能性があり、単一のブロック選択または複数選択の開始を表す可能性があります。選択が単一である場合、開始と終了が一致します。

パラメータ

  • state Object: グローバルアプリケーションの状態。

戻り値

  • ?string: ブロック選択の開始のクライアントID。

getBlockTransformItems

利用可能なブロック変換リストに表示されるアイテムを決定します。

各アイテムオブジェクトには、変換リストにメニューアイテムを表示し、その選択を処理するために必要なものが含まれています。

「frecency」プロパティは、ブロックの使用頻度と最近性を組み合わせたヒューリスティックです。

アイテムは「frecency」によって降順に返されます。

パラメータ

  • state Object: エディタの状態。
  • blocks Object|Object[]: ブロックオブジェクトまたはオブジェクトの配列。
  • rootClientId ?string: オプションのブロックリストのルートクライアントID。

戻り値

  • WPEditorTransformItem[]: 挿入者に表示されるアイテム。

型定義

  • WPEditorTransformItem Object

プロパティ

  • id string: アイテムの一意の識別子。
  • name string: 作成するブロックのタイプ。
  • title string: 挿入者に表示されるアイテムのタイトル。
  • icon string: 挿入者に表示されるアイテムのダッシュアイコン。
  • isDisabled boolean: ユーザーがこのアイテムを挿入するのを防ぐべきかどうか。
  • frecency number: 頻度と最近性を組み合わせたヒューリスティック。

getClientIdsOfDescendants

指定されたブロックのすべての子孫のクライアントIDを含む配列を返します。返されたIDは、最初に指定されたIDの順序で、次にエディタ内に表示される順序で並べられます。

パラメータ

  • state Object: グローバルアプリケーションの状態。
  • rootIds string|string[]: 子孫ブロックを返すためのクライアントID。

戻り値

  • Array: 子孫のクライアントID。

getClientIdsWithDescendants

トップレベルのブロックとその子孫（ネストされたブロック）のクライアントIDを含む配列を返します。IDは、エディタ内に表示される順序で返されます。

パラメータ

  • state Object: グローバルアプリケーションの状態。

戻り値

  • Array: トップレベルおよび子孫ブロックのID。

getDirectInsertBlock

ブロックアペンダーによって直接挿入されるブロックを返します。

パラメータ

  • state Object: エディタの状態。
  • rootClientId ?string: オプションのブロックリストのルートクライアントID。

戻り値

  • WPDirectInsertBlock|undefined: 直接挿入されるブロックタイプ。

型定義

  • WPDirectInsertBlock Object

プロパティ

  • name string: ブロックのタイプ。
  • attributes ?Object: 新しく作成されたブロックに渡す属性。
  • attributesToCopy ?Array<string>: 挿入時に隣接ブロックからコピーされる属性。

getDraggedBlockClientIds

直接ドラッグされているブロックのクライアントIDを返します。

親がドラッグされている場合の子は含まれません。

パラメータ

  • state Object: グローバルアプリケーションの状態。

戻り値

  • string[]: ドラッグされたブロックのクライアントIDの配列。

getFirstMultiSelectedBlockClientId

マルチ選択セット内の最初のブロックのクライアントIDを返します。マルチ選択がない場合は null を返します。

パラメータ

  • state Object: エディタの状態。

戻り値

  • ?string: マルチ選択セット内の最初のブロックのクライアントID。

getGlobalBlockCount

投稿内のブロックの総数、または特定の名前のブロックの総数を返します。返される数にはネストされたブロックが含まれます。

パラメータ

  • state Object: グローバルアプリケーションの状態。
  • blockName ?string: オプションのブロック名。指定された場合、そのタイプのブロックのみがカウントされます。

戻り値

  • number: 投稿内のブロックの数、または blockName に等しいブロックの数。

getHoveredBlockClientId

現在ホバーされているブロックを返します。

パラメータ

  • state Object: グローバルアプリケーションの状態。

戻り値

  • Object: ホバーされているブロックのクライアントID。

getInserterItems

挿入者に表示されるアイテムを決定します。静的アイテム（通常のブロックタイプなど）と動的アイテム（再利用可能なブロックなど）の両方が含まれます。

各アイテムオブジェクトには、挿入者にボタンを表示し、その選択を処理するために必要なものが含まれています。

「frecency」プロパティは、ブロックの使用頻度と最近性を組み合わせたヒューリスティックです。

アイテムは「utility」と「frecency」によって降順に返されます。

パラメータ

  • state Object: エディタの状態。
  • rootClientId ?string: オプションのブロックリストのルートクライアントID。

戻り値

  • WPEditorInserterItem[]: 挿入者に表示されるアイテム。

型定義

  • WPEditorInserterItem Object

プロパティ

  • id string: アイテムの一意の識別子。
  • name string: 作成するブロックのタイプ。
  • initialAttributes Object: 新しく作成されたブロックに渡す属性。
  • title string: 挿入者に表示されるアイテムのタイトル。
  • icon string: 挿入者に表示されるアイテムのダッシュアイコン。
  • category string: アイテムが関連付けられているブロックカテゴリ。
  • keywords string[]: このアイテムを見つけるために検索できるキーワード。
  • isDisabled boolean: ユーザーがこのアイテムを挿入するのを防ぐべきかどうか。
  • frecency number: 頻度と最近性を組み合わせたヒューリスティック。

getLastMultiSelectedBlockClientId

マルチ選択セット内の最後のブロックのクライアントIDを返します。マルチ選択がない場合は null を返します。

パラメータ

  • state Object: エディタの状態。

戻り値

  • ?string: マルチ選択セット内の最後のブロックのクライアントID。

getLowestCommonAncestorWithSelectedBlock

ブロックのクライアントIDが与えられた場合、選択されたクライアントIDとの最低共通祖先を返します。

パラメータ

  • state Object: エディタの状態。
  • clientId string: 共通の祖先クライアントIDを見つけるためのブロック。

戻り値

  • string: 共通の祖先クライアントIDまたは未定義

getMultiSelectedBlockClientIds

現在のマルチ選択セットのブロッククライアントIDを返します。マルチ選択がない場合は空の配列を返します。

パラメータ

  • state Object: エディタの状態。

戻り値

  • Array: マルチ選択されたブロックのクライアントID。

getMultiSelectedBlocks

現在のマルチ選択セットのブロックを返します。マルチ選択がない場合は空の配列を返します。

パラメータ

  • state Object: エディタの状態。

戻り値

  • Array: マルチ選択されたブロックオブジェクト。

getMultiSelectedBlocksEndClientId

マルチ選択セットを終了するブロックのクライアントIDを返します。マルチ選択がない場合は null を返します。

これは必ずしも選択内の最後のクライアントIDではありません。

関連

  • getLastMultiSelectedBlockClientId

パラメータ

  • state Object: エディタの状態。

戻り値

  • ?string: マルチ選択を終了するブロックのクライアントID。

getMultiSelectedBlocksStartClientId

マルチ選択セットを開始するブロックのクライアントIDを返します。マルチ選択がない場合は null を返します。

これは必ずしも選択内の最初のクライアントIDではありません。

関連

  • getFirstMultiSelectedBlockClientId

パラメータ

  • state Object: エディタの状態。

戻り値

  • ?string: マルチ選択を開始するブロックのクライアントID。

getNextBlockClientId

指定された参照の start ID から次のブロックのクライアントIDを返します。デフォルトでは選択されたブロックに設定されます。次のブロックがない場合は null を返します。

パラメータ

  • state Object: エディタの状態。
  • startClientId ?string: 検索するブロックのオプションのクライアントID。

戻り値

  • ?string: 隣接ブロックのクライアントID、または存在しない場合は null。

getPatternsByBlockTypes

宣言された blockTypes とブロックの名前に基づいてパターンのリストを返します。パターンは、blockTypes を使用して、挿入中のプレースホルダー状態で適切なパターンを提案したり、ブロック変換に統合したりできます。

パラメータ

  • state Object: エディタの状態。
  • blockNames string|string[]: 一致するパターンを見つけるためのブロックの名前またはブロック名の配列。
  • rootClientId ?string: オプションのターゲットルートクライアントID。

戻り値

  • Array: 宣言された blockTypes とブロック名に基づいて一致したブロックパターンのリスト。

getPreviousBlockClientId

指定された参照の start ID から前のブロックのクライアントIDを返します。デフォルトでは選択されたブロックに設定されます。前のブロックがない場合は null を返します。

パラメータ

  • state Object: エディタの状態。
  • startClientId ?string: 検索するブロックのオプションのクライアントID。

戻り値

  • ?string: 隣接ブロックのクライアントID、または存在しない場合は null。

getSelectedBlock

現在選択されているブロックを返します。選択されているブロックがない場合は null を返します。

パラメータ

  • state Object: グローバルアプリケーションの状態。

戻り値

  • ?Object: 選択されたブロック。

getSelectedBlockClientId

現在選択されているブロックのクライアントIDを返します。選択されているブロックがない場合は null を返します。

パラメータ

  • state Object: エディタの状態。

戻り値

  • ?string: 選択されたブロックのクライアントID。

getSelectedBlockClientIds

現在の選択セットのブロッククライアントID（マルチ選択または単一選択）を返します。

パラメータ

  • state Object: エディタの状態。

戻り値

  • Array: マルチ選択されたブロックのクライアントID。

getSelectedBlockCount

現在投稿で選択されているブロックの数を返します。

パラメータ

  • state Object: グローバルアプリケーションの状態。

戻り値

  • number: 投稿で選択されたブロックの数。

getSelectedBlocksInitialCaretPosition

選択されたブロックの初期キャレット位置を返します。この位置は、選択されたブロックが変更されたときにキャレットを適切に配置するために使用されます。現在のブロックが RichText でない場合、初期位置が 0 に設定されていることは「フォーカスブロック」を意味します。

パラメータ

  • state Object: グローバルアプリケーションの状態。

戻り値

  • 0|-1|null: 初期位置。

getSelectionEnd

現在の選択終了ブロックのクライアントID、属性キー、およびテキストオフセットを返します。

パラメータ

  • state Object: ブロックエディタの状態。

戻り値

  • WPBlockSelection: 選択終了情報。

getSelectionStart

現在の選択開始ブロックのクライアントID、属性キー、およびテキストオフセットを返します。

パラメータ

  • state Object: ブロックエディタの状態。

戻り値

  • WPBlockSelection: 選択開始情報。

getSettings

エディタの設定を返します。

パラメータ

  • state Object: エディタの状態。

戻り値

  • Object: エディタ設定オブジェクト。

getTemplate

定義されたブロックテンプレートを返します。

パラメータ

  • state boolean:

戻り値

  • ?Array: ブロックテンプレート。

getTemplateLock

定義されたブロックテンプレートロックを返します。オプションで、コンテキストとしてルートブロックのクライアントIDを受け入れます。そうでない場合は、グローバルコンテキストがデフォルトになります。

パラメータ

  • state Object: エディタの状態。
  • rootClientId ?string: オプションのブロックルートクライアントID。

戻り値

  • string|false: ブロックテンプレートロック

hasBlockMovingClientId

非推奨
ブロック移動モードが有効かどうかを返します。

hasDraggedInnerBlock

ブロックの内側のブロックの1つがドラッグされた場合はtrueを返します。

パラメータ

  • state Object: エディタの状態。
  • clientId string: ブロックのクライアントID。
  • deep boolean: 深いチェックを実行します。

戻り値

  • boolean: ブロックに内側のブロックがドラッグされたかどうか

hasInserterItems

インサータに表示するアイテムがあるかどうかを判断します。

パラメータ

  • state Object: エディタの状態。
  • rootClientId ?string: オプションのブロックリストのルートクライアントID。

戻り値

  • boolean: インサータに表示されるアイテム。

hasMultiSelection

マルチ選択が行われた場合はtrueを返し、そうでない場合はfalseを返します。

パラメータ

  • state Object: エディタの状態。

戻り値

  • boolean: マルチ選択が行われたかどうか。

hasSelectedBlock

単一の選択されたブロックがある場合はtrueを返し、そうでない場合はfalseを返します。

パラメータ

  • state Object: エディタの状態。

戻り値

  • boolean: 単一のブロックが選択されているかどうか。

hasSelectedInnerBlock

ブロックの内側のブロックの1つが選択されている場合はtrueを返します。

パラメータ

  • state Object: エディタの状態。
  • clientId string: ブロックのクライアントID。
  • deep boolean: 深いチェックを実行します。

戻り値

  • boolean: ブロックに内側のブロックが選択されているかどうか

isAncestorBeingDragged

ブロックの親/先祖がドラッグされているかどうかを返します。

パラメータ

  • state Object: グローバルアプリケーションの状態。
  • clientId string: チェックするブロックのクライアントID。

戻り値

  • boolean: ブロックの先祖がドラッグされているかどうか。

isAncestorMultiSelected

ブロックの先祖がマルチ選択されている場合はtrueを返し、そうでない場合はfalseを返します。

パラメータ

  • state Object: エディタの状態。
  • clientId string: ブロックのクライアントID。

戻り値

  • boolean: ブロックの先祖がマルチ選択セットに含まれているかどうか。

isBlockBeingDragged

ブロックがドラッグされているかどうかを返します。

ブロックが直接ドラッグされている場合のみtrueを返し、ブロックがドラッグされている親の子である場合はfalseを返します。子ブロックについてはisAncestorBeingDraggedを参照してください。

パラメータ

  • state Object: グローバルアプリケーションの状態。
  • clientId string: チェックするブロックのクライアントID。

戻り値

  • boolean: ブロックがドラッグされているかどうか。

isBlockHighlighted

現在のハイライトされたブロックがブロックのクライアントIDと一致する場合はtrueを返します。

パラメータ

  • state Object: グローバルアプリケーションの状態。
  • clientId string: 確認するブロック。

戻り値

  • boolean: ブロックが現在ハイライトされているかどうか。

isBlockInsertionPointVisible

ブロック挿入ポイントが表示されている場合はtrueを返します。

パラメータ

  • state Object: グローバルアプリケーションの状態。

戻り値

  • ?boolean: 挿入ポイントが表示されているかどうか。

isBlockMultiSelected

クライアントIDがブロックのマルチ選択内に存在する場合はtrueを返し、そうでない場合はfalseを返します。

パラメータ

  • state Object: エディタの状態。
  • clientId string: ブロックのクライアントID。

戻り値

  • boolean: ブロックがマルチ選択セットに含まれているかどうか。

isBlockSelected

指定されたクライアントIDに対応するブロックが現在選択されていて、マルチ選択が存在しない場合はtrueを返し、そうでない場合はfalseを返します。

パラメータ

  • state Object: エディタの状態。
  • clientId string: ブロックのクライアントID。

戻り値

  • boolean: ブロックが選択されていてマルチ選択が存在するかどうか。

isBlockValid

ブロックが有効かどうかを返します。

パラメータ

  • state Object: エディタの状態。
  • clientId string: ブロックのクライアントID。

戻り値

  • boolean: 有効かどうか。

isBlockVisible

ブロックがキャンバス上に表示されているかどうかを示します。

パラメータ

  • state Object: グローバルアプリケーションの状態。
  • clientId Object: ブロックのクライアントID。

戻り値

  • boolean: ブロックが表示されている場合はtrue。

isBlockWithinSelection

指定されたクライアントIDに対応するブロックが現在選択されているが、選択されたブロックの最後ではない場合はtrueを返します。ここで「最後」とは、ドキュメント内のブロックの順序を指し、*マルチ選択の順序ではありません。state.selectionEndは使用されません。

パラメータ

  • state Object: エディタの状態。
  • clientId string: ブロックのクライアントID。

戻り値

  • boolean: ブロックが選択されていて、選択の最後ではないかどうか。

isCaretWithinFormattedText

非推奨
キャレットがフォーマットされたテキスト内にある場合はtrueを返し、そうでない場合はfalseを返します。

戻り値

  • boolean: キャレットがフォーマットされたテキスト内にあるかどうか。

isDraggingBlocks

ユーザーがブロックをドラッグしている場合はtrueを返し、そうでない場合はfalseを返します。

パラメータ

  • state Object: グローバルアプリケーションの状態。

戻り値

  • boolean: ユーザーがブロックをドラッグしているかどうか。

isFirstMultiSelectedBlock

マルチ選択が存在し、指定されたクライアントIDに対応するブロックがマルチ選択セットの最初のブロックである場合はtrueを返し、そうでない場合はfalseを返します。

パラメータ

  • state Object: エディタの状態。
  • clientId string: ブロックのクライアントID。

戻り値

  • boolean: ブロックがマルチ選択の最初であるかどうか。

isGroupable

提供されたブロック（クライアントIDによる）がグループ化可能かどうかを示します。少なくとも1つのブロックが必要で、グループ化ブロック名が設定されており、これらのブロックを削除できる必要があります。

パラメータ

  • state Object: グローバルアプリケーションの状態。
  • clientIds string[]: ブロックのクライアントID。渡されない場合は、選択されたブロックのクライアントIDが使用されます。

戻り値

  • boolean: ブロックがグループ化可能な場合はtrue。

isLastBlockChangePersistent

最も最近のブロック変更が永続的と見なされる場合はtrueを返し、そうでない場合はfalseを返します。永続的な変更は、BlockEditorProviderによってonChangeコールバックを介してコミットされたものであり、onInputに加えてです。

パラメータ

  • state Object: ブロックエディタの状態。

戻り値

  • boolean: 最も最近のブロック変更が永続的であったかどうか。

isMultiSelecting

マルチ選択のプロセス中かどうか。 このフラグは、マルチ選択が選択されている間のみtrueであり（マウス移動によって）、マルチ選択が確定するとfalseになります。

関連

  • hasMultiSelection

パラメータ

  • state Object: グローバルアプリケーションの状態。

戻り値

  • boolean: マルチ選択中はtrue、そうでない場合はfalse。

isNavigationMode

ナビゲーションモードが有効かどうかを返します。

パラメータ

  • state Object: エディタの状態。

戻り値

  • boolean: ナビゲーションモードが有効かどうか。

isSelectionEnabled

マルチ選択が有効かどうかを返すセレクタ。

パラメータ

  • state Object: グローバルアプリケーションの状態。

戻り値

  • boolean: ブロックをマルチ選択できる場合はtrue、マルチ選択が無効な場合はfalse。

isTyping

ユーザーが入力している場合はtrueを返し、そうでない場合はfalseを返します。

パラメータ

  • state Object: グローバルアプリケーションの状態。

戻り値

  • boolean: ユーザーが入力しているかどうか。

isUngroupable

ブロックがグループ化できないかどうかを示します。ブロックが内側のブロックを持つ単一のグループ化ブロックである場合、ブロックはグループ化できません。ブロックにungroup変換がある場合も、デフォルトのグループ化ブロックである必要はなく、グループ化できません。さらに、ブロックは内側のブロックを持ち、削除できる場合にのみグループ解除できます。

パラメータ

  • state Object: グローバルアプリケーションの状態。
  • clientId string: ブロックのクライアントID。渡されない場合は、選択されたブロックのクライアントIDが使用されます。

戻り値

  • boolean: ブロックがグループ化できない場合はtrue。

isValidTemplate

ブロックがテンプレートに一致するかどうかを返します。

パラメータ

  • state boolean:

戻り値

  • ?boolean: テンプレートが有効かどうか。

wasBlockJustInserted

渡されたclientIdのブロックがちょうど挿入されたかどうかを示します。

パラメータ

  • state Object: グローバルアプリケーションの状態。
  • clientId Object: ブロックのクライアントID。
  • source ?string: ブロックのオプションの挿入元。

戻り値

  • boolean: ブロックが指定されたソースから最後に挿入されたブロックと一致する場合はtrue。

Actions

clearSelectedBlock

ブロック選択をクリアするアクション。

戻り値

  • Object: アクションオブジェクト。

duplicateBlocks

ブロックのリストを複製するアクション。

パラメータ

  • clientIds string[]:
  • updateSelection boolean:

enterFormattedText

非推奨
キャレットがフォーマットされたテキストに入ったことを示すアクションオブジェクトを返します。

戻り値

  • Object: アクションオブジェクト。

exitFormattedText

非推奨
ユーザーのキャレットがフォーマットされたテキストから出たことを示すアクションオブジェクトを返します。

戻り値

  • Object: アクションオブジェクト。

flashBlock

指定されたclientIdでブロックを「フラッシュ」するアクション。リズミカルにハイライトします。

パラメータ

  • clientId string: 対象ブロックのクライアントID。

hideInsertionPoint

挿入ポイントを隠すアクション。

hoverBlock

指定されたクライアントIDのブロックがホバーされたことを示すアクションオブジェクトを返します。

パラメータ

  • clientId string: ブロックのクライアントID。

戻り値

  • Object: アクションオブジェクト。

insertAfterBlock

指定されたブロックの後にデフォルトブロックを挿入するアクション。

パラメータ

  • clientId string:

insertBeforeBlock

指定されたブロックの前にデフォルトブロックを挿入するアクション。

パラメータ

  • clientId string:

insertBlock

単一のブロックを挿入するアクション。オプションで、ルートブロックリストに対する特定のインデックスで挿入できます。

許可されたブロックのみが挿入されます。アクションは、許可されていないブロックやブロックリストにテンプレートロックがアクティブな場合に静かに失敗する可能性があります。

パラメータ

  • block Object: 挿入するブロックオブジェクト。
  • index ?number: ブロックを挿入するインデックス。
  • rootClientId ?string: 挿入するブロックリストのオプションのルートクライアントID。
  • updateSelection ?boolean: trueの場合、ブロック選択が更新されます。falseの場合、ブロック選択は変更されません。デフォルトはtrueです。
  • meta ?Object: アクションオブジェクトに渡すオプションのメタ値。

戻り値

  • Object: アクションオブジェクト。

insertBlocks

ブロックの配列を挿入するアクション。オプションで、ルートブロックリストに対する特定のインデックスで挿入できます。

許可されたブロックのみが挿入されます。アクションは、許可されていないブロックやブロックリストにテンプレートロックがアクティブな場合に静かに失敗する可能性があります。

パラメータ

  • blocks Object[]: 挿入するブロックオブジェクト。
  • index ?number: ブロックを挿入するインデックス。
  • rootClientId ?string: 挿入するブロックリストのオプションのルートクライアントID。
  • updateSelection ?boolean: trueの場合、ブロック選択が更新されます。falseの場合、ブロック選択は変更されません。デフォルトはtrueです。
  • initialPosition 0|-1|null: 初期フォーカス位置。nullに設定すると、挿入されたブロックへのフォーカスが防止されます。
  • meta ?Object: アクションオブジェクトに渡すオプションのメタ値。

戻り値

  • Object: アクションオブジェクト。

insertDefaultBlock

デフォルトタイプの新しいブロックをブロックリストに追加するアクション。

パラメータ

  • attributes ?Object: 割り当てるブロックのオプションの属性。
  • rootClientId ?string: 追加するブロックリストのオプションのルートクライアントID。
  • index ?number: デフォルトブロックを挿入するオプションのインデックス。

mergeBlocks

2つのブロックをマージするアクション。

パラメータ

  • firstBlockClientId string: マージする最初のブロックのクライアントID。
  • secondBlockClientId string: マージする2番目のブロックのクライアントID。

moveBlocksDown

文書化されていない宣言です。

moveBlocksToPosition

指定されたブロックを新しい位置に移動するアクション。

パラメータ

  • clientIds ?string: ブロックのクライアントID。
  • fromRootClientId ?string: ルートクライアントIDのソース。
  • toRootClientId ?string: ルートクライアントIDの宛先。
  • index number: ブロックを移動するインデックス。

moveBlocksUp

文書化されていない宣言です。

moveBlockToPosition

指定されたブロックを新しい位置に移動するアクション。

パラメータ

  • clientId ?string: ブロックのクライアントID。
  • fromRootClientId ?string: ルートクライアントIDのソース。
  • toRootClientId ?string: ルートクライアントIDの宛先。
  • index number: ブロックを移動するインデックス。

multiSelect

ブロックのマルチ選択を変更するアクション。

パラメータ

  • start string: マルチ選択の最初のブロック。
  • end string: マルチ選択の最後のブロック。
  • __experimentalInitialPosition number|null: オプションの初期位置。nullを渡すと、エディタキャンバス内でのフォーカスをスキップします。

receiveBlocks

非推奨
ブロックが受信されたことを示すアクションオブジェクトを返します。resetBlocksとは異なり、これらは既存の既知のセットに追加されるべきであり、置き換えるべきではありません。

パラメータ

  • blocks Object[]: ブロックオブジェクトの配列。

戻り値

  • Object: アクションオブジェクト。

registerInserterMediaCategory

新しいインサータメディアカテゴリを登録します。登録されると、メディアカテゴリはインサータのメディアタブで利用可能になります。

次のインターフェースが使用されます：

型定義

  • InserterMediaRequest Object: インサータメディアリクエストのインターフェース。

プロパティ

  • per_page number: ページごとに取得するアイテムの数。
  • search string: 結果をフィルタリングするために使用する検索用語。

型定義

  • InserterMediaItem Object: インサータメディアレスポンスのインターフェース。すべてのメディアリソースは、コアのWordPressメディアブロック（画像、動画、音声）を作成するために、このインターフェースに応じてレスポンスをマッピングする必要があります。

プロパティ

  • title string: メディアアイテムのタイトル。
  • url `string: メディアアイテムのソースURL。
  • previewUrl [string]: メディアリストに表示するメディアアイテムのプレビューソースURL。
  • id [number]: メディアアイテムのWordPress ID。
  • sourceId [number|string]: 外部ソースからのメディアアイテムのID。
  • alt [string]: メディアアイテムの代替テキスト。
  • caption [string]: メディアアイテムのキャプション。

使用法 

  1. wp.data.dispatch( 'core/block-editor' ).registerInserterMediaCategory( {
  2.    name: 'openverse',
  3.    labels: {
  4.    name: 'Openverse',
  5.    search_items: 'Search Openverse',
  6.    },
  7.    mediaType: 'image',
  8.    async fetch( query = {} ) {
  9.    const defaultArgs = {
  10.    mature: false,
  11.    excluded_source: 'flickr,inaturalist,wikimedia',
  12.    license: 'pdm,cc0',
  13.    };
  14.    const finalQuery = { ...query, ...defaultArgs };
  15.    // Sometimes you might need to map the supported request params according to `InserterMediaRequest`.
  16.    // interface. In this example the `search` query param is named `q`.
  17.    const mapFromInserterMediaRequest = {
  18.    per_page: 'page_size',
  19.    search: 'q',
  20.    };
  21.    const url = new URL( 'https://api.openverse.org/v1/images/' );
  22.    Object.entries( finalQuery ).forEach( ( [ key, value ] ) => {
  23.    const queryKey = mapFromInserterMediaRequest[ key ] || key;
  24.    url.searchParams.set( queryKey, value );
  25.    } );
  26.    const response = await window.fetch( url, {
  27.    headers: {
  28.    'User-Agent': 'WordPress/inserter-media-fetch',
  29.    },
  30.    } );
  31.    const jsonResponse = await response.json();
  32.    const results = jsonResponse.results;
  33.    return results.map( ( result ) => ( {
  34.    ...result,
  35.    // If your response result includes an `id` prop that you want to access later, it should
  36.    // be mapped to `InserterMediaItem`'s `sourceId` prop. This can be useful if you provide
  37.    // a report URL getter.
  38.    // Additionally you should always clear the `id` value of your response results because
  39.    // it is used to identify WordPress media items.
  40.    sourceId: result.id,
  41.    id: undefined,
  42.    caption: result.caption,
  43.    previewUrl: result.thumbnail,
  44.    } ) );
  45.    },
  46.    getReportUrl: ( { sourceId } ) =>
  47.    isExternalResource: true,
  48. } );

パラメータ

  • category InserterMediaCategory: 登録するインサータメディアカテゴリ。

型定義

  • InserterMediaCategory Object: インサータメディアカテゴリのインターフェース。

プロパティ

  • name string: メディアカテゴリの名前で、すべてのメディアカテゴリの中で一意である必要があります。
  • labels Object: メディアカテゴリのラベル。
  • labels.name string: メディアカテゴリの一般名。インサータメディアイテムリストで使用されます。
  • labels.search_items [string]: アイテムを検索するためのラベル。デフォルトは「投稿を検索」/「ページを検索」です。
  • mediaType ('image'|'audio'|'video'): メディアカテゴリのメディアタイプ。
  • fetch (InserterMediaRequest) => Promise<InserterMediaItem[]>: カテゴリのメディアアイテムを取得するための関数。
  • getReportUrl [(InserterMediaItem) => string]: メディアカテゴリがメディアアイテムの報告をサポートしている場合、この関数はメディアアイテムの報告URLを返す必要があります。InserterMediaItemを引数として受け入れます。
  • isExternalResource [boolean]: メディアカテゴリが外部リソースである場合、これをtrueに設定する必要があります。これは、ユーザーが外部リソースにリクエストを行うのを避けるために使用されます。

removeBlock

指定されたクライアントIDのブロックを削除することを示すアクションオブジェクトを返します。

パラメータ

  • clientId string: 削除するブロックのクライアントID。
  • selectPrevious boolean: ブロックが削除されるときに前のブロックを選択する場合はtrue。

戻り値

  • Object: アクションオブジェクト。

removeBlocks

指定されたクライアントIDのセットに対応するブロックを削除することを示すアクションオブジェクトを生成します。

パラメータ

  • clientIds string|string[]: 削除するブロックのクライアントID。
  • selectPrevious boolean: ブロックが削除されるときに前のブロックまたは直近の親（前のブロックが存在しない場合）を選択する場合はtrue。

replaceBlock

単一のブロックを1つ以上の置き換えブロックで置き換えるアクション。

パラメータ

  • clientId (string|string[]): 置き換えるブロックのクライアントID。
  • block (Object|Object[]): 置き換えブロック。

戻り値

  • Object: アクションオブジェクト。

replaceBlocks

指定されたブロックを1つ以上の置き換えブロックで置き換えるアクション。

パラメータ

  • clientIds (string|string[]): 置き換えるブロックのクライアントID。
  • blocks (Object|Object[]): 置き換えブロック。
  • indexToSelect number: 選択する置き換えブロックのインデックス。
  • initialPosition 0|-1|null: 操作後に選択されたブロック内のキャレットのインデックス。
  • meta ?Object: アクションオブジェクトに渡すオプションのメタ値。

戻り値

  • Object: アクションオブジェクト。

replaceInnerBlocks

指定されたクライアントIDの内側のブロックを置き換えるべきであることを示すアクションオブジェクトを返します。

パラメータ

  • rootClientId string: 内側のブロックが置き換えられるブロックのクライアントID。
  • blocks Object[]: 新しい内側のブロックとして挿入するブロックオブジェクト
  • updateSelection ?boolean: trueの場合、ブロック選択が更新されます。falseの場合、ブロック選択は変更されません。デフォルトはfalseです。
  • initialPosition 0|-1|null: 初期ブロック位置。

戻り値

  • Object: アクションオブジェクト。

resetBlocks

ブロックの状態を指定されたブロックの配列にリセットするアクション。状態に反映された他のコンテンツよりも優先されます。

パラメータ

  • blocks Array: ブロックの配列。

resetSelection

選択状態を指定された選択にリセットすることを示すアクションオブジェクトを返します。

パラメータ

  • selectionStart WPBlockSelection: 選択開始。
  • selectionEnd WPBlockSelection: 選択終了。
  • initialPosition 0|-1|null: 初期ブロック位置。

戻り値

  • Object: アクションオブジェクト。

selectBlock

指定されたクライアントIDのブロックが選択されたことを示すアクションオブジェクトを返します。選択の方向性を反映する位置値をオプションで受け入れます。初期位置が-1の場合は逆選択を反映します。

パラメータ

  • clientId string: ブロックのクライアントID。
  • initialPosition 0|-1|null: オプションの初期位置。逆選択を反映するには-1を渡します。

戻り値

  • Object: アクションオブジェクト。

selectionChange

ユーザーキャレットの位置を変更するアクション。

パラメータ

  • clientId string|WPSelection: 選択されたブロックのクライアントID。
  • attributeKey string: 選択されたブロックの属性キー。
  • startOffset number: 開始オフセット。
  • endOffset number: 終了オフセット。

戻り値

  • Object: アクションオブジェクト。

selectNextBlock

指定されたclientIdの次のブロックを選択することを示すアクションオブジェクトを生成します。

パラメータ

  • clientId string: ブロックのクライアントID。

selectPreviousBlock

指定されたclientIdの前のブロック（またはオプションで、下から上への最初の親）を選択することを示すアクションオブジェクトを生成します。

パラメータ

  • clientId string: ブロックのクライアントID。
  • fallbackToParent boolean: trueの場合、前のブロックがない場合は最初の親を選択します。

setBlockEditingMode

指定されたブロックのブロック編集モードを設定します。

関連

  • useBlockEditingMode

パラメータ

  • clientId string: ブロックのクライアントID、または '' ルートコンテナのための。
  • mode BlockEditingMode: ブロック編集モード。'disabled'、'contentOnly'、または'default'のいずれか。

戻り値

  • Object: アクションオブジェクト。

setBlockMovingClientId

非推奨
ブロック移動クライアントIDを設定します。

戻り値

  • Object: アクションオブジェクト。

setBlockVisibility

指定されたブロックがキャンバス上に表示されるかどうかを設定するアクション。

パラメータ

  • updates Record<string,boolean>: 各ブロックのクライアントIDに対する新しい可視性設定。

setHasControlledInnerBlocks

ブロックが制御された内側のブロックを持つかどうかを設定するアクション。

パラメータ

  • clientId string: ブロックのクライアントID。
  • hasControlledInnerBlocks boolean: ブロックの内側のブロックが制御されている場合はtrue。

setNavigationMode

ナビゲーションモードを有効または無効にするアクション。

パラメータ

  • isNavigationMode boolean: ナビゲーションモードを有効/無効にします。

setTemplateValidity

テンプレートの有効性をリセットするアクション。

パラメータ

  • isValid boolean: テンプレートの有効性フラグ。

戻り値

  • Object: アクションオブジェクト。

showInsertionPoint

挿入ポイントを表示するアクション。

パラメータ

  • rootClientId ?string: 挿入するブロックリストのオプションのルートクライアントID。
  • index ?number: ブロックを挿入するインデックス。
  • __unstableOptions ?Object: 追加のオプション。

戻り値

  • Object: アクションオブジェクト。

プロパティ

  • __unstableWithInserter boolean: インサータボタンを表示するかどうか。
  • operation WPDropOperation: 適用時に実行する操作。現在は「挿入」または「置き換え」です。

startDraggingBlocks

ユーザーがブロックをドラッグし始めたことを示すアクションオブジェクトを返します。

パラメータ

  • clientIds string[]: ドラッグされているクライアントIDの配列

戻り値

  • Object: アクションオブジェクト。

startMultiSelect

ブロックのマルチ選択を開始するアクション。

戻り値

  • Object: アクションオブジェクト。

startTyping

ユーザーが入力を開始したことを示すアクションオブジェクトを返します。

戻り値

  • Object: アクションオブジェクト。

stopDraggingBlocks

ユーザーがブロックのドラッグを停止したことを示すアクションオブジェクトを返します。

戻り値

  • Object: アクションオブジェクト。

stopMultiSelect

ブロックのマルチ選択を停止するアクション。

戻り値

  • Object: アクションオブジェクト。

stopTyping

ユーザーが入力を停止したことを示すアクションオブジェクトを返します。

戻り値

  • Object: アクションオブジェクト。

synchronizeTemplate

テンプレートをブロックのリストと同期させるアクション。

戻り値

  • Object: アクションオブジェクト。

toggleBlockHighlight

ハイライトされたブロックの状態を切り替えるアクション。

パラメータ

  • clientId string: ブロックのクライアントID。
  • isHighlighted boolean: ハイライト状態。

toggleBlockMode

ビジュアルモードとHTMLモードの間でブロック編集モードを切り替えるために使用されるアクションオブジェクトを返します。

パラメータ

  • clientId string: ブロックのクライアントID。

戻り値

  • Object: アクションオブジェクト。

toggleSelection

ブロック選択を有効または無効にするアクション。

パラメータ

  • isSelectionEnabled [boolean]: ブロック選択を有効にするかどうか。

戻り値

  • Object: アクションオブジェクト。

unsetBlockEditingMode

指定されたブロックのブロック編集モードをクリアします。

関連

  • useBlockEditingMode

パラメータ

  • clientId string: ブロックのクライアントID、または '' ルートコンテナのための。

戻り値

  • Object: アクションオブジェクト。

updateBlock

指定されたクライアントIDのブロックを更新するアクション。

パラメータ

  • clientId string: ブロックのクライアントID。
  • updates Object: マージされるブロック属性。

戻り値

  • Object: アクションオブジェクト。

updateBlockAttributes

指定されたクライアントIDを持つ複数のブロックの属性を更新するアクションです。

パラメータ

  • clientIds string|string[]: ブロックのクライアントID。
  • attributes Object: マージされるブロックの属性。 uniqueByBlockがtrueの場合、clientIdsでキー付けされるべきです。
  • uniqueByBlock boolean: clientIds配列内の各ブロックが一意の属性セットを持つ場合はtrueです。

戻り値

  • Object: アクションオブジェクト。

updateBlockListSettings

指定されたブロックのネストされた設定を変更するアクションです。

パラメータ

  • clientId string | SettingsByClientId: ネストされた設定を受け取るブロックのクライアントID、またはクライアントIDによる設定のオブジェクト。
  • settings Object: ネストされたブロックの新しい設定を持つオブジェクトです。

戻り値

  • Object: アクションオブジェクト

updateSettings

ブロックエディタの設定を更新するアクションです。

パラメータ

  • settings Object: 更新された設定

戻り値

  • Object: アクションオブジェクト

validateBlocksToTemplate

ブロックの有効性は、ブロックの状態（リセット時点で）とテンプレート設定の関数です。 状態の異なる部分に配置される妥協として、ブロックリセットアクションの副作用としてここに実装されています。

パラメータ

  • blocks Array: ブロックの配列。