セレクタ

canInsertBlockType

関連

  • core/block-editor ストアの canInsertBlockType。

canUserUseUnfilteredHTML

ユーザーが unfiltered_html 機能を持っているかどうかを返します。

パラメータ

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

返り値

  • boolean: ユーザーが unfiltered HTML を投稿できるかどうか。

didPostSaveRequestFail

以前の投稿保存が試みられたが失敗した場合は true を返し、それ以外は false を返します。

パラメータ

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

返り値

  • boolean: 投稿保存が失敗したかどうか。

didPostSaveRequestSucceed

以前の投稿保存が成功した場合は true を返し、それ以外は false を返します。

パラメータ

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

返り値

  • boolean: 投稿が正常に保存されたかどうか。

getActivePostLock

アクティブな投稿ロックを返します。

パラメータ

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

返り値

  • Object: ロックオブジェクト。

getAdjacentBlockClientId

関連

  • core/block-editor ストアの getAdjacentBlockClientId。

getAutosaveAttribute

非推奨 5.6 以降。呼び出し元は ‘@wordpress/core-data’ パッケージの getAutosave( postType, postId, userId ) セレクタを使用し、返された autosave オブジェクトのプロパティに getPostRawValue を使用してアクセスする必要があります。
投稿の現在の autosave リビジョンの属性値を返し、投稿に autosave がない場合は null を返します。

パラメータ

  • state Object: グローバルアプリケーションの状態。
  • attributeName string: Autosave 属性名。

返り値

  • *: Autosave 属性値。

getBlock

関連

  • core/block-editor ストアの getBlock。

getBlockAttributes

関連

  • core/block-editor ストアの getBlockAttributes。

getBlockCount

関連

  • core/block-editor ストアの getBlockCount。

getBlockHierarchyRootClientId

関連

  • core/block-editor ストアの getBlockHierarchyRootClientId。

getBlockIndex

関連

  • core/block-editor ストアの getBlockIndex。

getBlockInsertionPoint

関連

  • core/block-editor ストアの getBlockInsertionPoint。

getBlockListSettings

関連

  • core/block-editor ストアの getBlockListSettings。

getBlockMode

関連

  • core/block-editor ストアの getBlockMode。

getBlockName

関連

  • core/block-editor ストアの getBlockName。

getBlockOrder

関連

  • core/block-editor ストアの getBlockOrder。

getBlockRootClientId

関連

  • core/block-editor ストアの getBlockRootClientId。

getBlocks

関連

  • core/block-editor ストアの getBlocks。

getBlocksByClientId

関連

  • core/block-editor ストアの getBlocksByClientId。

getBlockSelectionEnd

関連

  • core/block-editor ストアの getBlockSelectionEnd。

getBlockSelectionStart

関連

  • core/block-editor ストアの getBlockSelectionStart。

getClientIdsOfDescendants

関連

  • core/block-editor ストアの getClientIdsOfDescendants。

getClientIdsWithDescendants

関連

  • core/block-editor ストアの getClientIdsWithDescendants。

getCurrentPost

現在編集中の投稿の最後に保存された状態を返します。未保存の編集は含まれません。投稿がまだ保存されていない場合は、関連するデフォルトの投稿値を含むオブジェクトを返します。

パラメータ

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

返り値

  • Object: 投稿オブジェクト。

getCurrentPostAttribute

保存された投稿の属性値を返します。

パラメータ

  • state Object: グローバルアプリケーションの状態。
  • attributeName string: 投稿属性名。

返り値

  • *: 投稿属性値。

getCurrentPostId

現在編集中の投稿の ID を返します。投稿がまだ保存されていない場合は null を返します。

パラメータ

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

返り値

  • ?number: 現在の投稿の ID。

getCurrentPostLastRevisionId

現在編集中の投稿の最後のリビジョン ID を返します。投稿にリビジョンがない場合は null を返します。

パラメータ

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

返り値

  • ?number: 最後のリビジョンの ID。

getCurrentPostRevisionsCount

現在編集中の投稿のリビジョン数を返します。

パラメータ

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

返り値

  • number: リビジョンの数。

getCurrentPostType

