WordPressコアデータ（WordPress Core Data）

動的に生成されたセレクタ

ユーザーフレンドリーなセレクタがいくつかあり、これらはより一般的な getEntityRecord と getEntityRecords のラッパーであり、さまざまなエンティティの情報を取得するために使用できます。

getPostType

指定された投稿タイプの情報を返します。

使用法

import { useSelect } from '@wordpress/data';
import { store as coreDataStore } from '@wordpress/core-data';
const postType = useSelect(
   ( select ) => select( coreDataStore ).getPostType( 'post' )
   // Equivalent to: select( coreDataStore ).getEntityRecord( 'root', 'postType', 'post' )
);

パラメータ

• postType string

返すもの

• EntityRecord | undefined: レコード。
  

getPostTypes

投稿タイプの情報を返します。

使用法

import { useSelect } from '@wordpress/data';
import { store as coreDataStore } from '@wordpress/core-data';
const postTypes = useSelect( ( select ) => {
   return select( coreDataStore ).getPostTypes( { per_page: 4 } );
   // Equivalent to:
   // select( coreDataStore ).getEntityRecords( 'root', 'postType', { per_page: 4 } );
} );

パラメータ

• query GetRecordsHttpQuery: オプションの用語クエリ。特定のフィールドを要求する場合、フィールドには常にIDを含める必要があります。有効なクエリパラメータについては、リファレンスを参照し、エンティティの種類を選択してください。その後、「リスト [エンティティの種類]」の利用可能な引数を確認してください。

返すもの

• EntityRecord[] | null: レコード。
  

getTaxonomy

指定された分類法の情報を返します。

使用法

import { useSelect } from '@wordpress/data';
import { store as coreDataStore } from '@wordpress/core-data';
const taxonomy = useSelect( ( select ) => {
   return select( coreDataStore ).getTaxonomy( 'category' );
   // Equivalent to:
   // select( coreDataStore ).getEntityRecord( 'root', 'taxonomy', 'category' );
} );

パラメータ

• taxonomy string

返すもの

• EntityRecord | undefined: レコード。
  

getTaxonomies

分類法の情報を返します。

使用法

import { useSelect } from '@wordpress/data';
import { store as coreDataStore } from '@wordpress/core-data';
const taxonomies = useSelect( ( select ) => {
   return select( coreDataStore ).getTaxonomies( { type: 'post' } );
   // Equivalent to:
   // select( coreDataStore ).getEntityRecords( 'root', 'taxonomy', { type: 'post' } );
} );

パラメータ

• query GetRecordsHttpQuery: オプションの用語クエリ。特定のフィールドを要求する場合、フィールドには常にIDを含める必要があります。有効なクエリパラメータについては、リファレンスを参照し、エンティティの種類を選択してください。その後、「リスト [エンティティの種類]」の利用可能な引数を確認してください。

返すもの

• EntityRecord[] | null: レコード。
  

その他のセレクタ

canUser

現在のユーザーが指定されたRESTリソースに対して指定されたアクションを実行できるかどうかを返します。

これを呼び出すと、canUser()リゾルバを介してREST APIへのOPTIONSリクエストがトリガーされる場合があります。

https://developer.wordpress.org/rest-api/reference/

パラメータ

• state State: データ状態。
• action string: チェックするアクション。‘create’, ‘read’, ‘update’, ‘delete’のいずれか。
• resource string | EntityResource: チェックするエンティティリソース。エンティティオブジェクト { kind: 'root', name: 'media', id: 1 } または文字列としてのRESTベース – media を受け入れます。
• id EntityRecordKey: チェックするRESTリソースのオプションID。

返すもの

• boolean | undefined: ユーザーがアクションを実行できるかどうか、またはOPTIONSリクエストがまだ行われている場合はundefined。
  

canUserEditEntityRecord

現在のユーザーが指定されたエンティティを編集できるかどうかを返します。

これを呼び出すと、canUser()リゾルバを介してREST APIへのOPTIONSリクエストがトリガーされる場合があります。

