セレクタ

canInsertBlockInWidgetArea

ウィジェットエリアにブロックを挿入できる場合はtrueを返します。

パラメータ

  • state Array: ウィジェットエリアのオープン状態。
  • blockName string: 挿入されるブロックの名前。

返り値

  • boolean: ブロックがウィジェットエリアに挿入できる場合はtrue。

getEditedWidgetAreas

編集されたすべてのウィジェットエリアエンティティレコードを返します。

返り値

  • Object[]: 編集されたウィジェットエリアエンティティレコードのリスト。

getIsWidgetAreaOpen

ウィジェットエリアが開いているかどうかを取得します。

パラメータ

  • state Array: ウィジェットエリアのオープン状態。
  • clientId string: ウィジェットエリアのclientId。

返り値

  • boolean: ウィジェットエリアが開いている場合はtrue。

getParentWidgetAreaBlock

子のclient idが与えられた場合、親ウィジェットエリアブロックを返します。

パラメータ

  • clientId string: ウィジェットエリア内のブロックのclient id。

返り値

  • WPBlock: ウィジェットエリアブロック。

getReferenceWidgetBlocks

参照ウィジェットを表すすべてのブロックを返します。

パラメータ

  • referenceWidgetName string: オプション。指定された場合、この名前の参照ウィジェットのみが返されます。

返り値

  • Array: 参照ウィジェットを表すすべてのブロックのリスト

getWidget

特定のウィジェットIDのAPIウィジェットデータを返します。

パラメータ

  • id number: ウィジェットID。

返り値

  • Object: 特定のウィジェットIDのAPIウィジェットデータ。

getWidgetAreaForWidgetId

指定されたwidgetIdによって識別されるブロックを含むwidgetAreaを返します。

パラメータ

  • widgetId string: ウィジェットのID。

返り値

  • Object: 含まれるウィジェットエリア。

getWidgetAreas

すべてのAPIウィジェットエリアを返します。

返り値

  • Object[]: APIウィジェットエリアのリスト。

getWidgets

すべてのAPIウィジェットを返します。

返り値

  • Object[]: APIウィジェットのリスト。

isInserterOpened

インサータが開いている場合はtrueを返します。

パラメータ

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

返り値

  • boolean: インサータが開いているかどうか。

isListViewOpened

リストビューが開いている場合はtrueを返します。

パラメータ

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

返り値

  • boolean: リストビューが開いているかどうか。

isSavingWidgetAreas

現在、任意のウィジェットエリアが保存されている場合はtrueを返します。

返り値

  • boolean: 現在、任意のウィジェットエリアが保存されている場合はtrue。そうでない場合はfalse。

アクション

closeGeneralSidebar

ユーザーがサイドバーを閉じたことを示すアクションオブジェクトを返します。

返り値

  • Object: アクションクリエーター。

moveBlockToWidgetArea

ウィジェットエリア間でブロックを移動する処理を行うアクション

パラメータ

  • clientId string: 移動するブロックのclientId。
  • widgetAreaId string: ブロックを移動するウィジェットエリアのID。

persistStubPost

指定されたIDのスタブポストをコアデータストアに永続化します。このポストはメモリ内のみで存在し、APIを介して保存されるべきではありません。

パラメータ

  • id string: ポストID。
  • blocks Array: ポストが含むべきブロック。

返り値

  • Object: ポストオブジェクト。

saveEditedWidgetAreas

編集されたウィジェットエリアからすべてのブロックをウィジェットに変換し、一度にすべてを保存するためのバッチリクエストを送信します。

成功またはエラーのいずれかでスナックバー通知を作成します。

返り値

  • Function: アクションクリエーター。

saveWidgetArea

指定されたIDのウィジェットエリアからすべてのブロックをウィジェットに変換し、一度にすべてを保存するためのバッチリクエストを送信します。

パラメータ

  • widgetAreaId string: 処理するウィジェットエリアのID。

返り値

  • Function: アクションクリエーター。

saveWidgetAreas

指定されたウィジェットエリアからすべてのブロックをウィジェットに変換し、一度にすべてを保存するためのバッチリクエストを送信します。

パラメータ

  • widgetAreas Object[]: 保存するウィジェットエリア。

返り値

  • Function: アクションクリエーター。

setIsInserterOpened

インサータを開く/閉じるために使用されるアクションオブジェクトを返します。

パラメータ

  • value boolean|Object: インサータを開くべきか（true）または閉じるべきか（false）。挿入ポイントを指定するには、オブジェクトを使用します。
  • value.rootClientId string: 挿入するためのルートclient ID。
  • value.insertionIndex number: 挿入するインデックス。

返り値

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

setIsListViewOpened

リストビューを開く/閉じるために使用されるアクションオブジェクトを返します。

パラメータ

  • isOpen boolean: リストビューを開くべきか閉じるべきかを表すブール値。

返り値

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

setIsWidgetAreaOpen

ウィジェットエリアのオープン状態を設定します。

パラメータ

  • clientId string: ウィジェットエリアのclientId。
  • isOpen boolean: ウィジェットエリアを開くべきかどうか。

返り値

  • Object: アクション。

setWidgetAreasOpenState

すべてのウィジェットエリアのオープン状態を設定します。

パラメータ

  • widgetAreasOpenState Object: すべてのウィジェットエリアのオープン状態。

返り値

  • Object: アクション。

setWidgetIdForClientId

特定のwidgetIdに対して保存されるclientIdを設定します。

パラメータ

  • clientId number: クライアントID。
  • widgetId number: ウィジェットID。

返り値

  • Object: アクション。