現在編集中の投稿の投稿タイプを返します。

使用法

  1. const currentPostType = wp.data.select( 'core/editor' ).getCurrentPostType();

パラメータ

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

返り値

  • string: 投稿タイプ。

getCurrentTemplateId

現在レンダリング/編集されているテンプレートの ID を返します。

パラメータ

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

返り値

  • string?: テンプレート ID。

getDeviceType

現在の編集キャンバスのデバイスタイプを返します。

パラメータ

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

返り値

  • string: デバイスタイプ。

getEditedPostAttribute

編集中の投稿の単一の属性を返します。未保存の編集が存在する場合はそれを優先し、そうでない場合は投稿の最後に保存された状態の属性にフォールバックします。

使用法

  1. // Get specific media size based on the featured media ID
  2. // Note: change sizes?.large for any registered size
  3. const getFeaturedMediaUrl = useSelect( ( select ) => {
  4. const getFeaturedMediaId =
  5. select( 'core/editor' ).getEditedPostAttribute( 'featured_media' );
  6. const getMedia = select( 'core' ).getMedia( getFeaturedMediaId );
  7. return (
  8. getMedia?.media_details?.sizes?.large?.source_url ||
  9. getMedia?.source_url ||
  10. ''
  11. );
  12. }, [] );

パラメータ

  • state Object: グローバルアプリケーションの状態。
  • attributeName string: 投稿属性名。

返り値

  • *: 投稿属性値。

getEditedPostContent

編集中の投稿の内容を返します。

パラメータ

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

返り値

  • string: 投稿の内容。

投稿のプレビューリンクを返します。

パラメータ

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

返り値

  • string | undefined: プレビューリンク。

getEditedPostSlug

編集中の投稿のスラッグを返します。手動で編集された値が存在する場合はそれを優先し、次に現在の投稿タイトルのサニタイズされたバージョン、最後に投稿 ID を返します。

パラメータ

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

返り値

  • string: エディタに表示される現在のスラッグ。

getEditedPostVisibility

編集中の投稿の現在の可視性を返します。保存された投稿と異なる場合は未保存の値を優先します。返り値は「private」、「password」、または「public」のいずれかです。

パラメータ

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

返り値

  • string: 投稿の可視性。

getEditorBlocks

現在のブロックリストを返します。

パラメータ

  • state Object:

返り値

  • Array: ブロックリスト。

getEditorMode

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

パラメータ

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

返り値

  • string: 編集モード。

getEditorSelection

現在の選択を返します。

パラメータ

  • state Object:

返り値

  • WPBlockSelection: 選択の終了。

getEditorSelectionEnd

非推奨 Gutenberg 10.0.0 以降。
現在の選択の終了を返します。

パラメータ

  • state Object:

返り値

  • WPBlockSelection: 選択の終了。

getEditorSelectionStart

非推奨 Gutenberg 10.0.0 以降。
現在の選択の開始を返します。

パラメータ

  • state Object:

返り値

  • WPBlockSelection: 選択の開始。

getEditorSettings

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

パラメータ

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

返り値

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

getFirstMultiSelectedBlockClientId

関連

  • core/block-editor ストアの getFirstMultiSelectedBlockClientId。

getGlobalBlockCount

関連

  • core/block-editor ストアの getGlobalBlockCount。

getInserterItems

関連

  • core/block-editor ストアの getInserterItems。

getLastMultiSelectedBlockClientId

関連

  • core/block-editor ストアの getLastMultiSelectedBlockClientId。

getMultiSelectedBlockClientIds

関連

  • core/block-editor ストアの getMultiSelectedBlockClientIds。

getMultiSelectedBlocks

関連

  • core/block-editor ストアの getMultiSelectedBlocks。

getMultiSelectedBlocksEndClientId

関連

  • core/block-editor ストアの getMultiSelectedBlocksEndClientId。

getMultiSelectedBlocksStartClientId

関連

  • core/block-editor ストアの getMultiSelectedBlocksStartClientId。

getNextBlockClientId

関連

  • core/block-editor ストアの getNextBlockClientId。

投稿のパーマリンクを返します。

パラメータ

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