https://developer.wordpress.org/rest-api/reference/

パラメータ

• state State: データ状態。
• kind string: エンティティの種類。
• name string: エンティティ名。
• recordId EntityRecordKey: レコードのID。

返すもの

• boolean | undefined: ユーザーが編集できるかどうか、またはOPTIONSリクエストがまだ行われている場合はundefined。
  

getAuthors

非推奨 11.3以降。呼び出し元はselect( 'core' ).getUsers({ who: 'authors' })を代わりに使用する必要があります。
すべての利用可能な著者を返します。

パラメータ

• state State: データ状態。
• query GetRecordsHttpQuery: リクエストに含めるオプションのクエリパラメータのオブジェクト。 有効なクエリパラメータについては、ユーザーページを参照し、ユーザーのリストおよびユーザーを取得の引数を確認してください。

返すもの

• ET.User[]: 著者リスト。
  

getAutosave

投稿と著者の自動保存を返します。

パラメータ

• state State: 状態ツリー。
• postType string: 親投稿のタイプ。
• postId EntityRecordKey: 親投稿のID。
• authorId EntityRecordKey: 著者のID。

返すもの

• EntityRecord | undefined: 投稿と著者の自動保存。
  

getAutosaves

投稿の最新の自動保存を返します。

バックエンドは、各投稿の著者ごとに1つの自動保存を保存するため、複数の自動保存を返す場合があります。

パラメータ

• state State: 状態ツリー。
• postType string: 親投稿のタイプ。
• postId EntityRecordKey: 親投稿のID。

返すもの

• Array< any > | undefined: 投稿の自動保存の配列、または存在しない場合は未定義。
  

getBlockPatternCategories

登録されたブロックパターンカテゴリのリストを取得します。

パラメータ

• state State: データ状態。

返すもの

• Array< any >: ブロックパターンカテゴリのリスト。
  

getBlockPatterns

登録されたブロックパターンのリストを取得します。

パラメータ

• state State: データ状態。

返すもの

• Array< any >: ブロックパターンのリスト。
  

getCurrentTheme

現在のテーマを返します。

パラメータ

• state State: データ状態。

返すもの

• any: 現在のテーマ。
  

getCurrentThemeGlobalStylesRevisions

非推奨 WordPress 6.5.0以降。呼び出し元はselect( 'core' ).getRevisions( 'root', 'globalStyles', ${ recordKey } )を代わりに使用する必要があります。recordKeyはグローバルスタイルの親投稿のIDです。
現在のグローバルスタイルテーマのリビジョンを返します。

パラメータ

• state State: データ状態。

返すもの

• Array< object > | null: 現在のグローバルスタイル。
  

getCurrentUser

現在のユーザーを返します。

パラメータ

• state State: データ状態。

返すもの

• ET.User< 'edit' >: 現在のユーザーオブジェクト。
  

getDefaultTemplateId

指定されたクエリをレンダリングするために使用されるデフォルトテンプレートを返します。

パラメータ

• state State: データ状態。
• query TemplateQuery: クエリ。

返すもの

• string: 指定されたクエリのデフォルトテンプレートID。
  

getEditedEntityRecord

指定されたエンティティレコードを返し、その編集とマージします。

パラメータ

• state State: 状態ツリー。
• kind string: エンティティの種類。
• name string: エンティティ名。
• recordId EntityRecordKey: レコードID。

返すもの

• ET.Updatable< EntityRecord > | false: 編集とマージされたエンティティレコード。
  

getEmbedPreview

指定されたURLの埋め込みプレビューを返します。

パラメータ

• state State: データ状態。
• url string: 埋め込まれたURL。

返すもの

• any: プレビューが取得されていない場合は未定義、そうでなければ埋め込みプレビュAPIから取得されたプレビュー。
  

getEntitiesByKind

非推奨 WordPress 6.0以降。代わりにgetEntitiesConfigを使用してください。
指定された種類のロードされたエンティティを返します。

パラメータ

• state State: データ状態。
• kind string: エンティティの種類。

返すもの

