Namespace: core.
Returns whether the current user can perform the given action on the given REST resource.
Calling this may trigger an OPTIONS request to the REST API via the
canUser() resolver.
https://developer.wordpress.org/rest-api/reference/
Parameters
- state
State: Data state. - action
string: Action to check. One of: 'create', 'read', 'update', 'delete'. - resource
string: REST resource to check, e.g. 'media' or 'posts'. - id
EntityRecordKey: Optional ID of the rest resource to check.
Returns
boolean | undefined: Whether or not the user can perform the action, orundefinedif the OPTIONS request is still being made.
Returns whether the current user can edit the given entity.
Calling this may trigger an OPTIONS request to the REST API via the
canUser() resolver.
https://developer.wordpress.org/rest-api/reference/
Parameters
- state
State: Data state. - kind
string: Entity kind. - name
string: Entity name. - recordId
EntityRecordKey: Record's id.
Returns
boolean | undefined: Whether or not the user can edit, orundefinedif the OPTIONS request is still being made.
Deprecated since 11.3. Callers should use
select( 'core' ).getUsers({ who: 'authors' })instead.
Returns all available authors.
Parameters
- state
State: Data state. - query
GetRecordsHttpQuery: Optional object of query parameters to include with request.
Returns
ET.User[]: Authors list.
Returns the autosave for the post and author.
Parameters
- state
State: State tree. - postType
string: The type of the parent post. - postId
EntityRecordKey: The id of the parent post. - authorId
EntityRecordKey: The id of the author.
Returns
EntityRecord | undefined: The autosave for the post and author.
Returns the latest autosaves for the post.
May return multiple autosaves since the backend stores one autosave per author for each post.
Parameters
- state
State: State tree. - postType
string: The type of the parent post. - postId
EntityRecordKey: The id of the parent post.
Returns
Array< any > | undefined: An array of autosaves for the post, or undefined if there is none.
Retrieve the list of registered block pattern categories.
Parameters
- state
State: Data state.
Returns
Array< any >: Block pattern category list.
Retrieve the list of registered block patterns.
Parameters
- state
State: Data state.
Returns
Array< any >: Block pattern list.
Return the current theme.
Parameters
- state
State: Data state.
Returns
any: The current theme.
Returns the current user.
Parameters
- state
State: Data state.
Returns
undefined< 'edit' >: Current user object.
Returns the specified entity record, merged with its edits.
Parameters
- state
State: State tree. - kind
string: Entity kind. - name
string: Entity name. - recordId
EntityRecordKey: Record ID.
Returns
undefined< EntityRecord > | undefined: The entity record, merged with its edits.
Returns the embed preview for the given URL.
Parameters
- state
State: Data state. - url
string: Embedded URL.
Returns
any: Undefined if the preview has not been fetched, otherwise, the preview fetched from the embed preview API.
Deprecated since WordPress 6.0. Use getEntitiesConfig instead
Returns the loaded entities for the given kind.
Parameters
- state
State: Data state. - kind
string: Entity kind.
Returns
Array< any >: Array of entities with config matching kind.
Returns the loaded entities for the given kind.
Parameters
- state
State: Data state. - kind
string: Entity kind.
Returns
Array< any >: Array of entities with config matching kind.
Deprecated since WordPress 6.0. Use getEntityConfig instead
Returns the entity config given its kind and name.
Parameters
- state
State: Data state. - kind
string: Entity kind. - name
string: Entity name.
Returns
any: Entity config
Returns the entity config given its kind and name.
Parameters
- state
State: Data state. - kind
string: Entity kind. - name
string: Entity name.
Returns
any: Entity config
Returns the Entity's record object by key. Returns null if the value is not
yet received, undefined if the value entity is known to not exist, or the
entity object if it exists and is received.
Parameters
- state
State: State tree - kind
string: Entity kind. - name
string: Entity name. - key
EntityRecordKey: Record's key - query
GetRecordsHttpQuery: Optional query. If requesting specific fields, fields must always include the ID.
Returns
EntityRecord | undefined: Record.
Returns the specified entity record's edits.
Parameters
- state
State: State tree. - kind
string: Entity kind. - name
string: Entity name. - recordId
EntityRecordKey: Record ID.
Returns
Optional< any >: The entity record's edits.
Returns the specified entity record's non transient edits.
Transient edits don't create an undo level, and are not considered for change detection. They are defined in the entity's config.
Parameters
- state
State: State tree. - kind
string: Entity kind. - name
string: Entity name. - recordId
EntityRecordKey: Record ID.
Returns
Optional< any >: The entity record's non transient edits.
Returns the Entity's records.
Parameters
- state
State: State tree - kind
string: Entity kind. - name
string: Entity name. - query
GetRecordsHttpQuery: Optional terms query. If requesting specific fields, fields must always include the ID.
Returns
EntityRecord[] | null: Records.
Returns the specified entity record's last delete error.
Parameters
- state
State: State tree. - kind
string: Entity kind. - name
string: Entity name. - recordId
EntityRecordKey: Record ID.
Returns
any: The entity record's save error.
Returns the specified entity record's last save error.
Parameters
- state
State: State tree. - kind
string: Entity kind. - name
string: Entity name. - recordId
EntityRecordKey: Record ID.
Returns
any: The entity record's save error.
Returns the entity's record object by key, with its attributes mapped to their raw values.
Parameters
- state
State: State tree. - kind
string: Entity kind. - name
string: Entity name. - key
EntityRecordKey: Record's key.
Returns
EntityRecord | undefined: Object with the entity's raw attributes.
Returns the next edit from the current undo offset for the entity records edits history, if any.
Parameters
- state
State: State tree.
Returns
Optional< any >: The edit.
Returns a new reference when edited values have changed. This is useful in inferring where an edit has been made between states by comparison of the return values using strict equality.
Usage
const hasEditOccurred = (
getReferenceByDistinctEdits( beforeState ) !==
getReferenceByDistinctEdits( afterState )
);
Parameters
- state
State: Editor state.
Returns
- A value whose reference will change only when an edit occurs.
Return theme supports data in the index.
Parameters
- state
State: Data state.
Returns
any: Index data.
Returns the previous edit from the current undo offset for the entity records edits history, if any.
Parameters
- state
State: State tree.
Returns
Optional< any >: The edit.
Returns all the users returned by a query ID.
Parameters
- state
State: Data state. - queryID
string: Query ID.
Returns
undefined< 'edit' >[]: Users list.
Returns true if the specified entity record has edits, and false otherwise.
Parameters
- state
State: State tree. - kind
string: Entity kind. - name
string: Entity name. - recordId
EntityRecordKey: Record ID.
Returns
boolean: Whether the entity record has edits or not.
Returns true if records have been received for the given set of parameters, or false otherwise.
Parameters
- state
State: State tree - kind
string: Entity kind. - name
string: Entity name. - query
GetRecordsHttpQuery: Optional terms query.
Returns
boolean: Whether entity records have been received.
Returns true if the REST request for autosaves has completed.
Parameters
- state
State: State tree. - postType
string: The type of the parent post. - postId
EntityRecordKey: The id of the parent post.
Returns
boolean: True if the REST request was completed. False otherwise.
Returns true if there is a next edit from the current undo offset for the entity records edits history, and false otherwise.
Parameters
- state
State: State tree.
Returns
boolean: Whether there is a next edit or not.
Returns true if there is a previous edit from the current undo offset for the entity records edits history, and false otherwise.
Parameters
- state
State: State tree.
Returns
boolean: Whether there is a previous edit or not.
Returns true if the specified entity record is autosaving, and false otherwise.
Parameters
- state
State: State tree. - kind
string: Entity kind. - name
string: Entity name. - recordId
EntityRecordKey: Record ID.
Returns
boolean: Whether the entity record is autosaving or not.
Returns true if the specified entity record is deleting, and false otherwise.
Parameters
- state
State: State tree. - kind
string: Entity kind. - name
string: Entity name. - recordId
EntityRecordKey: Record ID.
Returns
boolean: Whether the entity record is deleting or not.
Determines if the returned preview is an oEmbed link fallback.
WordPress can be configured to return a simple link to a URL if it is not embeddable. We need to be able to determine if a URL is embeddable or not, based on what we get back from the oEmbed preview API.
Parameters
- state
State: Data state. - url
string: Embedded URL.
Returns
boolean: Is the preview for the URL an oEmbed link fallback.
Returns true if a request is in progress for embed preview data, or false otherwise.
Parameters
- state
State: Data state. - url
string: URL the preview would be for.
Returns
boolean: Whether a request is in progress for an embed preview.
Returns true if the specified entity record is saving, and false otherwise.
Parameters
- state
State: State tree. - kind
string: Entity kind. - name
string: Entity name. - recordId
EntityRecordKey: Record ID.
Returns
boolean: Whether the entity record is saving or not.
Returns an action object used in adding new entities.
Parameters
- entities
Array: Entities received.
Returns
Object: Action object.
Action triggered to delete an entity record.
Parameters
- kind
string: Kind of the deleted entity. - name
string: Name of the deleted entity. - recordId
string: Record ID of the deleted entity. - query
?Object: Special query parameters for the DELETE API call. - options
[Object]: Delete options. - options.__unstableFetch
[Function]: Internal use only. Function to call instead ofapiFetch(). Must return a promise. - options.throwOnError
[boolean]: If false, this action suppresses all the exceptions. Defaults to false.
Returns an action object that triggers an edit to an entity record.
Parameters
- kind
string: Kind of the edited entity record. - name
string: Name of the edited entity record. - recordId
number|string: Record ID of the edited entity record. - edits
Object: The edits. - options
Object: Options for the edit. - options.undoIgnore
[boolean]: Whether to ignore the edit in undo history or not.
Returns
Object: Action object.
Returns an action object used in signalling that entity records have been received.
Parameters
- kind
string: Kind of the received entity record. - name
string: Name of the received entity record. - records
Array|Object: Records received. - query
?Object: Query Object. - invalidateCache
?boolean: Should invalidate query caches. - edits
?Object: Edits to reset.
Returns
Object: Action object.
Deprecated since WP 5.9, this is not useful anymore, use the selector direclty.
Returns an action object used in signalling that the index has been received.
Returns
Object: Action object.
Deprecated since WP 5.9, use receiveUserPermission instead.
Returns an action object used in signalling that Upload permissions have been received.
Parameters
- hasUploadPermissions
boolean: Does the user have permission to upload files?
Returns
Object: Action object.
Action triggered to redo the last undoed edit to an entity record, if any.
Action triggered to save an entity record's edits.
Parameters
- kind
string: Kind of the entity. - name
string: Name of the entity. - recordId
Object: ID of the record. - options
Object: Saving options.
Action triggered to save an entity record.
Parameters
- kind
string: Kind of the received entity. - name
string: Name of the received entity. - record
Object: Record to be saved. - options
Object: Saving options. - options.isAutosave
[boolean]: Whether this is an autosave. - options.__unstableFetch
[Function]: Internal use only. Function to call instead ofapiFetch(). Must return a promise. - options.throwOnError
[boolean]: If false, this action suppresses all the exceptions. Defaults to false.
Action triggered to undo the last edit to an entity record, if any.