返り値

  • ?string: パーマリンク、または投稿が表示できない場合は null。

getPermalinkParts

投稿のパーマリンクを返し、3つの部分に分割します: プレフィックス、postName、サフィックス。

パラメータ

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

返り値

  • Object: パーマリンクのプレフィックス、postName、サフィックスを含むオブジェクト、または投稿が表示できない場合は null。

getPostEdits

エディタで変更された投稿の値を返しますが、まだ保存されていません。

パラメータ

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

返り値

  • Object: 未保存の編集を構成するキーと値のペアのオブジェクト。

getPostLockUser

投稿ロックユーザーに関する詳細を返します。

パラメータ

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

返り値

  • Object: ユーザーオブジェクト。

getPostTypeLabel

現在の投稿に応じた投稿タイプラベルを返します。

パラメータ

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

返り値

  • string|undefined: 利用可能な場合は投稿タイプラベル、それ以外は未定義。

getPreviousBlockClientId

関連

  • core/block-editor ストアの getPreviousBlockClientId。

getRenderingMode

投稿エディタのレンダリングモードを返します。

パラメータ

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

返り値

  • string: レンダリングモード。

getSelectedBlock

関連

  • core/block-editor ストアの getSelectedBlock。

getSelectedBlockClientId

関連

  • core/block-editor ストアの getSelectedBlockClientId。

getSelectedBlockCount

関連

  • core/block-editor ストアの getSelectedBlockCount。

getSelectedBlocksInitialCaretPosition

関連

  • core/block-editor ストアの getSelectedBlocksInitialCaretPosition。

getStateBeforeOptimisticTransaction

非推奨 Gutenberg 9.7.0 以降。
指定された楽観的トランザクション ID の前の状態オブジェクトを返します。指定された ID に対応するトランザクションが見つからない場合は null を返します。

getSuggestedPostFormat

現在の投稿に対する提案された投稿フォーマットを返します。投稿内に単一のブロックがあり、それがデフォルトの投稿フォーマットに一致するタイプである場合のみ推測されます。フォーマットが決定できない場合は null を返します。

返り値

  • ?string: 提案された投稿フォーマット。

getTemplate

関連

  • core/block-editor ストアの getTemplate。

getTemplateLock

関連

  • core/block-editor ストアの getTemplateLock。

hasChangedContent

内容に未保存の変更が含まれている場合は true を返し、それ以外は false を返します。

パラメータ

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

返り値

  • boolean: 内容に未保存の変更が含まれているかどうか。

hasEditorRedo

将来のエディタ履歴スナップショットが存在する場合は true を返し、それ以外は false を返します。

パラメータ

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

返り値

  • boolean: redo 履歴が存在するかどうか。

hasEditorUndo

過去のエディタ履歴スナップショットが存在する場合は true を返し、それ以外は false を返します。

パラメータ

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

返り値

  • boolean: undo 履歴が存在するかどうか。

hasInserterItems

関連

  • core/block-editor ストアの hasInserterItems。

hasMultiSelection

関連

  • core/block-editor ストアの hasMultiSelection。

hasNonPostEntityChanges

エディタの投稿以外のエンティティに未保存の編集がある場合は true を返し、それ以外は false を返します。

パラメータ

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

返り値

  • boolean: 編集があるかどうか。

hasSelectedBlock

関連

  • core/block-editor ストアの hasSelectedBlock。

hasSelectedInnerBlock

関連

  • core/block-editor ストアの hasSelectedInnerBlock。

inSomeHistory

非推奨 Gutenberg 9.7.0 以降。
指定された楽観的トランザクションがコミット待機中であり、その前の状態が指定された述語関数を満たす場合は true を返します。

isAncestorMultiSelected

関連

  • core/block-editor ストアの isAncestorMultiSelected。

isAutosavingPost

投稿が自動保存中である場合は true を返し、それ以外は false を返します。

パラメータ

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

返り値

  • boolean: 投稿が自動保存中かどうか。

isBlockInsertionPointVisible

関連

  • core/block-editor ストアの isBlockInsertionPointVisible。

isBlockMultiSelected

関連

  • core/block-editor ストアの isBlockMultiSelected。