• Array< any >: 種類に一致する構成を持つエンティティの配列。
  

getEntitiesConfig

指定された種類のロードされたエンティティを返します。

パラメータ

• state State: データ状態。
• kind string: エンティティの種類。

返すもの

• Array< any >: 種類に一致する構成を持つエンティティの配列。
  

getEntity

非推奨 WordPress 6.0以降。代わりにgetEntityConfigを使用してください。
その種類と名前に基づいてエンティティの構成を返します。

パラメータ

• state State: データ状態。
• kind string: エンティティの種類。
• name string: エンティティ名。

返すもの

• any: エンティティの構成
  

getEntityConfig

その種類と名前に基づいてエンティティの構成を返します。

パラメータ

• state State: データ状態。
• kind string: エンティティの種類。
• name string: エンティティ名。

返すもの

• any: エンティティの構成
  

getEntityRecord

キーによってエンティティのレコードオブジェクトを返します。値がまだ受信されていない場合はnullを返し、値のエンティティが存在しないことが知られている場合は未定義、存在し受信された場合はエンティティオブジェクトを返します。

パラメータ

• state State: 状態ツリー
• kind string: エンティティの種類。
• name string: エンティティ名。
• key EntityRecordKey: レコードのキー
• query GetRecordsHttpQuery: オプションのクエリ。特定のフィールドを要求する場合、フィールドには常にIDを含める必要があります。有効なクエリパラメータについては、リファレンスを参照し、エンティティの種類を選択してください。その後、「[エンティティの種類]を取得」の利用可能な引数を確認してください。

返すもの

• EntityRecord | undefined: レコード。
  

getEntityRecordEdits

指定されたエンティティレコードの編集を返します。

パラメータ

• state State: 状態ツリー。
• kind string: エンティティの種類。
• name string: エンティティ名。
• recordId EntityRecordKey: レコードID。

返すもの

• Optional< any >: エンティティレコードの編集。
  

getEntityRecordNonTransientEdits

指定されたエンティティレコードの非一時的な編集を返します。

一時的な編集は元に戻すレベルを作成せず、変更検出には考慮されません。これらはエンティティの構成で定義されています。

パラメータ

• state State: 状態ツリー。
• kind string: エンティティの種類。
• name string: エンティティ名。
• recordId EntityRecordKey: レコードID。

返すもの

• Optional< any >: エンティティレコードの非一時的な編集。
  

getEntityRecords

エンティティのレコードを返します。

パラメータ

• state State: 状態ツリー
• kind string: エンティティの種類。
• name string: エンティティ名。
• query GetRecordsHttpQuery: オプションの用語クエリ。特定のフィールドを要求する場合、フィールドには常にIDを含める必要があります。有効なクエリパラメータについては、リファレンスを参照し、エンティティの種類を選択してください。その後、「リスト [エンティティの種類]」の利用可能な引数を確認してください。

返すもの

• EntityRecord[] | null: レコード。
  

getEntityRecordsTotalItems

指定されたクエリに対するエンティティの利用可能なレコードの合計を返します（ページネーションを無視します）。

パラメータ

• state State: 状態ツリー
• kind string: エンティティの種類。
• name string: エンティティ名。
• query GetRecordsHttpQuery: オプションの用語クエリ。特定のフィールドを要求する場合、フィールドには常にIDを含める必要があります。有効なクエリパラメータについては、リファレンスを参照し、エンティティの種類を選択してください。その後、「リスト [エンティティの種類]」の利用可能な引数を確認してください。

返すもの

• number | null: 数値 | null。
  

getEntityRecordsTotalPages

指定されたクエリに対する利用可能なページの数を返します。

パラメータ

• state State: 状態ツリー
• kind string: エンティティの種類。
• name string: エンティティ名。
• query GetRecordsHttpQuery: オプションの用語クエリ。特定のフィールドを要求する場合、フィールドには常にIDを含める必要があります。有効なクエリパラメータについては、リファレンスを参照し、エンティティの種類を選択してください。その後、「リスト [エンティティの種類]」の利用可能な引数を確認してください。

