| [ Index ] |
PHP Cross Reference of WordPress Trunk (Updated Daily) |
[Source view] [Print] [Project Stats]
(no description)
| File Size: | 8401 lines (267 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
ObservableSet:: (57 methods):
receiveUserQuery()
receiveCurrentUser()
addEntities()
receiveEntityRecords()
receiveCurrentTheme()
__experimentalReceiveCurrentGlobalStylesId()
__experimentalReceiveThemeBaseGlobalStyles()
__experimentalReceiveThemeGlobalStyleVariations()
receiveThemeSupports()
receiveThemeGlobalStyleRevisions()
receiveEmbedPreview()
receiveUploadPermissions()
receiveUserPermission()
receiveUserPermissions()
receiveAutosaves()
receiveNavigationFallbackId()
receiveDefaultTemplateId()
receiveRegisteredPostMeta()
camelCaseTransform()
camelCaseTransformMerge()
camelCase()
sortResults()
tokenize()
getResolutionsArgs()
deepCopyLocksTreePath()
getNode()
hasConflictingLock()
locks()
getPendingLockRequests()
isLockAvailable()
createLocks()
processPendingLockRequests()
acquire()
release()
createLocksActions()
__unstableAcquireStoreLock()
__unstableReleaseStoreLock()
EntityProvider()
memize()
memoized()
useQuerySelect()
useEntityRecord()
__experimentalUseEntityRecord()
useEntityRecords()
__experimentalUseEntityRecords()
useEntityRecordsWithPermissions()
useResourcePermissions()
__experimentalUseResourcePermissions()
useEntityId()
getRichTextValuesCached()
getBlockFootnotesOrder()
getFootnotesOrder()
updateFootnotesFromMeta()
updateAttributes()
updateBlocksAttributes()
useEntityBlockEditor()
useEntityProp()
Class: ObservableSet - X-Ref
| receiveUserQuery(queryID, users) X-Ref |
| Returns an action object used in signalling that authors have been received. Ignored from documentation as it's internal to the data store. return: {Object} Action object. param: {string} queryID Query ID. param: {Array|Object} users Users received. |
| receiveCurrentUser(currentUser) X-Ref |
| Returns an action used in signalling that the current user has been received. Ignored from documentation as it's internal to the data store. return: {Object} Action object. param: {Object} currentUser Current user object. |
| addEntities(entities) X-Ref |
| Returns an action object used in adding new entities. return: {Object} Action object. param: {Array} entities Entities received. |
| receiveEntityRecords(kind, name, records, query, invalidateCache = false, edits, meta) X-Ref |
| Returns an action object used in signalling that entity records have been received. return: {Object} Action object. param: {string} kind Kind of the received entity record. param: {string} name Name of the received entity record. param: {Array|Object} records Records received. param: {?Object} query Query Object. param: {?boolean} invalidateCache Should invalidate query caches. param: {?Object} edits Edits to reset. param: {?Object} meta Meta information about pagination. |
| receiveCurrentTheme(currentTheme) X-Ref |
| Returns an action object used in signalling that the current theme has been received. Ignored from documentation as it's internal to the data store. return: {Object} Action object. param: {Object} currentTheme The current theme. |
| __experimentalReceiveCurrentGlobalStylesId(currentGlobalStylesId) X-Ref |
| Returns an action object used in signalling that the current global styles id has been received. Ignored from documentation as it's internal to the data store. return: {Object} Action object. param: {string} currentGlobalStylesId The current global styles id. |
| __experimentalReceiveThemeBaseGlobalStyles(stylesheet, globalStyles) X-Ref |
| Returns an action object used in signalling that the theme base global styles have been received Ignored from documentation as it's internal to the data store. return: {Object} Action object. param: {string} stylesheet The theme's identifier param: {Object} globalStyles The global styles object. |
| __experimentalReceiveThemeGlobalStyleVariations(stylesheet, variations) X-Ref |
| Returns an action object used in signalling that the theme global styles variations have been received. Ignored from documentation as it's internal to the data store. return: {Object} Action object. param: {string} stylesheet The theme's identifier param: {Array} variations The global styles variations. |
| receiveThemeSupports() X-Ref |
| Returns an action object used in signalling that the index has been received. return: {Object} Action object. |
| receiveThemeGlobalStyleRevisions(currentId, revisions) X-Ref |
| Returns an action object used in signalling that the theme global styles CPT post revisions have been received. Ignored from documentation as it's internal to the data store. return: {Object} Action object. param: {number} currentId The post id. param: {Array} revisions The global styles revisions. |
| receiveEmbedPreview(url, preview) X-Ref |
| Returns an action object used in signalling that the preview data for a given URl has been received. Ignored from documentation as it's internal to the data store. return: {Object} Action object. param: {string} url URL to preview the embed for. param: {*} preview Preview data. |
| receiveUploadPermissions(hasUploadPermissions) X-Ref |
| Returns an action object used in signalling that Upload permissions have been received. return: {Object} Action object. param: {boolean} hasUploadPermissions Does the user have permission to upload files? |
| receiveUserPermission(key, isAllowed) X-Ref |
| Returns an action object used in signalling that the current user has permission to perform an action on a REST resource. Ignored from documentation as it's internal to the data store. return: {Object} Action object. param: {string} key A key that represents the action and REST resource. param: {boolean} isAllowed Whether or not the user can perform the action. |
| receiveUserPermissions(permissions) X-Ref |
| Returns an action object used in signalling that the current user has permission to perform an action on a REST resource. Ignored from documentation as it's internal to the data store. return: {Object} Action object. param: {Object<string, boolean>} permissions An object where keys represent |
| receiveAutosaves(postId, autosaves) X-Ref |
| Returns an action object used in signalling that the autosaves for a post have been received. Ignored from documentation as it's internal to the data store. return: {Object} Action object. param: {number} postId The id of the post that is parent to the autosave. param: {Array|Object} autosaves An array of autosaves or singular autosave object. |
| receiveNavigationFallbackId(fallbackId) X-Ref |
| Returns an action object signalling that the fallback Navigation Menu id has been received. return: {Object} Action object. param: {integer} fallbackId the id of the fallback Navigation Menu |
| receiveDefaultTemplateId(query, templateId) X-Ref |
| Returns an action object used to set the template for a given query. return: {Object} Action object. param: {Object} query The lookup query. param: {string} templateId The resolved template id. |
| receiveRegisteredPostMeta(postType, registeredPostMeta) X-Ref |
| Returns an action object used in signalling that the registered post meta fields for a post type have been received. return: {Object} Action object. param: {string} postType Post type slug. param: {Object} registeredPostMeta Registered post meta. |
| camelCaseTransform(input, index) X-Ref |
| No description |
| camelCaseTransformMerge(input, index) X-Ref |
| No description |
| camelCase(input, options) X-Ref |
| No description |
| sortResults(results, search) X-Ref |
| Sort search results by relevance to the given query. Sorting is necessary as we're querying multiple endpoints and merging the results. For example a taxonomy title might be more relevant than a post title, but by default taxonomy results will be ordered after all the (potentially irrelevant) post results. We sort by scoring each result, where the score is the number of tokens in the title that are also in the search query, divided by the total number of tokens in the title. This gives us a score between 0 and 1, where 1 is a perfect match. param: results param: search |
| tokenize(text) X-Ref |
| Turns text into an array of tokens, with whitespace and punctuation removed. For example, `"I'm having a ball."` becomes `[ "im", "having", "a", "ball" ]`. param: text |
| getResolutionsArgs(records) X-Ref |
| No description |
| deepCopyLocksTreePath(tree, path) X-Ref |
| No description |
| getNode(tree, path) X-Ref |
| No description |
| hasConflictingLock({exclusive}, locks) X-Ref |
| No description |
| locks(state = DEFAULT_STATE, action) X-Ref |
| Reducer returning locks. return: {Object} Updated state. param: {Object} state Current state. param: {Object} action Dispatched action. |
| getPendingLockRequests(state) X-Ref |
| Internal dependencies |
| isLockAvailable(state, store, path, {exclusive}) X-Ref |
| No description |
| createLocks() X-Ref |
| Internal dependencies |
| processPendingLockRequests() X-Ref |
| No description |
| acquire(store, path, exclusive) X-Ref |
| No description |
| release(lock) X-Ref |
| No description |
| createLocksActions() X-Ref |
| Internal dependencies |
| __unstableAcquireStoreLock(store, path, {exclusive}) X-Ref |
| No description |
| __unstableReleaseStoreLock(lock) X-Ref |
| No description |
| EntityProvider({kind,type: name,id,children}) X-Ref |
| Context provider component for providing an entity for a specific entity. return: {Object} The provided children, wrapped with param: {Object} props The component's props. param: {string} props.kind The entity kind. param: {string} props.type The entity name. param: {number} props.id The entity ID. param: {*} props.children The children to wrap. |
| memize(fn, options) X-Ref |
| Accepts a function to be memoized, and returns a new memoized function, with optional options. return: {((...args: Parameters<F>) => ReturnType<F>) & MemizeMemoizedFunction} Memoized function. param: {F} fn Function to memoize. param: {MemizeOptions} [options] Options object. |
| memoized() X-Ref |
| No description |
| useQuerySelect(mapQuerySelect, deps) X-Ref |
| Like useSelect, but the selectors return objects containing both the original data AND the resolution info. return: {QuerySelectResponse} Queried data. param: {Function} mapQuerySelect see useSelect param: {Array} deps see useSelect |
| useEntityRecord(kind, name, recordId, options = {enabled: true}) X-Ref |
| Resolves the specified entity record. return: Entity record data. param: kind Kind of the entity, e.g. `root` or a `postType`. See rootEntitiesConfig in ../entities.ts for a list of available kinds. param: name Name of the entity, e.g. `plugin` or a `post`. See rootEntitiesConfig in ../entities.ts for a list of available names. param: recordId ID of the requested entity record. param: options Optional hook options. |
| __experimentalUseEntityRecord(kind, name, recordId, options) X-Ref |
| No description |
| useEntityRecords(kind, name, queryArgs = {}, options = {enabled: true}) X-Ref |
| Resolves the specified entity records. return: Entity records data. param: kind Kind of the entity, e.g. `root` or a `postType`. See rootEntitiesConfig in ../entities.ts for a list of available kinds. param: name Name of the entity, e.g. `plugin` or a `post`. See rootEntitiesConfig in ../entities.ts for a list of available names. param: queryArgs Optional HTTP query description for how to fetch the data, passed to the requested API endpoint. param: options Optional hook options. |
| __experimentalUseEntityRecords(kind, name, queryArgs, options) X-Ref |
| No description |
| useEntityRecordsWithPermissions(kind, name, queryArgs = {}, options = {enabled: true}) X-Ref |
| No description |
| useResourcePermissions(resource, id) X-Ref |
| Resolves resource permissions. return: Entity records data. param: resource Entity resource to check. Accepts entity object `{ kind: 'root', name: 'media', id: 1 }` param: id Optional ID of the resource to check, e.g. 10. Note: This argument is discouraged |
| __experimentalUseResourcePermissions(resource, id) X-Ref |
| No description |
| useEntityId(kind, name) X-Ref |
| Hook that returns the ID for the nearest provided entity of the specified type. param: {string} kind The entity kind. param: {string} name The entity name. |
| getRichTextValuesCached(block) X-Ref |
| No description |
| getBlockFootnotesOrder(block) X-Ref |
| Internal dependencies |
| getFootnotesOrder(blocks) X-Ref |
| No description |
| updateFootnotesFromMeta(blocks, meta) X-Ref |
| Internal dependencies |
| updateAttributes(attributes) X-Ref |
| No description |
| updateBlocksAttributes(__blocks) X-Ref |
| No description |
| useEntityBlockEditor(kind, name, {id: _id} = {}) X-Ref |
| Hook that returns block content getters and setters for the nearest provided entity of the specified type. The return value has the shape `[ blocks, onInput, onChange ]`. `onInput` is for block changes that don't create undo levels or dirty the post, non-persistent changes, and `onChange` is for persistent changes. They map directly to the props of a `BlockEditorProvider` and are intended to be used with it, or similar components or hooks. return: {[unknown[], Function, Function]} The block array and setters. param: {string} kind The entity kind. param: {string} name The entity name. param: {Object} options param: {string} [options.id] An entity ID to use instead of the context-provided one. |
| useEntityProp(kind, name, prop, _id) X-Ref |
| Hook that returns the value and a setter for the specified property of the nearest provided entity of the specified type. return: {[*, Function, *]} An array where the first item is the param: {string} kind The entity kind. param: {string} name The entity name. param: {string} prop The property name. param: {number|string} [_id] An entity ID to use instead of the context-provided one. |
| _typeof(obj) X-Ref |
| No description |
| _classCallCheck(instance, Constructor) X-Ref |
| No description |
| _defineProperties(target, props) X-Ref |
| No description |
| _createClass(Constructor, protoProps, staticProps) X-Ref |
| No description |
| getValuePair(instance, key) X-Ref |
| Given an instance of EquivalentKeyMap, returns its internal value pair tuple for a key, if one exists. The tuple members consist of the last reference value for the key (used in efficient subsequent lookups) and the value assigned for the key at the leaf node. return: {?Array} Value pair, if exists. param: {EquivalentKeyMap} instance EquivalentKeyMap instance. param: {*} key The key for which to return value pair. |
| EquivalentKeyMap(iterable) X-Ref |
| No description |
| __webpack_require__(moduleId) X-Ref |
| No description |
| mergeHistoryChanges(changes1, changes2) X-Ref |
| Merge changes for a single item into a record of changes. return: {Record< string, HistoryChange >} Merged changes param: {Record< string, HistoryChange >} changes1 Previous changes param: {Record< string, HistoryChange >} changes2 NextChanges |
| createUndoManager() X-Ref |
| Creates an undo manager. return: {UndoManager} Undo manager. |
| conservativeMapItem(item, nextItem) X-Ref |
| Given the current and next item entity record, returns the minimally "modified" result of the next item, preferring value references from the original item if equal. If all values match, the original item is returned. return: {Object} Minimally modified merged item. param: {Object} item Original item. param: {Object} nextItem Next item. |
| __extends(d, b) X-Ref |
| No description |
| __() X-Ref |
| No description |
| __rest(s, e) X-Ref |
| No description |
| __decorate(decorators, target, key, desc) X-Ref |
| No description |
| __param(paramIndex, decorator) X-Ref |
| No description |
| __esDecorate(ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) X-Ref |
| No description |
| accept(f) X-Ref |
| No description |
| __runInitializers(thisArg, initializers, value) X-Ref |
| No description |
| __propKey(x) X-Ref |
| No description |
| __setFunctionName(f, name, prefix) X-Ref |
| No description |
| __metadata(metadataKey, metadataValue) X-Ref |
| No description |
| __awaiter(thisArg, _arguments, P, generator) X-Ref |
| No description |
| adopt(value) X-Ref |
| No description |
| fulfilled(value) X-Ref |
| No description |
| rejected(value) X-Ref |
| No description |
| step(result) X-Ref |
| No description |
| __generator(thisArg, body) X-Ref |
| No description |
| verb(n) X-Ref |
| No description |
| step(op) X-Ref |
| No description |
| __exportStar(m, o) X-Ref |
| No description |
| __values(o) X-Ref |
| No description |
| __read(o, n) X-Ref |
| No description |
| __spread() X-Ref |
| No description |
| __spreadArrays() X-Ref |
| No description |
| __spreadArray(to, from, pack) X-Ref |
| No description |
| __await(v) X-Ref |
| No description |
| __asyncGenerator(thisArg, _arguments, generator) X-Ref |
| No description |
| awaitReturn(f) X-Ref |
| No description |
| verb(n, f) X-Ref |
| No description |
| resume(n, v) X-Ref |
| No description |
| step(r) X-Ref |
| No description |
| fulfill(value) X-Ref |
| No description |
| reject(value) X-Ref |
| No description |
| settle(f, v) X-Ref |
| No description |
| __asyncDelegator(o) X-Ref |
| No description |
| verb(n, f) X-Ref |
| No description |
| __asyncValues(o) X-Ref |
| No description |
| verb(n) X-Ref |
| No description |
| settle(resolve, reject, d, v) X-Ref |
| No description |
| __makeTemplateObject(cooked, raw) X-Ref |
| No description |
| __importStar(mod) X-Ref |
| No description |
| __importDefault(mod) X-Ref |
| No description |
| __classPrivateFieldGet(receiver, state, kind, f) X-Ref |
| No description |
| __classPrivateFieldSet(receiver, state, value, kind, f) X-Ref |
| No description |
| __classPrivateFieldIn(state, receiver) X-Ref |
| No description |
| __addDisposableResource(env, value, async) X-Ref |
| No description |
| __disposeResources(env) X-Ref |
| No description |
| fail(e) X-Ref |
| No description |
| next() X-Ref |
| No description |
| __rewriteRelativeImportExtension(path, preserveJsx) X-Ref |
| No description |
| localeLowerCase(str, locale) X-Ref |
| Localized lower case. |
| lowerCase(str) X-Ref |
| Lower case as a function. |
| noCase(input, options) X-Ref |
| Normalize the string into something other libraries can manipulate easier. |
| replace(input, re, value) X-Ref |
| Replace `re` in the input string with the replacement value. |
| upperCaseFirst(input) X-Ref |
| Upper case the first character of an input string. |
| capitalCaseTransform(input) X-Ref |
| No description |
| capitalCase(input, options) X-Ref |
| No description |
| pascalCaseTransform(input, index) X-Ref |
| No description |
| dist_es2015_pascalCaseTransformMerge(input) X-Ref |
| No description |
| pascalCase(input, options) X-Ref |
| No description |
| makeBlockAttributesSerializable(attributes) X-Ref |
| No description |
| makeBlocksSerializable(blocks) X-Ref |
| No description |
| getNormalizedCommaSeparable(value) X-Ref |
| Given a value which can be specified as one or the other of a comma-separated string or an array, returns a value normalized to an array of strings, or null if the value cannot be interpreted as either. return: {?(string[])} Normalized field value. param: {string|string[]|*} value |
| withWeakMapCache(fn) X-Ref |
| Given a function, returns an enhanced function which caches the result and tracks in WeakMap. The result is only cached if the original function is passed a valid object-like argument (requirement for WeakMap key). return: {Function} Enhanced caching function. param: {Function} fn Original function. |
| getQueryParts(query) X-Ref |
| Given a query object, returns an object of parts, including pagination details (`page` and `perPage`, or default values). All other properties are encoded into a stable (idempotent) `stableKey` value. return: {WPQueriedDataQueryParts} Query parts. param: {Object} query Optional query object. |
| getContextFromAction(action) X-Ref |
| No description |
| getMergedItemIds(itemIds, nextItemIds, page, perPage) X-Ref |
| Returns a merged array of item IDs, given details of the received paginated items. The array is sparse-like with `undefined` entries where holes exist. return: {number[]} Merged array of item IDs. param: {?Array<number>} itemIds Original item IDs (default empty array). param: {number[]} nextItemIds Item IDs to merge. param: {number} page Page of items merged. param: {number} perPage Number of items per page. |
| removeEntitiesById(entities, ids) X-Ref |
| Helper function to filter out entities with certain IDs. Entities are keyed by their ID. return: {Object} Filtered entities. param: {Object} entities Entity objects, keyed by entity ID. param: {Array} ids Entity IDs to filter out. |
| items(state = {}, action) X-Ref |
| Reducer tracking items state, keyed by ID. Items are assumed to be normal, where identifiers are common across all queries. return: {Object} Next state. param: {Object} state Current state. param: {Object} action Dispatched action. |
| itemIsComplete(state = {}, action) X-Ref |
| Reducer tracking item completeness, keyed by ID. A complete item is one for which all fields are known. This is used in supporting `_fields` queries, where not all properties associated with an entity are necessarily returned. In such cases, completeness is used as an indication of whether it would be safe to use queried data for a non-`_fields`-limited request. return: {Object<string,Object<string,boolean>>} Next state. param: {Object<string,Object<string,boolean>>} state Current state. param: {Object} action Dispatched action. |
| terms(state = {}, action) X-Ref |
| Reducer managing terms state. Keyed by taxonomy slug, the value is either undefined (if no request has been made for given taxonomy), null (if a request is in-flight for given taxonomy), or the array of terms for the taxonomy. return: {Object} Updated state. param: {Object} state Current state. param: {Object} action Dispatched action. |
| users(state = {byId: {},queries: {}}, action) X-Ref |
| Reducer managing authors state. Keyed by id. return: {Object} Updated state. param: {Object} state Current state. param: {Object} action Dispatched action. |
| currentUser(state = {}, action) X-Ref |
| Reducer managing current user state. return: {Object} Updated state. param: {Object} state Current state. param: {Object} action Dispatched action. |
| taxonomies(state = [], action) X-Ref |
| Reducer managing taxonomies. return: {Object} Updated state. param: {Object} state Current state. param: {Object} action Dispatched action. |
| currentTheme(state = undefined, action) X-Ref |
| Reducer managing the current theme. return: {string|undefined} Updated state. param: {string|undefined} state Current state. param: {Object} action Dispatched action. |
| currentGlobalStylesId(state = undefined, action) X-Ref |
| Reducer managing the current global styles id. return: {string|undefined} Updated state. param: {string|undefined} state Current state. param: {Object} action Dispatched action. |
| themeBaseGlobalStyles(state = {}, action) X-Ref |
| Reducer managing the theme base global styles. return: {Record<string, object>} Updated state. param: {Record<string, object>} state Current state. param: {Object} action Dispatched action. |
| themeGlobalStyleVariations(state = {}, action) X-Ref |
| Reducer managing the theme global styles variations. return: {Record<string, object>} Updated state. param: {Record<string, object>} state Current state. param: {Object} action Dispatched action. |
| entity(entityConfig) X-Ref |
| Higher Order Reducer for a given entity config. It supports: - Fetching - Editing - Saving return: {AnyFunction} Reducer. param: {Object} entityConfig Entity config. |
| entitiesConfig(state = rootEntitiesConfig, action) X-Ref |
| Reducer keeping track of the registered entities. return: {Object} Updated state. param: {Object} state Current state. param: {Object} action Dispatched action. |
| undoManager(state = createUndoManager() X-Ref |
| editsReference(state = {}, action) X-Ref |
| No description |
| embedPreviews(state = {}, action) X-Ref |
| Reducer managing embed preview data. return: {Object} Updated state. param: {Object} state Current state. param: {Object} action Dispatched action. |
| userPermissions(state = {}, action) X-Ref |
| State which tracks whether the user can perform an action on a REST resource. return: {Object} Updated state. param: {Object} state Current state. param: {Object} action Dispatched action. |
| autosaves(state = {}, action) X-Ref |
| Reducer returning autosaves keyed by their parent's post id. return: {Object} Updated state. param: {Object} state Current state. param: {Object} action Dispatched action. |
| blockPatterns(state = [], action) X-Ref |
| No description |
| blockPatternCategories(state = [], action) X-Ref |
| No description |
| userPatternCategories(state = [], action) X-Ref |
| No description |
| navigationFallbackId(state = null, action) X-Ref |
| No description |
| themeGlobalStyleRevisions(state = {}, action) X-Ref |
| Reducer managing the theme global styles revisions. return: {Record<string, object>} Updated state. param: {Record<string, object>} state Current state. param: {Object} action Dispatched action. |
| defaultTemplates(state = {}, action) X-Ref |
| Reducer managing the template lookup per query. return: {Record<string, string>} Updated state. param: {Record<string, string>} state Current state. param: {Object} action Dispatched action. |
| registeredPostMeta(state = {}, action) X-Ref |
| Reducer returning an object of registered post meta. return: {Object} Updated state. param: {Object} state Current state. param: {Object} action Dispatched action. |
| setNestedValue(object, path, value) X-Ref |
| Sets the value at path of object. If a portion of path doesn’t exist, it’s created. Arrays are created for missing index properties while objects are created for all other missing properties. Path is specified as either: - a string of properties, separated by dots, for example: "x.y". - an array of properties, for example `[ 'x', 'y' ]`. This function intentionally mutates the input object. Inspired by _.set(). param: {Object} object Object to modify param: {Array|string} path Path of the property to set. param: {*} value Value to set. |
| getQueriedItemsUncached(state, query) X-Ref |
| Returns items for a given query, or null if the items are not known. return: {?Array} Query items. param: {Object} state State object. param: {?Object} query Optional query. |
| getQueriedTotalItems(state, query = {}) X-Ref |
| No description |
| getQueriedTotalPages(state, query = {}) X-Ref |
| No description |
| isNumericID(id) X-Ref |
| Checks argument to determine if it's a numeric ID. For example, '123' is a numeric ID, but '123abc' is not. return: {boolean} true if the string is a numeric ID, false otherwise. param: {any} id the argument to determine if it's a numeric ID. |
| isRawAttribute(entity, attribute) X-Ref |
| Checks whether the attribute is a "raw" attribute or not. return: {boolean} Is the attribute raw param: {Object} entity Entity record. param: {string} attribute Attribute name. |
| getUserPermissionsFromAllowHeader(allowedMethods) X-Ref |
| No description |
| getUserPermissionCacheKey(action, resource, id) X-Ref |
| No description |
| getAuthors(state, query) X-Ref |
| Returns all available authors. return: Authors list. param: state Data state. param: query Optional object of query parameters to |
| getCurrentUser(state) X-Ref |
| Returns the current user. return: Current user object. param: state Data state. |
| getEntitiesByKind(state, kind) X-Ref |
| Returns the loaded entities for the given kind. return: Array of entities with config matching kind. param: state Data state. param: kind Entity kind. |
| getEntity(state, kind, name) X-Ref |
| Returns the entity config given its kind and name. return: Entity config param: state Data state. param: kind Entity kind. param: name Entity name. |
| getEntityConfig(state, kind, name) X-Ref |
| Returns the entity config given its kind and name. return: Entity config param: state Data state. param: kind Entity kind. param: name Entity name. |
| __experimentalGetEntityRecordNoResolver(state, kind, name, key) X-Ref |
| Returns the Entity's record object by key. Doesn't trigger a resolver nor requests the entity records from the API if the entity record isn't available in the local state. return: Record. param: state State tree param: kind Entity kind. param: name Entity name. param: key Record's key |
| hasEntityRecords(state, kind, name, query) X-Ref |
| Returns true if records have been received for the given set of parameters, or false otherwise. return: Whether entity records have been received. param: state State tree param: kind Entity kind. param: name Entity name. param: query Optional terms query. For valid query parameters see the [Reference](https://developer.wordpress.org/rest-api/reference/) in the REST API Handbook and select the entity kind. Then see the arguments available for "List [Entity kind]s". |
| getEntityRecordEdits(state, kind, name, recordId) X-Ref |
| Returns the specified entity record's edits. return: The entity record's edits. param: state State tree. param: kind Entity kind. param: name Entity name. param: recordId Record ID. |
| hasEditsForEntityRecord(state, kind, name, recordId) X-Ref |
| Returns true if the specified entity record has edits, and false otherwise. return: Whether the entity record has edits or not. param: state State tree. param: kind Entity kind. param: name Entity name. param: recordId Record ID. |
| isAutosavingEntityRecord(state, kind, name, recordId) X-Ref |
| Returns true if the specified entity record is autosaving, and false otherwise. return: Whether the entity record is autosaving or not. param: state State tree. param: kind Entity kind. param: name Entity name. param: recordId Record ID. |
| isSavingEntityRecord(state, kind, name, recordId) X-Ref |
| Returns true if the specified entity record is saving, and false otherwise. return: Whether the entity record is saving or not. param: state State tree. param: kind Entity kind. param: name Entity name. param: recordId Record ID. |
| isDeletingEntityRecord(state, kind, name, recordId) X-Ref |
| Returns true if the specified entity record is deleting, and false otherwise. return: Whether the entity record is deleting or not. param: state State tree. param: kind Entity kind. param: name Entity name. param: recordId Record ID. |
| getLastEntitySaveError(state, kind, name, recordId) X-Ref |
| Returns the specified entity record's last save error. return: The entity record's save error. param: state State tree. param: kind Entity kind. param: name Entity name. param: recordId Record ID. |
| getLastEntityDeleteError(state, kind, name, recordId) X-Ref |
| Returns the specified entity record's last delete error. return: The entity record's save error. param: state State tree. param: kind Entity kind. param: name Entity name. param: recordId Record ID. |
| getUndoEdit(state) X-Ref |
| Returns the previous edit from the current undo offset for the entity records edits history, if any. return: The edit. param: state State tree. |
| getRedoEdit(state) X-Ref |
| Returns the next edit from the current undo offset for the entity records edits history, if any. return: The edit. param: state State tree. |
| hasUndo(state) X-Ref |
| Returns true if there is a previous edit from the current undo offset for the entity records edits history, and false otherwise. return: Whether there is a previous edit or not. param: state State tree. |
| hasRedo(state) X-Ref |
| Returns true if there is a next edit from the current undo offset for the entity records edits history, and false otherwise. return: Whether there is a next edit or not. param: state State tree. |
| getCurrentTheme(state) X-Ref |
| Return the current theme. return: The current theme. param: state Data state. |
| __experimentalGetCurrentGlobalStylesId(state) X-Ref |
| Return the ID of the current global styles object. return: The current global styles ID. param: state Data state. |
| getThemeSupports(state) X-Ref |
| Return theme supports data in the index. return: Index data. param: state Data state. |
| getEmbedPreview(state, url) X-Ref |
| Returns the embed preview for the given URL. return: Undefined if the preview has not been fetched, otherwise, the preview fetched from the embed preview API. param: state Data state. param: url Embedded URL. |
| isPreviewEmbedFallback(state, url) X-Ref |
| 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. return: Is the preview for the URL an oEmbed link fallback. param: state Data state. param: url Embedded URL. |
| canUser(state, action, resource, id) X-Ref |
| 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/ return: Whether or not the user can perform the action, param: state Data state. param: action Action to check. One of: 'create', 'read', 'update', 'delete'. param: resource Entity resource to check. Accepts entity object `{ kind: 'root', name: 'media', id: 1 }` param: id Optional ID of the rest resource to check. |
| canUserEditEntityRecord(state, kind, name, recordId) X-Ref |
| 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/ return: Whether or not the user can edit, param: state Data state. param: kind Entity kind. param: name Entity name. param: recordId Record's id. |
| getAutosaves(state, postType, postId) X-Ref |
| Returns the latest autosaves for the post. May return multiple autosaves since the backend stores one autosave per author for each post. return: An array of autosaves for the post, or undefined if there is none. param: state State tree. param: postType The type of the parent post. param: postId The id of the parent post. |
| getAutosave(state, postType, postId, authorId) X-Ref |
| Returns the autosave for the post and author. return: The autosave for the post and author. param: state State tree. param: postType The type of the parent post. param: postId The id of the parent post. param: authorId The id of the author. |
| getReferenceByDistinctEdits(state) X-Ref |
| 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. return: A value whose reference will change only when an edit occurs. param: state Editor state. |
| __experimentalGetCurrentThemeBaseGlobalStyles(state) X-Ref |
| Retrieve the current theme's base global styles return: The Global Styles object. param: state Editor state. |
| __experimentalGetCurrentThemeGlobalStylesVariations(state) X-Ref |
| Return the ID of the current global styles object. return: The current global styles ID. param: state Data state. |
| getBlockPatterns(state) X-Ref |
| Retrieve the list of registered block patterns. return: Block pattern list. param: state Data state. |
| getBlockPatternCategories(state) X-Ref |
| Retrieve the list of registered block pattern categories. return: Block pattern category list. param: state Data state. |
| getUserPatternCategories(state) X-Ref |
| Retrieve the registered user pattern categories. return: User patterns category array. param: state Data state. |
| getCurrentThemeGlobalStylesRevisions(state) X-Ref |
| Returns the revisions of the current global styles theme. return: The current global styles. param: state Data state. |
| getDefaultTemplateId(state, query) X-Ref |
| Returns the default template use to render a given query. return: The default template id for the given query. param: state Data state. param: query Query. |
| getUndoManager(state) X-Ref |
| Returns the previous edit from the current undo offset for the entity records edits history, if any. return: The undo manager. param: state State tree. |
| getNavigationFallbackId(state) X-Ref |
| Retrieve the fallback Navigation. return: The ID for the fallback Navigation post. param: state Data state. |
| getEntityRecordPermissions(state, kind, name, id) X-Ref |
| Returns the entity record permissions for the given entity record id. return: The entity record permissions. param: state Data state. param: kind Entity kind. param: name Entity name. param: id Entity record id. |
| getRegisteredPostMeta(state, postType) X-Ref |
| Returns the registered post meta fields for a given post type. return: Registered post meta fields. param: state Data state. param: postType Post type. |
| normalizePageId(value) X-Ref |
| No description |
| rng() X-Ref |
| No description |
| unsafeStringify(arr, offset = 0) X-Ref |
| No description |
| stringify(arr, offset = 0) X-Ref |
| No description |
| v4(options, buf, offset) X-Ref |
| No description |
| getNestedValue(object, path, defaultValue) X-Ref |
| Helper util to return a value from a certain path of the object. Path is specified as either: - a string of properties, separated by dots, for example: "x.y". - an array of properties, for example `[ 'x', 'y' ]`. You can also specify a default value in case the result is nullish. return: {*} Value of the object property at the specified path. param: {Object} object Input object. param: {string|Array} path Path to the object property. param: {*} defaultValue Default value if the value at the specified path is undefined. |
| receiveItems(items, edits, meta) X-Ref |
| Returns an action object used in signalling that items have been received. return: {Object} Action object. param: {Array} items Items received. param: {?Object} edits Optional edits to reset. param: {?Object} meta Meta information about pagination. |
| removeItems(kind, name, records, invalidateCache = false) X-Ref |
| Returns an action object used in signalling that entity records have been deleted and they need to be removed from entities state. return: {Object} Action object. param: {string} kind Kind of the removed entities. param: {string} name Name of the removed entities. param: {Array|number|string} records Record IDs of the removed entities. param: {boolean} invalidateCache Controls whether we want to invalidate the cache. |
| receiveQueriedItems(items, query = {}, edits, meta) X-Ref |
| Returns an action object used in signalling that queried data has been received. return: {Object} Action object. param: {Array} items Queried items received. param: {?Object} query Optional query object. param: {?Object} edits Optional edits to reset. param: {?Object} meta Meta information about pagination. |
| chunk(arr, chunkSize) X-Ref |
| Maximum number of requests to place in a single batch request. Obtained by sending a preflight OPTIONS request to /batch/v1/. |
| createBatch(processor = defaultProcessor) X-Ref |
| Creates a batch, which can be used to combine multiple API requests into one API request using the WordPress batch processing API (/v1/batch). ``` const batch = createBatch(); const dunePromise = batch.add( { path: '/v1/books', method: 'POST', data: { title: 'Dune' } } ); const lotrPromise = batch.add( { path: '/v1/books', method: 'POST', data: { title: 'Lord of the Rings' } } ); const isSuccess = await batch.run(); // Sends one POST to /v1/batch. if ( isSuccess ) { console.log( 'Saved two books:', await dunePromise, await lotrPromise ); } ``` param: {Function} [processor] Processor function. Can be used to replace the |
| Generated : Sat Jul 26 08:20:01 2025 | Cross-referenced by PHPXref |