isBlockSelected

関連

  • core/block-editor ストアの isBlockSelected。

isBlockValid

関連

  • core/block-editor ストアの isBlockValid。

isBlockWithinSelection

関連

  • core/block-editor ストアの isBlockWithinSelection。

isCaretWithinFormattedText

関連

  • core/block-editor ストアの isCaretWithinFormattedText。

isCleanNewPost

現在の編集セッションに未保存の値がなく、現在編集中の投稿が新しい場合(以前に保存されたことがない)には true を返します。

パラメータ

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

返り値

  • boolean: 新しい投稿と未保存の値が存在するかどうか。

isCurrentPostPending

投稿がレビュー待ちの場合は true を返します。

パラメータ

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

返り値

  • boolean: 現在の投稿がレビュー待ちかどうか。

isCurrentPostPublished

現在の投稿がすでに公開されている場合は true を返します。

パラメータ

  • state Object: グローバルアプリケーションの状態。
  • currentPost Object?: レジストリセレクタをバイパスするための明示的な現在の投稿。

返り値

  • boolean: 投稿が公開されているかどうか。

isCurrentPostScheduled

投稿がすでにスケジュールされている場合は true を返します。

パラメータ

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

返り値

  • boolean: 現在の投稿が投稿される予定かどうか。

isDeletingPost

投稿が現在削除中である場合は true を返し、それ以外は false を返します。

パラメータ

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

返り値

  • boolean: 投稿が削除されているかどうか。

isEditedPostAutosaveable

投稿が自動保存可能である場合は true を返し、それ以外は false を返します。

パラメータ

  • state Object: グローバルアプリケーションの状態。
  • autosave Object: REST API からの生の自動保存オブジェクト。

返り値

  • boolean: 投稿が自動保存可能かどうか。

isEditedPostBeingScheduled

編集中の投稿がスケジュールされている場合は true を返します。未保存の状態値を優先します。

パラメータ

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

返り値

  • boolean: 投稿が公開されているかどうか。

isEditedPostDateFloating

現在の投稿が「浮動」日付を持つと見なされるべきかどうかを返します(つまり、設定された時間ではなく「即時」に公開されることを意味します)。

PHP バックエンドとは異なり、REST API は、0000-00-00T00:00:00 プレースホルダーがデータベースに存在する投稿に対して完全な日付文字列を返します。投稿が「即時」に公開されるように設定されているかどうかを推測するために、日付と修正日が同じかどうかを確認します。

パラメータ

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

返り値

  • boolean: 編集された投稿が浮動日付値を持つかどうか。

isEditedPostDirty

現在の編集セッションに未保存の値がある場合は true を返し、編集状態が保存された投稿または新しい投稿と一致する場合は false を返します。

パラメータ

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

返り値

  • boolean: 未保存の値が存在するかどうか。

isEditedPostEmpty

編集された投稿にコンテンツがある場合は true を返します。投稿には、少なくとも1つの保存可能なブロックがあるか、そうでなければ非空のコンテンツプロパティが割り当てられている場合にコンテンツがあります。

パラメータ

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

返り値

  • boolean: 投稿にコンテンツがあるかどうか。

isEditedPostNew

現在編集中の投稿がまだ保存されていない場合は true を返し、投稿が保存されている場合は false を返します。

パラメータ

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

返り値

  • boolean: 投稿が新しいかどうか。

isEditedPostPublishable

編集中の投稿が公開可能である場合は true を返します。

パラメータ

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

返り値

  • boolean: 投稿が公開可能かどうか。

isEditedPostSaveable

投稿が保存可能である場合は true を返し、それ以外は false を返します。投稿は、保存するためにタイトル、抜粋、または非空のコンテンツを含む必要があります。

パラメータ

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

返り値

  • boolean: 投稿が保存可能かどうか。

isEditorPanelEnabled

指定されたパネルが有効である場合は true を返し、それ以外は false を返します。パネルはデフォルトで有効です。

パラメータ

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

返り値

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

isEditorPanelOpened

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

パラメータ

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

返り値

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

isEditorPanelRemoved

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

パラメータ

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

返り値

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