返すもの

• number | null: 数値 | null。
  

getLastEntityDeleteError

指定されたエンティティレコードの最後の削除エラーを返します。

パラメータ

• state State: 状態ツリー。
• kind string: エンティティの種類。
• name string: エンティティ名。
• recordId EntityRecordKey: レコードID。

返すもの

• any: エンティティレコードの保存エラー。
  

getLastEntitySaveError

指定されたエンティティレコードの最後の保存エラーを返します。

パラメータ

• state State: 状態ツリー。
• kind string: エンティティの種類。
• name string: エンティティ名。
• recordId EntityRecordKey: レコードID。

返すもの

• any: エンティティレコードの保存エラー。
  

getRawEntityRecord

キーによってエンティティのレコードオブジェクトを返し、その属性を生の値にマッピングします。

パラメータ

• state State: 状態ツリー。
• kind string: エンティティの種類。
• name string: エンティティ名。
• key EntityRecordKey: レコードのキー。

返すもの

• EntityRecord | undefined: エンティティの生の属性を持つオブジェクト。
  

getRedoEdit

非推奨 6.3以降
エンティティレコードの編集履歴から現在の元に戻すオフセットの次の編集を返します。

パラメータ

• state State: 状態ツリー。

返すもの

• Optional< any >: 編集。
  

getReferenceByDistinctEdits

編集された値が変更されたときに新しい参照を返します。これは、戻り値の厳密な等価性を使用して状態間で編集が行われた場所を推測するのに役立ちます。

使用法

const hasEditOccurred = (
   getReferenceByDistinctEdits( beforeState ) !==
   getReferenceByDistinctEdits( afterState )
);

パラメータ

• state エディタの状態。

返すもの

• 編集が発生したときのみ参照が変更される値。
  

getRevision

親エンティティの特定のリビジョンを返します。

パラメータ

• state State: 状態ツリー
• kind string: エンティティの種類。
• name string: エンティティ名。
• recordKey EntityRecordKey: 取得したいリビジョンのエンティティレコードのキー。
• revisionKey EntityRecordKey: リビジョンのキー。
• query GetRecordsHttpQuery: オプションのクエリ。特定のフィールドを要求する場合、フィールドには常にIDを含める必要があります。有効なクエリパラメータについては、リビジョンスキーマをREST APIハンドブックで確認してください。その後、「[エンティティの種類]を取得」の利用可能な引数を確認してください。

返すもの

• RevisionRecord | Record< PropertyKey, never > | undefined: レコード。
  

getRevisions

エンティティのリビジョンを返します。

パラメータ

• state State: 状態ツリー
• kind string: エンティティの種類。
• name string: エンティティ名。
• recordKey EntityRecordKey: 取得したいリビジョンのエンティティレコードのキー。
• query GetRecordsHttpQuery: オプションのクエリ。特定のフィールドを要求する場合、フィールドには常にIDを含める必要があります。有効なクエリパラメータについては、リビジョンスキーマをREST APIハンドブックで確認してください。その後、「[エンティティの種類]を取得」の利用可能な引数を確認してください。

返すもの

• RevisionRecord[] | null: レコード。
  

getThemeSupports

インデックス内のテーマサポートデータを返します。

パラメータ

• state State: データ状態。

返すもの

• any: インデックスデータ。
  

getUndoEdit

非推奨 6.3以降
エンティティレコードの編集履歴から現在の元に戻すオフセットの前の編集を返します。

パラメータ

• state State: 状態ツリー。

返すもの

• Optional< any >: 編集。
  

getUserPatternCategories

登録されたユーザーパターンカテゴリを取得します。

パラメータ

• state State: データ状態。

返すもの

• Array< UserPatternCategory >: ユーザーパターンカテゴリの配列。
  

getUserQueryResults

クエリIDによって返されたすべてのユーザーを返します。

パラメータ

• state State: データ状態。
• queryID string: クエリID。

返すもの

• ET.User< 'edit' >[]: ユーザーリスト。
  

hasEditsForEntityRecord

