セレクタ

areMetaBoxesInitialized

メタボックスが初期化されている場合はtrueを返します。

パラメータ

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

戻り値

  • boolean: メタボックスが初期化されているかどうか。

getActiveGeneralSidebarName

現在アクティブな一般サイドバーの名前を返します。一般サイドバーがアクティブでない場合はnullを返します。アクティブな一般サイドバーは、エディターまたはプラグインサイドバーを識別するためのユニークな名前です。

例:

  • edit-post/document
  • my-plugin/insert-image-sidebar

パラメータ

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

戻り値

  • ?string: アクティブな一般サイドバーの名前。

getActiveMetaBoxLocations

アクティブなメタボックスの位置の配列を返します。

パラメータ

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

戻り値

  • string[]: アクティブなメタボックスの位置。

getAllMetaBoxes

利用可能なすべてのメタボックスのリストを返します。

パラメータ

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

戻り値

  • Array: メタボックスのリスト。

getEditedPostTemplate

現在編集中の投稿のテンプレートを取得します。

戻り値

  • Object?: 投稿テンプレート。

getEditorMode

現在の編集モードを返します。

パラメータ

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

戻り値

  • string: 編集モード。

getHiddenBlockTypes

隠されているブロックの配列を返します。

戻り値

  • Array: 隠されているブロックタイプのリスト

getMetaBoxesPerLocation

指定された位置に対して利用可能なすべてのメタボックスのリストを返します。

パラメータ

  • state Object: グローバルアプリケーションの状態。
  • location string: テストするメタボックスの位置。

戻り値

  • ?Array: メタボックスのリスト。

getPreference

パラメータ

  • state Object: グローバルアプリケーションの状態。
  • preferenceKey string: プリファレンスキー。
  • defaultValue *: デフォルト値。

戻り値

  • *: プリファレンス値。

getPreferences

プリファレンスを返します(これらのプリファレンスはローカルに保存されます)。

パラメータ

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

戻り値

  • Object: プリファレンスオブジェクト。

hasMetaBoxes

投稿がメタボックスを使用している場合はtrueを返します。

パラメータ

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

戻り値

  • boolean: メタボックスがあるかどうか。

isEditingTemplate

非推奨
テンプレート編集モードが有効な場合はtrueを返します。

isEditorPanelEnabled

非推奨
指定されたパネルが有効な場合はtrueを返し、そうでない場合はfalseを返します。パネルはデフォルトで有効です。

パラメータ

  • state Object: グローバルアプリケーションの状態。
  • panelName string: パネルを識別する文字列。

戻り値

  • boolean: パネルが有効かどうか。

isEditorPanelOpened

非推奨
指定されたパネルが開いている場合はtrueを返し、そうでない場合はfalseを返します。パネルはデフォルトで閉じています。

パラメータ

  • state Object: グローバルアプリケーションの状態。
  • panelName string: パネルを識別する文字列。

戻り値

  • boolean: パネルが開いているかどうか。

isEditorPanelRemoved

非推奨
指定されたパネルがプログラム的に削除された場合はtrueを返し、そうでない場合はfalseを返します。すべてのパネルはデフォルトで削除されません。

パラメータ

  • state Object: グローバルアプリケーションの状態。
  • panelName string: パネルを識別する文字列。

戻り値

  • boolean: パネルが削除されたかどうか。

isEditorSidebarOpened

エディターサイドバーが開いている場合はtrueを返します。

パラメータ

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

戻り値

  • boolean: エディターサイドバーが開いているかどうか。

isFeatureActive

指定された機能が有効かどうかを返します。

パラメータ

  • state Object: グローバルアプリケーションの状態。
  • feature string: 機能スラッグ。

戻り値

  • boolean: 有効かどうか。

isInserterOpened

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

パラメータ

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

戻り値

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

isListViewOpened

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

パラメータ

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

戻り値

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

isMetaBoxLocationActive

指定された位置にアクティブなメタボックスがある場合はtrueを返し、そうでない場合はfalseを返します。

パラメータ

  • state Object: 投稿エディターの状態。
  • location string: テストするメタボックスの位置。

戻り値

  • boolean: メタボックスの位置がアクティブかどうか。

isMetaBoxLocationVisible

メタボックスの位置がアクティブで可視である場合はtrueを返します。

パラメータ

  • state Object: 投稿エディターの状態。
  • location string: テストするメタボックスの位置。

戻り値

  • boolean: メタボックスの位置がアクティブで可視かどうか。

isModalActive

非推奨 WP 6.3以降は、同じ名前のcore/interfaceストアのセレクタを使用してください。
モーダルがアクティブな場合はtrueを返し、そうでない場合はfalseを返します。

パラメータ

  • state Object: グローバルアプリケーションの状態。
  • modalName string: モーダルを一意に識別する文字列。