isFirstMultiSelectedBlock

関連

  • core/block-editor ストアの isFirstMultiSelectedBlock。

isInserterOpened

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

パラメータ

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

返り値

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

isListViewOpened

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

パラメータ

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

返り値

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

isMultiSelecting

関連

  • core/block-editor ストアの isMultiSelecting。

isPermalinkEditable

パーマリンクが編集可能かどうかを返します。

パラメータ

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

返り値

  • boolean: パーマリンクが編集可能かどうか。

isPostAutosavingLocked

投稿の自動保存がロックされているかどうかを返します。

パラメータ

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

返り値

  • boolean: ロックされているかどうか。

isPostLocked

投稿がロックされているかどうかを返します。

パラメータ

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

返り値

  • boolean: ロックされているかどうか。

isPostLockTakeover

投稿の編集が引き継がれたかどうかを返します。

パラメータ

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

返り値

  • boolean: 投稿ロックの引き継ぎかどうか。

isPostSavingLocked

投稿の保存がロックされているかどうかを返します。

パラメータ

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

返り値

  • boolean: ロックされているかどうか。

isPreviewingPost

投稿がプレビュー中である場合は true を返し、それ以外は false を返します。

パラメータ

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

返り値

  • boolean: 投稿がプレビュー中かどうか。

isPublishingPost

投稿が公開中である場合は true を返し、それ以外は false を返します。

パラメータ

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

返り値

  • boolean: 投稿が公開中かどうか。

isPublishSidebarEnabled

ユーザーが「公開」ボタンをクリックしたときに、公開前パネルを表示するかスキップするかを返します。

返り値

  • boolean: 公開前パネルを表示するかどうか。

isPublishSidebarOpened

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

パラメータ

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

返り値

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

isSavingNonPostEntityChanges

非投稿エンティティが現在保存されている場合は true を返し、それ以外は false を返します。

パラメータ

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

返り値

  • boolean: 非投稿エンティティが保存されているかどうか。

isSavingPost

投稿が現在保存中である場合は true を返し、それ以外は false を返します。

パラメータ

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

返り値

  • boolean: 投稿が保存中かどうか。

isSelectionEnabled

関連

  • core/block-editor ストアの isSelectionEnabled。

isTyping

関連

  • core/block-editor ストアの isTyping。

isValidTemplate

関連

  • core/block-editor ストアの isValidTemplate。

Actions

autosave

現在の投稿を自動保存するアクションです。これにはサーバー側の自動保存(デフォルト)とクライアント側(ローカルとも呼ばれる)の自動保存が含まれます(例:Web上では、投稿がセッションストレージにコミットされることがあります)。

パラメータ

  • options Object?: 自動保存を識別するための追加フラグ。

clearSelectedBlock

関連

  • core/block-editor ストアの clearSelectedBlock。

closePublishSidebar

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

戻り値

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

createUndoLevel

非推奨 WordPress 6.0 以降
アンドゥ履歴レコードを作成するアクションです。

disablePublishSidebar

公開サイドバーを無効にします。

editPost

投稿の属性が編集されたことを通知するために使用されるアクションオブジェクトを返します。

使用法

  1. // Update the post title
  2. wp.data.dispatch( 'core/editor' ).editPost( { title: `${ newTitle }` } );
  1. // Get specific media size based on the featured media ID
  2. // Note: change sizes?.large for any registered size
  3. const getFeaturedMediaUrl = useSelect( ( select ) => {
  4. const getFeaturedMediaId =
  5. select( 'core/editor' ).getEditedPostAttribute( 'featured_media' );
  6. const getMedia = select( 'core' ).getMedia( getFeaturedMediaId );
  7. return (
  8. getMedia?.media_details?.sizes?.large?.source_url ||
  9. getMedia?.source_url ||
  10. ''
  11. );
  12. }, [] );

パラメータ

  • edits Object: 編集する投稿属性。
  • options Object: 編集のオプション。

戻り値

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

enablePublishSidebar

公開サイドバーを有効にします。

enterFormattedText

関連

  • core/block-editor ストアの enterFormattedText。

exitFormattedText

関連

  • core/block-editor ストアの exitFormattedText。