指定されたエンティティレコードに編集がある場合はtrueを返し、そうでない場合はfalseを返します。

パラメータ

• state State: 状態ツリー。
• kind string: エンティティの種類。
• name string: エンティティ名。
• recordId EntityRecordKey: レコードID。

返すもの

• boolean: エンティティレコードに編集があるかどうか。
  

hasEntityRecords

指定されたパラメータのセットに対してレコードが受信された場合はtrueを返し、そうでない場合はfalseを返します。

パラメータ

• state State: 状態ツリー
• kind string: エンティティの種類。
• name string: エンティティ名。
• query GetRecordsHttpQuery: オプションの用語クエリ。有効なクエリパラメータについては、リファレンスを参照し、エンティティの種類を選択してください。その後、「リスト [エンティティの種類]」の利用可能な引数を確認してください。

返すもの

• boolean: エンティティレコードが受信されたかどうか。
  

hasFetchedAutosaves

自動保存のRESTリクエストが完了した場合はtrueを返します。

パラメータ

• state State: 状態ツリー。
• postType string: 親投稿のタイプ。
• postId EntityRecordKey: 親投稿のID。

返すもの

• boolean: RESTリクエストが完了した場合はtrue。そうでない場合はfalse。
  

hasRedo

現在の元に戻すオフセットからエンティティレコードの編集履歴に次の編集がある場合はtrueを返し、そうでない場合はfalseを返します。

パラメータ

• state State: 状態ツリー。

返すもの

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

hasUndo

現在の元に戻すオフセットからエンティティレコードの編集履歴に前の編集がある場合はtrueを返し、そうでない場合はfalseを返します。

パラメータ

• state State: 状態ツリー。

返すもの

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

isAutosavingEntityRecord

指定されたエンティティレコードが自動保存中である場合はtrueを返し、そうでない場合はfalseを返します。

パラメータ

• state State: 状態ツリー。
• kind string: エンティティの種類。
• name string: エンティティ名。
• recordId EntityRecordKey: レコードID。

返すもの

• boolean: エンティティレコードが自動保存中かどうか。
  

isDeletingEntityRecord

指定されたエンティティレコードが削除中である場合はtrueを返し、そうでない場合はfalseを返します。

パラメータ

• state State: 状態ツリー。
• kind string: エンティティの種類。
• name string: エンティティ名。
• recordId EntityRecordKey: レコードID。

返すもの

• boolean: エンティティレコードが削除中かどうか。
  

isPreviewEmbedFallback

返されたプレビューがoEmbedリンクのフォールバックであるかどうかを判断します。

WordPressは、埋め込み可能でない場合にURLへのシンプルなリンクを返すように構成できます。oEmbedプレビュAPIから返される内容に基づいて、URLが埋め込み可能かどうかを判断できる必要があります。

パラメータ

• state State: データ状態。
• url string: 埋め込まれたURL。

返すもの

• boolean: URLのプレビューがoEmbedリンクのフォールバックであるかどうか。
  

isRequestingEmbedPreview

埋め込みプレビューデータのリクエストが進行中である場合はtrueを返し、そうでない場合はfalseを返します。

パラメータ

• state State: データ状態。
• url string: プレビューが対象となるURL。

返すもの

• boolean: 埋め込みプレビューのリクエストが進行中かどうか。
  

isSavingEntityRecord

指定されたエンティティレコードが保存中である場合はtrueを返し、そうでない場合はfalseを返します。

パラメータ

• state State: 状態ツリー。
• kind string: エンティティの種類。
• name string: エンティティ名。
• recordId EntityRecordKey: レコードID。

返すもの

• boolean: エンティティレコードが保存中かどうか。

アクション

addEntities

新しいエンティティを追加するために使用されるアクションオブジェクトを返します。

パラメータ

• entities Array: 受信したエンティティ。

返すもの

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

deleteEntityRecord

エンティティレコードを削除するためにトリガーされるアクション。

パラメータ