戻り値

  • boolean: モーダルがアクティブかどうか。

isPluginItemPinned

プラグインアイテムがヘッダーにピン留めされている場合はtrueを返します。値が設定されていない場合はデフォルトでtrueになります。

パラメータ

  • state Object: グローバルアプリケーションの状態。
  • pluginName string: プラグインアイテムの名前。

戻り値

  • boolean: プラグインアイテムがピン留めされているかどうか。

isPluginSidebarOpened

プラグインサイドバーが開いている場合はtrueを返します。

パラメータ

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

戻り値

  • boolean: プラグインサイドバーが開いているかどうか。

isPublishSidebarOpened

非推奨
公開サイドバーが開いている場合はtrueを返します。

パラメータ

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

戻り値

  • boolean: 公開サイドバーが開いているかどうか。

isSavingMetaBoxes

メタボックスが保存されている場合はtrueを返します。

パラメータ

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

戻り値

  • boolean: メタボックスが保存されているかどうか。

アクション

closeGeneralSidebar

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

closeModal

非推奨 WP 6.3以降は、同じ名前のcore/interfaceストアのアクションを使用してください。
ユーザーがモーダルを閉じたことを示すアクションオブジェクトを返します。

戻り値

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

closePublishSidebar

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

戻り値

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

hideBlockTypes

提供されたブロックタイプを隠すように更新します。

パラメータ

  • blockNames string[]: 隠すブロックタイプの名前。

initializeMetaBoxes

WordPress postboxesスクリプトとメタボックスの保存ロジックを初期化します。

metaBoxUpdatesFailure

メタボックスの更新が失敗したことを示すアクションオブジェクトを返します。

戻り値

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

metaBoxUpdatesSuccess

メタボックスの更新が成功したことを示すアクションオブジェクトを返します。

戻り値

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

openGeneralSidebar

ユーザーがエディターサイドバーを開いたことを示すアクションオブジェクトを返します。

パラメータ

  • name ?string: 開くサイドバーの名前。

openModal

非推奨 WP 6.3以降は、同じ名前のcore/interfaceストアのアクションを使用してください。
ユーザーがモーダルを開いたことを示すアクションオブジェクトを返します。

パラメータ

  • name string: モーダルを一意に識別する文字列。

戻り値

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

openPublishSidebar

非推奨
ユーザーが公開サイドバーを開いたことを示すアクションオブジェクトを返します。

戻り値

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

removeEditorPanel

非推奨
エディターからパネルを削除するために使用されるアクションオブジェクトを返します。

パラメータ

  • panelName string: 削除するパネルを識別する文字列。

戻り値

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

requestMetaBoxUpdates

メタボックスを更新します。

setAvailableMetaBoxesPerLocation

どのメタボックスがどの位置で利用可能かに関する情報を保存します。

パラメータ

  • metaBoxesPerLocation Object: 位置ごとのメタボックス。

setIsEditingTemplate

非推奨
テンプレート編集に切り替えるために使用されるアクションオブジェクトを返します。

setIsInserterOpened

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

パラメータ

  • value boolean|Object: インサータを開くべきか(true)または閉じるべきか(false)。

setIsListViewOpened

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

パラメータ

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

showBlockTypes

提供されたブロックタイプを表示するように更新します。

パラメータ

  • blockNames string[]: 表示するブロックタイプの名前。

switchEditorMode

非推奨
エディターモードを切り替えるために使用されるアクションをトリガーします。

パラメータ

  • mode string: エディターモード。

toggleDistractionFree

非推奨
気を散らさないモードを切り替えるアクション。気を散らさないモードでは、サイドバーがないことが期待されます。z-indexの値が設定されているため、サイドバーを閉じることができません。

toggleEditorPanelEnabled

非推奨
エディター内のパネルを有効または無効にするために使用されるアクションオブジェクトを返します。

パラメータ

  • panelName string: 有効または無効にするパネルを識別する文字列。

戻り値

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

toggleEditorPanelOpened

非推奨
閉じたパネルを開き、開いているパネルを閉じます。

パラメータ

  • panelName string: 開くまたは閉じるパネルを識別する文字列。

toggleFeature

機能フラグを切り替えるために使用されるアクションをトリガーします。

パラメータ

  • feature string: 機能名。

togglePinnedPluginItem

プラグイン名フラグを切り替えるために使用されるアクションオブジェクトをトリガーします。

パラメータ

  • pluginName string: プラグイン名。

togglePublishSidebar

非推奨
ユーザーが公開サイドバーを切り替えたことを示すアクションオブジェクトを返します。

戻り値

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

updatePreferredStyleVariations

非推奨
ブロックが作成されたときにスタイルが自動的に適用されるべきであることを示すアクションオブジェクトを返します。