hideInsertionPoint

関連

  • core/block-editor ストアの hideInsertionPoint。

insertBlock

関連

  • core/block-editor ストアの insertBlock。

insertBlocks

関連

  • core/block-editor ストアの insertBlocks。

insertDefaultBlock

関連

  • core/block-editor ストアの insertDefaultBlock。

lockPostAutosaving

投稿の自動保存をロックするアクションです。

使用法

  1. // Lock post autosaving with the lock key `mylock`:
  2. wp.data.dispatch( 'core/editor' ).lockPostAutosaving( 'mylock' );

パラメータ

  • lockName string: ロック名。

戻り値

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

lockPostSaving

投稿の保存をロックするアクションです。

使用法

  1. const { subscribe } = wp.data;
  2. const initialPostStatus = wp.data.select( 'core/editor' ).getEditedPostAttribute( 'status' );
  3. // Only allow publishing posts that are set to a future date.
  4. if ( 'publish' !== initialPostStatus ) {
  5. // Track locking.
  6. let locked = false;
  7. // Watch for the publish event.
  8. let unssubscribe = subscribe( () => {
  9. const currentPostStatus = wp.data.select( 'core/editor' ).getEditedPostAttribute( 'status' );
  10. if ( 'publish' !== currentPostStatus ) {
  11. // Compare the post date to the current date, lock the post if the date isn't in the future.
  12. const postDate = new Date( wp.data.select( 'core/editor' ).getEditedPostAttribute( 'date' ) );
  13. const currentDate = new Date();
  14. if ( postDate.getTime() <= currentDate.getTime() ) {
  15. if ( ! locked ) {
  16. locked = true;
  17. wp.data.dispatch( 'core/editor' ).lockPostSaving( 'futurelock' );
  18. }
  19. } else {
  20. if ( locked ) {
  21. locked = false;
  22. wp.data.dispatch( 'core/editor' ).unlockPostSaving( 'futurelock' );
  23. }
  24. }
  25. }
  26. } );
  27. }

パラメータ

  • lockName string: ロック名。

戻り値

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

mergeBlocks

関連

  • core/block-editor ストアの mergeBlocks。

moveBlocksDown

関連

  • core/block-editor ストアの moveBlocksDown。

moveBlocksUp

関連

  • core/block-editor ストアの moveBlocksUp。

moveBlockToPosition

関連

  • core/block-editor ストアの moveBlockToPosition。

multiSelect

関連

  • core/block-editor ストアの multiSelect。

openPublishSidebar

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

戻り値

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

receiveBlocks

関連

  • core/block-editor ストアの receiveBlocks。

redo

アンドゥ履歴から最後のポップされた状態を復元するアクションです。

refreshPost

非推奨 WordPress 6.0 以降。
現在の投稿をリフレッシュするためのアクションです。

removeBlock

関連

  • core/block-editor ストアの removeBlock。

removeBlocks

関連

  • core/block-editor ストアの removeBlocks。

removeEditorPanel

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

パラメータ

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

戻り値

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

replaceBlock

関連

  • core/block-editor ストアの replaceBlock。

replaceBlocks

関連

  • core/block-editor ストアの replaceBlocks。

resetBlocks

関連

  • core/block-editor ストアの resetBlocks。

resetEditorBlocks

ブロックが更新されたことを通知するために使用されるアクションオブジェクトを返します。

パラメータ

  • blocks Array: ブロック配列。
  • options ?Object: オプションのオプション。

resetPost

非推奨 WordPress 6.0 以降。
最新の投稿のバージョンが初期化または保存によって受信されたことを通知するために使用されるアクションオブジェクトを返します。

savePost

エディタ内で現在の投稿を保存するためのアクションです。

パラメータ

  • options Object:

selectBlock

関連

  • core/block-editor ストアの selectBlock。

setDeviceType

編集キャンバスの幅を変更するアクションです。

パラメータ

  • deviceType string:

戻り値

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

setEditedPost

現在の投稿タイプと投稿IDを設定するアクションを返します。

パラメータ

  • postType string: 投稿タイプ。
  • postId string: 投稿ID。

戻り値

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