• kind string: 削除されたエンティティの種類。
• name string: 削除されたエンティティの名前。
• recordId number|string: 削除されたエンティティのレコードID。
• query ?Object: DELETE API呼び出しの特別なクエリパラメータ。
• options [Object]: 削除オプション。
• options.__unstableFetch [Function]: 内部使用のみ。apiFetch()の代わりに呼び出す関数。プロミスを返す必要があります。
• options.throwOnError [boolean]: falseの場合、このアクションはすべての例外を抑制します。デフォルトはfalseです。
  

editEntityRecord

エンティティレコードの編集をトリガーするアクションオブジェクトを返します。

パラメータ

• kind string: 編集されたエンティティレコードの種類。
• name string: 編集されたエンティティレコードの名前。
• recordId number|string: 編集されたエンティティレコードのレコードID。
• edits Object: 編集内容。
• options Object: 編集のオプション。
• options.undoIgnore [boolean]: 元に戻し履歴で編集を無視するかどうか。

返すもの

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

receiveDefaultTemplateId

指定されたクエリのテンプレートを設定するために使用されるアクションオブジェクトを返します。

パラメータ

• query Object: ルックアップクエリ。
• templateId string: 解決されたテンプレートID。

返すもの

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

receiveEntityRecords

エンティティレコードが受信されたことを示すために使用されるアクションオブジェクトを返します。

パラメータ

• kind string: 受信したエンティティレコードの種類。
• name string: 受信したエンティティレコードの名前。
• records Array|Object: 受信したレコード。
• query ?Object: クエリオブジェクト。
• invalidateCache ?boolean: クエリキャッシュを無効にする必要がありますか。
• edits ?Object: リセットする編集。
• meta ?Object: ページネーションに関するメタ情報。

返すもの

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

receiveNavigationFallbackId

フォールバックナビゲーションメニューIDが受信されたことを示すアクションオブジェクトを返します。

パラメータ

• fallbackId integer: フォールバックナビゲーションメニューのID

返すもの

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

receiveRevisions

リビジョンアイテムを受信するためにトリガーされるアクション。

パラメータ

• kind string: 受信したエンティティレコードのリビジョンの種類。
• name string: 受信したエンティティレコードのリビジョンの名前。
• recordKey number|string: 取得したいリビジョンのエンティティレコードのキー。
• records Array|Object: 受信したリビジョン。
• query ?Object: クエリオブジェクト。
• invalidateCache ?boolean: クエリキャッシュを無効にする必要がありますか。
• meta ?Object: ページネーションに関するメタ情報。
  

receiveThemeSupports

非推奨 WP 5.9以降、これはもはや役に立たないため、セレクタを直接使用してください。
インデックスが受信されたことを示すために使用されるアクションオブジェクトを返します。

返すもの

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

receiveUploadPermissions

非推奨 WP 5.9以降、代わりにreceiveUserPermissionを使用してください。
アップロード権限が受信されたことを示すアクションオブジェクトを返します。

パラメータ

• hasUploadPermissions boolean: ユーザーはファイルをアップロードする権限がありますか？

返り値

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

redo

エンティティレコードに対する最後の元に戻した編集をやり直すためにトリガーされるアクション。

saveEditedEntityRecord

エンティティレコードの編集を保存するためにトリガーされるアクション。

パラメータ

• kind string: エンティティの種類。
• name string: エンティティの名前。
• recordId Object: レコードのID。
• options Object=: 保存オプション。
  

saveEntityRecord

エンティティレコードを保存するためにトリガーされるアクション。

パラメータ

• kind string: 受信したエンティティの種類。
• name string: 受信したエンティティの名前。
• record Object: 保存するレコード。
• options Object: 保存オプション。
• options.isAutosave [boolean]: これはオートセーブですか。
• options.__unstableFetch [Function]: 内部使用のみ。apiFetch()の代わりに呼び出す関数。Promiseを返す必要があります。
• options.throwOnError [boolean]: falseの場合、このアクションはすべての例外を抑制します。デフォルトはfalseです。
  

元に戻す

エンティティレコードに対する最後の編集を元に戻すためにトリガーされるアクション。