- セレクタ
- canInsertBlockType
- canUserUseUnfilteredHTML
- didPostSaveRequestFail
- didPostSaveRequestSucceed
- getActivePostLock
- getAdjacentBlockClientId
- getAutosaveAttribute
- getBlock
- getBlockAttributes
- getBlockCount
- getBlockHierarchyRootClientId
- getBlockIndex
- getBlockInsertionPoint
- getBlockListSettings
- getBlockMode
- getBlockName
- getBlockOrder
- getBlockRootClientId
- getBlocks
- getBlocksByClientId
- getBlockSelectionEnd
- getBlockSelectionStart
- getClientIdsOfDescendants
- getClientIdsWithDescendants
- getCurrentPost
- getCurrentPostAttribute
- getCurrentPostId
- getCurrentPostLastRevisionId
- getCurrentPostRevisionsCount
- getCurrentPostType
- getCurrentTemplateId
- getDeviceType
- getEditedPostAttribute
- getEditedPostContent
- getEditedPostPreviewLink
- getEditedPostSlug
- getEditedPostVisibility
- getEditorBlocks
- getEditorMode
- getEditorSelection
- getEditorSelectionEnd
- getEditorSelectionStart
- getEditorSettings
- getFirstMultiSelectedBlockClientId
- getGlobalBlockCount
- getInserterItems
- getLastMultiSelectedBlockClientId
- getMultiSelectedBlockClientIds
- getMultiSelectedBlocks
- getMultiSelectedBlocksEndClientId
- getMultiSelectedBlocksStartClientId
- getNextBlockClientId
- getPermalink
- getPermalinkParts
- getPostEdits
- getPostLockUser
- getPostTypeLabel
- getPreviousBlockClientId
- getRenderingMode
- getSelectedBlock
- getSelectedBlockClientId
- getSelectedBlockCount
- getSelectedBlocksInitialCaretPosition
- getStateBeforeOptimisticTransaction
- getSuggestedPostFormat
- getTemplate
- getTemplateLock
- hasChangedContent
- hasEditorRedo
- hasEditorUndo
- hasInserterItems
- hasMultiSelection
- hasNonPostEntityChanges
- hasSelectedBlock
- hasSelectedInnerBlock
- inSomeHistory
- isAncestorMultiSelected
- isAutosavingPost
- isBlockInsertionPointVisible
- isBlockMultiSelected
- isBlockSelected
- isBlockValid
- isBlockWithinSelection
- isCaretWithinFormattedText
- isCleanNewPost
- isCurrentPostPending
- isCurrentPostPublished
- isCurrentPostScheduled
- isDeletingPost
- isEditedPostAutosaveable
- isEditedPostBeingScheduled
- isEditedPostDateFloating
- isEditedPostDirty
- isEditedPostEmpty
- isEditedPostNew
- isEditedPostPublishable
- isEditedPostSaveable
- isEditorPanelEnabled
- isEditorPanelOpened
- isEditorPanelRemoved
- isFirstMultiSelectedBlock
- isInserterOpened
- isListViewOpened
- isMultiSelecting
- isPermalinkEditable
- isPostAutosavingLocked
- isPostLocked
- isPostLockTakeover
- isPostSavingLocked
- isPreviewingPost
- isPublishingPost
- isPublishSidebarEnabled
- isPublishSidebarOpened
- isSavingNonPostEntityChanges
- isSavingPost
- isSelectionEnabled
- isTyping
- isValidTemplate
- Actions
- autosave
- clearSelectedBlock
- closePublishSidebar
- createUndoLevel
- disablePublishSidebar
- editPost
- enablePublishSidebar
- enterFormattedText
- exitFormattedText
- hideInsertionPoint
- insertBlock
- insertBlocks
- insertDefaultBlock
- lockPostAutosaving
- lockPostSaving
- mergeBlocks
- moveBlocksDown
- moveBlocksUp
- moveBlockToPosition
- multiSelect
- openPublishSidebar
- receiveBlocks
- redo
- refreshPost
- removeBlock
- removeBlocks
- removeEditorPanel
- replaceBlock
- replaceBlocks
- resetBlocks
- resetEditorBlocks
- resetPost
- savePost
- selectBlock
- setDeviceType
- setEditedPost
- setIsInserterOpened
- setIsListViewOpened
- setRenderingMode
- setTemplateValidity
- setupEditor
- setupEditorState
- showInsertionPoint
- startMultiSelect
- startTyping
- stopMultiSelect
- stopTyping
- switchEditorMode
- synchronizeTemplate
- toggleBlockMode
- toggleDistractionFree
- toggleEditorPanelEnabled
- toggleEditorPanelOpened
- togglePublishSidebar
- toggleSelection
- trashPost
- undo
- unlockPostAutosaving
- unlockPostSaving
- updateBlock
- updateBlockAttributes
- updateBlockListSettings
- updateEditorSettings
- updatePost
- updatePostLock
セレクタ
canInsertBlockType
関連
canUserUseUnfilteredHTML
ユーザーが unfiltered_html 機能を持っているかどうかを返します。
パラメータ
- state
Object
: エディタの状態。
返り値
didPostSaveRequestFail
以前の投稿保存が試みられたが失敗した場合は true を返し、それ以外は false を返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
didPostSaveRequestSucceed
以前の投稿保存が成功した場合は true を返し、それ以外は false を返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
getActivePostLock
アクティブな投稿ロックを返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
getAdjacentBlockClientId
関連
getAutosaveAttribute
非推奨 5.6 以降。呼び出し元は ‘@wordpress/core-data’ パッケージの
getAutosave( postType, postId, userId )
セレクタを使用し、返された autosave オブジェクトのプロパティに getPostRawValue を使用してアクセスする必要があります。
投稿の現在の autosave リビジョンの属性値を返し、投稿に autosave がない場合は null を返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。 - attributeName
string
: Autosave 属性名。
返り値
getBlock
関連
getBlockAttributes
関連
getBlockCount
関連
getBlockHierarchyRootClientId
関連
getBlockIndex
関連
getBlockInsertionPoint
関連
getBlockListSettings
関連
getBlockMode
関連
getBlockName
関連
getBlockOrder
関連
getBlockRootClientId
関連
getBlocks
関連
getBlocksByClientId
関連
getBlockSelectionEnd
関連
getBlockSelectionStart
関連
getClientIdsOfDescendants
関連
getClientIdsWithDescendants
関連
getCurrentPost
現在編集中の投稿の最後に保存された状態を返します。未保存の編集は含まれません。投稿がまだ保存されていない場合は、関連するデフォルトの投稿値を含むオブジェクトを返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
getCurrentPostAttribute
保存された投稿の属性値を返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。 - attributeName
string
: 投稿属性名。
返り値
getCurrentPostId
現在編集中の投稿の ID を返します。投稿がまだ保存されていない場合は null を返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
getCurrentPostLastRevisionId
現在編集中の投稿の最後のリビジョン ID を返します。投稿にリビジョンがない場合は null を返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
getCurrentPostRevisionsCount
現在編集中の投稿のリビジョン数を返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
getCurrentPostType
現在編集中の投稿の投稿タイプを返します。
使用法
const currentPostType = wp.data.select( 'core/editor' ).getCurrentPostType();
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
getCurrentTemplateId
現在レンダリング/編集されているテンプレートの ID を返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
getDeviceType
現在の編集キャンバスのデバイスタイプを返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
getEditedPostAttribute
編集中の投稿の単一の属性を返します。未保存の編集が存在する場合はそれを優先し、そうでない場合は投稿の最後に保存された状態の属性にフォールバックします。
使用法
// Get specific media size based on the featured media ID
// Note: change sizes?.large for any registered size
const getFeaturedMediaUrl = useSelect( ( select ) => {
const getFeaturedMediaId =
select( 'core/editor' ).getEditedPostAttribute( 'featured_media' );
const getMedia = select( 'core' ).getMedia( getFeaturedMediaId );
return (
getMedia?.media_details?.sizes?.large?.source_url ||
getMedia?.source_url ||
''
);
}, [] );
パラメータ
- state
Object
: グローバルアプリケーションの状態。 - attributeName
string
: 投稿属性名。
返り値
getEditedPostContent
編集中の投稿の内容を返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
getEditedPostPreviewLink
投稿のプレビューリンクを返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
getEditedPostSlug
編集中の投稿のスラッグを返します。手動で編集された値が存在する場合はそれを優先し、次に現在の投稿タイトルのサニタイズされたバージョン、最後に投稿 ID を返します。
パラメータ
- state
Object
: エディタの状態。
返り値
getEditedPostVisibility
編集中の投稿の現在の可視性を返します。保存された投稿と異なる場合は未保存の値を優先します。返り値は「private」、「password」、または「public」のいずれかです。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
getEditorBlocks
現在のブロックリストを返します。
パラメータ
- state
Object
:
返り値
getEditorMode
現在の編集モードを返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
getEditorSelection
現在の選択を返します。
パラメータ
- state
Object
:
返り値
getEditorSelectionEnd
非推奨 Gutenberg 10.0.0 以降。
現在の選択の終了を返します。
パラメータ
- state
Object
:
返り値
getEditorSelectionStart
非推奨 Gutenberg 10.0.0 以降。
現在の選択の開始を返します。
パラメータ
- state
Object
:
返り値
getEditorSettings
投稿エディタの設定を返します。
パラメータ
- state
Object
: エディタの状態。
返り値
getFirstMultiSelectedBlockClientId
関連
getGlobalBlockCount
関連
getInserterItems
関連
getLastMultiSelectedBlockClientId
関連
getMultiSelectedBlockClientIds
関連
getMultiSelectedBlocks
関連
getMultiSelectedBlocksEndClientId
関連
getMultiSelectedBlocksStartClientId
関連
getNextBlockClientId
関連
getPermalink
投稿のパーマリンクを返します。
パラメータ
- state
Object
: エディタの状態。
返り値
getPermalinkParts
投稿のパーマリンクを返し、3つの部分に分割します: プレフィックス、postName、サフィックス。
パラメータ
- state
Object
: エディタの状態。
返り値
getPostEdits
エディタで変更された投稿の値を返しますが、まだ保存されていません。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
getPostLockUser
投稿ロックユーザーに関する詳細を返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
getPostTypeLabel
現在の投稿に応じた投稿タイプラベルを返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
getPreviousBlockClientId
関連
getRenderingMode
投稿エディタのレンダリングモードを返します。
パラメータ
- state
Object
: エディタの状態。
返り値
getSelectedBlock
関連
getSelectedBlockClientId
関連
getSelectedBlockCount
関連
getSelectedBlocksInitialCaretPosition
関連
getStateBeforeOptimisticTransaction
非推奨 Gutenberg 9.7.0 以降。
指定された楽観的トランザクション ID の前の状態オブジェクトを返します。指定された ID に対応するトランザクションが見つからない場合はnull
を返します。
getSuggestedPostFormat
現在の投稿に対する提案された投稿フォーマットを返します。投稿内に単一のブロックがあり、それがデフォルトの投稿フォーマットに一致するタイプである場合のみ推測されます。フォーマットが決定できない場合は null を返します。
返り値
getTemplate
関連
getTemplateLock
関連
hasChangedContent
内容に未保存の変更が含まれている場合は true を返し、それ以外は false を返します。
パラメータ
- state
Object
: エディタの状態。
返り値
hasEditorRedo
将来のエディタ履歴スナップショットが存在する場合は true を返し、それ以外は false を返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
hasEditorUndo
過去のエディタ履歴スナップショットが存在する場合は true を返し、それ以外は false を返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
hasInserterItems
関連
hasMultiSelection
関連
hasNonPostEntityChanges
エディタの投稿以外のエンティティに未保存の編集がある場合は true を返し、それ以外は false を返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
hasSelectedBlock
関連
hasSelectedInnerBlock
関連
inSomeHistory
非推奨 Gutenberg 9.7.0 以降。
指定された楽観的トランザクションがコミット待機中であり、その前の状態が指定された述語関数を満たす場合は true を返します。
isAncestorMultiSelected
関連
isAutosavingPost
投稿が自動保存中である場合は true を返し、それ以外は false を返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
isBlockInsertionPointVisible
関連
isBlockMultiSelected
関連
isBlockSelected
関連
isBlockValid
関連
isBlockWithinSelection
関連
isCaretWithinFormattedText
関連
isCleanNewPost
現在の編集セッションに未保存の値がなく、現在編集中の投稿が新しい場合(以前に保存されたことがない)には true を返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
isCurrentPostPending
投稿がレビュー待ちの場合は true を返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
isCurrentPostPublished
現在の投稿がすでに公開されている場合は true を返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。 - currentPost
Object?
: レジストリセレクタをバイパスするための明示的な現在の投稿。
返り値
isCurrentPostScheduled
投稿がすでにスケジュールされている場合は true を返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
isDeletingPost
投稿が現在削除中である場合は true を返し、それ以外は false を返します。
パラメータ
- state
Object
: エディタの状態。
返り値
isEditedPostAutosaveable
投稿が自動保存可能である場合は true を返し、それ以外は false を返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。 - autosave
Object
: REST API からの生の自動保存オブジェクト。
返り値
isEditedPostBeingScheduled
編集中の投稿がスケジュールされている場合は true を返します。未保存の状態値を優先します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
isEditedPostDateFloating
現在の投稿が「浮動」日付を持つと見なされるべきかどうかを返します(つまり、設定された時間ではなく「即時」に公開されることを意味します)。
PHP バックエンドとは異なり、REST API は、0000-00-00T00:00:00 プレースホルダーがデータベースに存在する投稿に対して完全な日付文字列を返します。投稿が「即時」に公開されるように設定されているかどうかを推測するために、日付と修正日が同じかどうかを確認します。
パラメータ
- state
Object
: エディタの状態。
返り値
isEditedPostDirty
現在の編集セッションに未保存の値がある場合は true を返し、編集状態が保存された投稿または新しい投稿と一致する場合は false を返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
isEditedPostEmpty
編集された投稿にコンテンツがある場合は true を返します。投稿には、少なくとも1つの保存可能なブロックがあるか、そうでなければ非空のコンテンツプロパティが割り当てられている場合にコンテンツがあります。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
isEditedPostNew
現在編集中の投稿がまだ保存されていない場合は true を返し、投稿が保存されている場合は false を返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
isEditedPostPublishable
編集中の投稿が公開可能である場合は true を返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
isEditedPostSaveable
投稿が保存可能である場合は true を返し、それ以外は false を返します。投稿は、保存するためにタイトル、抜粋、または非空のコンテンツを含む必要があります。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
isEditorPanelEnabled
指定されたパネルが有効である場合は true を返し、それ以外は false を返します。パネルはデフォルトで有効です。
パラメータ
- state
Object
: グローバルアプリケーションの状態。 - panelName
string
: パネルを識別する文字列。
返り値
isEditorPanelOpened
指定されたパネルが開いている場合は true を返し、それ以外は false を返します。パネルはデフォルトで閉じています。
パラメータ
- state
Object
: グローバルアプリケーションの状態。 - panelName
string
: パネルを識別する文字列。
返り値
isEditorPanelRemoved
指定されたパネルがプログラム的に削除された場合は true を返し、それ以外は false を返します。すべてのパネルはデフォルトで削除されません。
パラメータ
- state
Object
: グローバルアプリケーションの状態。 - panelName
string
: パネルを識別する文字列。
返り値
isFirstMultiSelectedBlock
関連
isInserterOpened
インサータが開いている場合は true を返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
isListViewOpened
リストビューが開いている場合は true を返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
isMultiSelecting
関連
isPermalinkEditable
パーマリンクが編集可能かどうかを返します。
パラメータ
- state
Object
: エディタの状態。
返り値
isPostAutosavingLocked
投稿の自動保存がロックされているかどうかを返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
isPostLocked
投稿がロックされているかどうかを返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
isPostLockTakeover
投稿の編集が引き継がれたかどうかを返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
isPostSavingLocked
投稿の保存がロックされているかどうかを返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
isPreviewingPost
投稿がプレビュー中である場合は true を返し、それ以外は false を返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
isPublishingPost
投稿が公開中である場合は true を返し、それ以外は false を返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
isPublishSidebarEnabled
ユーザーが「公開」ボタンをクリックしたときに、公開前パネルを表示するかスキップするかを返します。
返り値
isPublishSidebarOpened
公開サイドバーが開いている場合は true を返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態
返り値
isSavingNonPostEntityChanges
非投稿エンティティが現在保存されている場合は true を返し、それ以外は false を返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
isSavingPost
投稿が現在保存中である場合は true を返し、それ以外は false を返します。
パラメータ
- state
Object
: グローバルアプリケーションの状態。
返り値
isSelectionEnabled
関連
isTyping
関連
isValidTemplate
関連
Actions
autosave
現在の投稿を自動保存するアクションです。これにはサーバー側の自動保存(デフォルト)とクライアント側(ローカルとも呼ばれる)の自動保存が含まれます(例:Web上では、投稿がセッションストレージにコミットされることがあります)。
パラメータ
clearSelectedBlock
関連
closePublishSidebar
ユーザーが公開サイドバーを閉じたことを示すアクションオブジェクトを返します。
戻り値
createUndoLevel
disablePublishSidebar
editPost
投稿の属性が編集されたことを通知するために使用されるアクションオブジェクトを返します。
使用法
// Update the post title
wp.data.dispatch( 'core/editor' ).editPost( { title: `${ newTitle }` } );
// Get specific media size based on the featured media ID
// Note: change sizes?.large for any registered size
const getFeaturedMediaUrl = useSelect( ( select ) => {
const getFeaturedMediaId =
select( 'core/editor' ).getEditedPostAttribute( 'featured_media' );
const getMedia = select( 'core' ).getMedia( getFeaturedMediaId );
return (
getMedia?.media_details?.sizes?.large?.source_url ||
getMedia?.source_url ||
''
);
}, [] );
パラメータ
- edits
Object
: 編集する投稿属性。 - options
Object
: 編集のオプション。
戻り値
enablePublishSidebar
enterFormattedText
関連
exitFormattedText
関連
hideInsertionPoint
関連
insertBlock
関連
insertBlocks
関連
insertDefaultBlock
関連
lockPostAutosaving
投稿の自動保存をロックするアクションです。
使用法
// Lock post autosaving with the lock key `mylock`:
wp.data.dispatch( 'core/editor' ).lockPostAutosaving( 'mylock' );
パラメータ
- lockName
string
: ロック名。
戻り値
lockPostSaving
投稿の保存をロックするアクションです。
使用法
const { subscribe } = wp.data;
const initialPostStatus = wp.data.select( 'core/editor' ).getEditedPostAttribute( 'status' );
// Only allow publishing posts that are set to a future date.
if ( 'publish' !== initialPostStatus ) {
// Track locking.
let locked = false;
// Watch for the publish event.
let unssubscribe = subscribe( () => {
const currentPostStatus = wp.data.select( 'core/editor' ).getEditedPostAttribute( 'status' );
if ( 'publish' !== currentPostStatus ) {
// Compare the post date to the current date, lock the post if the date isn't in the future.
const postDate = new Date( wp.data.select( 'core/editor' ).getEditedPostAttribute( 'date' ) );
const currentDate = new Date();
if ( postDate.getTime() <= currentDate.getTime() ) {
if ( ! locked ) {
locked = true;
wp.data.dispatch( 'core/editor' ).lockPostSaving( 'futurelock' );
}
} else {
if ( locked ) {
locked = false;
wp.data.dispatch( 'core/editor' ).unlockPostSaving( 'futurelock' );
}
}
}
} );
}
パラメータ
- lockName
string
: ロック名。
戻り値
mergeBlocks
関連
moveBlocksDown
関連
moveBlocksUp
関連
moveBlockToPosition
関連
multiSelect
関連
openPublishSidebar
ユーザーが公開サイドバーを開いたことを示すアクションオブジェクトを返します。
戻り値
receiveBlocks
関連
redo
アンドゥ履歴から最後のポップされた状態を復元するアクションです。
refreshPost
removeBlock
関連
removeBlocks
関連
removeEditorPanel
エディターからパネルを削除するために使用されるアクションオブジェクトを返します。
パラメータ
- panelName
string
: 削除するパネルを識別する文字列。
戻り値
replaceBlock
関連
replaceBlocks
関連
resetBlocks
関連
resetEditorBlocks
ブロックが更新されたことを通知するために使用されるアクションオブジェクトを返します。
パラメータ
resetPost
非推奨 WordPress 6.0 以降。
最新の投稿のバージョンが初期化または保存によって受信されたことを通知するために使用されるアクションオブジェクトを返します。
savePost
エディタ内で現在の投稿を保存するためのアクションです。
パラメータ
selectBlock
関連
setDeviceType
編集キャンバスの幅を変更するアクションです。
パラメータ
- deviceType
string
:
戻り値
setEditedPost
現在の投稿タイプと投稿IDを設定するアクションを返します。
パラメータ
- postType
string
: 投稿タイプ。 - postId
string
: 投稿ID。
戻り値
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
: インサータで初期化するカテゴリ。
戻り値
setIsListViewOpened
リストビューを開く/閉じるために使用されるアクションオブジェクトを返します。
パラメータ
- isOpen
boolean
: リストビューを開くべきか閉じるべきかを示すブール値。
戻り値
setRenderingMode
投稿エディタのレンダリングモードを設定するために使用されるアクションを返します。複数のレンダリングモードをサポートしています:
post-only
: このモードは、テンプレートから投稿ブロックを抽出し、それだけをレンダリングします。ユーザーがラッピングテンプレートなしで投稿/ページを孤立して編集できるようにすることが目的です。template-locked
: このモードは、テンプレートと投稿ブロックの両方をレンダリングしますが、テンプレートブロックはロックされており、編集できません。投稿ブロックは編集可能です。
パラメータ
setTemplateValidity
関連
setupEditor
指定された投稿オブジェクトとエディタ設定でエディタが初期化されたことを通知するために使用されるアクションジェネレータを返します。
パラメータ
setupEditorState
非推奨
エディタの状態を設定します。
パラメータ
showInsertionPoint
関連
startMultiSelect
関連
startTyping
関連
stopMultiSelect
関連
stopTyping
関連
switchEditorMode
エディターモードを切り替えるために使用されるアクションをトリガーします。
パラメータ
synchronizeTemplate
関連
toggleBlockMode
関連
toggleDistractionFree
気を散らさないモードを切り替えるアクション。気を散らさないモードでは、サイドバーがないことが期待されます。z-indexの値が設定されているため、サイドバーを閉じることができません。
toggleEditorPanelEnabled
エディター内のパネルを有効または無効にするために使用されるアクションオブジェクトを返します。
パラメータ
- panelName
string
: 有効または無効にするパネルを識別する文字列。
戻り値
toggleEditorPanelOpened
閉じたパネルを開き、開いているパネルを閉じます。
パラメータ
togglePublishSidebar
ユーザーが公開サイドバーを切り替えたことを示すアクションオブジェクトを返します。
戻り値
toggleSelection
関連
trashPost
エディタ内で現在の投稿をゴミ箱に移動するためのアクションです。
undo
アンドゥ履歴からレコードをポップし、編集を元に戻すアクションです。
unlockPostAutosaving
投稿の自動保存を解除するアクションです。
使用法
// Unlock post saving with the lock key `mylock`:
wp.data.dispatch( 'core/editor' ).unlockPostAutosaving( 'mylock' );
パラメータ
- lockName
string
: ロック名。
戻り値
unlockPostSaving
投稿の保存を解除するアクションです。
使用法
// Unlock post saving with the lock key `mylock`:
wp.data.dispatch( 'core/editor' ).unlockPostSaving( 'mylock' );
パラメータ
- lockName
string
: ロック名。
戻り値
updateBlock
関連
updateBlockAttributes
関連
updateBlockListSettings
関連
updateEditorSettings
updatePost
非推奨 Gutenberg 9.7.0 以降。
最新の投稿のバージョンに対する更新パッチが受信されたことを通知するために使用されるアクションオブジェクトを返します。
戻り値
updatePostLock
エディタをロックするアクションです。
パラメータ
- lock
Object
: 投稿ロック状態、ユーザー、および nonce に関する詳細。
戻り値
Object
: アクションオブジェクト。