setIsInserterOpened

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

パラメータ

  • value boolean|Object: インサータを開くべきか(true)または閉じるべきか(false)。挿入ポイントを指定するには、オブジェクトを使用します。
  • value.rootClientId string: 挿入するためのルートクライアントID。
  • value.insertionIndex number: 挿入するインデックス。
  • value.filterValue string: インサータの結果をフィルタリングするためのクエリ。
  • value.onSelect Function: アイテムが選択されたときのコールバック。
  • value.tab string: インサータで開くタブ。
  • value.category string: インサータで初期化するカテゴリ。

戻り値

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

setIsListViewOpened

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

パラメータ

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

戻り値

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

setRenderingMode

投稿エディタのレンダリングモードを設定するために使用されるアクションを返します。複数のレンダリングモードをサポートしています:

  • post-only: このモードは、テンプレートから投稿ブロックを抽出し、それだけをレンダリングします。ユーザーがラッピングテンプレートなしで投稿/ページを孤立して編集できるようにすることが目的です。
  • template-locked: このモードは、テンプレートと投稿ブロックの両方をレンダリングしますが、テンプレートブロックはロックされており、編集できません。投稿ブロックは編集可能です。

パラメータ

  • mode string: モード(‘post-only’または‘template-locked’のいずれか)。

setTemplateValidity

関連

  • core/block-editor ストアの setTemplateValidity。

setupEditor

指定された投稿オブジェクトとエディタ設定でエディタが初期化されたことを通知するために使用されるアクションジェネレータを返します。

パラメータ

  • post Object: 投稿オブジェクト。
  • edits Object: 初期編集属性オブジェクト。
  • template Array?: ブロックテンプレート。

setupEditorState

非推奨
エディタの状態を設定します。

パラメータ

  • post Object: 投稿オブジェクト。

showInsertionPoint

関連

  • core/block-editor ストアの showInsertionPoint。

startMultiSelect

関連

  • core/block-editor ストアの startMultiSelect。

startTyping

関連

  • core/block-editor ストアの startTyping。

stopMultiSelect

関連

  • core/block-editor ストアの stopMultiSelect。

stopTyping

関連

  • core/block-editor ストアの stopTyping。

switchEditorMode

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

パラメータ

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

synchronizeTemplate

関連

  • core/block-editor ストアの synchronizeTemplate。

toggleBlockMode

関連

  • core/block-editor ストアの toggleBlockMode。

toggleDistractionFree

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

toggleEditorPanelEnabled

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

パラメータ

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

戻り値

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

toggleEditorPanelOpened

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

パラメータ

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

togglePublishSidebar

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

戻り値

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

toggleSelection

関連

  • core/block-editor ストアの toggleSelection。

trashPost

エディタ内で現在の投稿をゴミ箱に移動するためのアクションです。

undo

アンドゥ履歴からレコードをポップし、編集を元に戻すアクションです。

unlockPostAutosaving

投稿の自動保存を解除するアクションです。

使用法

  1. // Unlock post saving with the lock key `mylock`:
  2. wp.data.dispatch( 'core/editor' ).unlockPostAutosaving( 'mylock' );

パラメータ

  • lockName string: ロック名。

戻り値

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

unlockPostSaving

投稿の保存を解除するアクションです。

使用法

  1. // Unlock post saving with the lock key `mylock`:
  2. wp.data.dispatch( 'core/editor' ).unlockPostSaving( 'mylock' );

パラメータ

  • lockName string: ロック名。

戻り値

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

updateBlock

関連

  • core/block-editor ストアの updateBlock。

updateBlockAttributes

関連

  • core/block-editor ストアの updateBlockAttributes。

updateBlockListSettings

関連

  • core/block-editor ストアの updateBlockListSettings。

updateEditorSettings

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

updatePost

非推奨 Gutenberg 9.7.0 以降。
最新の投稿のバージョンに対する更新パッチが受信されたことを通知するために使用されるアクションオブジェクトを返します。

戻り値

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

updatePostLock

エディタをロックするアクションです。

パラメータ

  • lock Object: 投稿ロック状態、ユーザー、および nonce に関する詳細。

戻り値

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