| [ Index ] |
PHP Cross Reference of WordPress |
[Source view] [Print] [Project Stats]
(no description)
| File Size: | 6405 lines (195 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
ObservableSet:: (103 methods):
receiveUserQuery()
receiveCurrentUser()
addEntities()
receiveEntityRecords()
receiveCurrentTheme()
__experimentalReceiveCurrentGlobalStylesId()
__experimentalReceiveThemeBaseGlobalStyles()
__experimentalReceiveThemeGlobalStyleVariations()
receiveThemeSupports()
receiveEmbedPreview()
__unstableCreateUndoLevel()
receiveUploadPermissions()
receiveUserPermission()
receiveAutosaves()
getNormalizedCommaSeparable()
withWeakMapCache()
getQueryParts()
getContextFromAction()
getMergedItemIds()
items()
itemIsComplete()
terms()
users()
currentUser()
taxonomies()
currentTheme()
currentGlobalStylesId()
themeBaseGlobalStyles()
themeGlobalStyleVariations()
entity()
entitiesConfig()
reducer_undo()
embedPreviews()
userPermissions()
autosaves()
blockPatterns()
blockPatternCategories()
arrayOf()
isObjectLike()
createCache()
isShallowEqual()
rememo()
getRootCache()
getWeakMapCache()
clear()
callSelector()
getQueriedItemsUncached()
isRawAttribute()
getAuthors()
getCurrentUser()
getEntitiesByKind()
getEntitiesConfig()
getEntity()
getEntityConfig()
__experimentalGetEntityRecordNoResolver()
hasEntityRecords()
getEntityRecords()
getEntityRecordEdits()
hasEditsForEntityRecord()
isAutosavingEntityRecord()
isSavingEntityRecord()
isDeletingEntityRecord()
getLastEntitySaveError()
getLastEntityDeleteError()
getCurrentUndoOffset()
getUndoEdit()
getRedoEdit()
hasUndo()
hasRedo()
getCurrentTheme()
__experimentalGetCurrentGlobalStylesId()
getThemeSupports()
getEmbedPreview()
isPreviewEmbedFallback()
canUser()
canUserEditEntityRecord()
getAutosaves()
getAutosave()
__experimentalGetTemplateForLink()
__experimentalGetCurrentThemeBaseGlobalStyles()
__experimentalGetCurrentThemeGlobalStylesVariations()
getBlockPatterns()
getBlockPatternCategories()
deepCopyLocksTreePath()
getNode()
hasConflictingLock()
locks()
getPendingLockRequests()
isLockAvailable()
createLocks()
processPendingLockRequests()
acquire()
release()
createLocksActions()
__unstableAcquireStoreLock()
__unstableReleaseStoreLock()
EntityProvider()
useEntityId()
useEntityProp()
useEntityBlockEditor()
__experimentalUseQuerySelect()
__experimentalUseEntityRecord()
__experimentalUseEntityRecords()
Class: ObservableSet - X-Ref
| receiveUserQuery(queryID, users) X-Ref |
| Returns an action object used in signalling that authors have been received. 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. 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) 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. |
| receiveCurrentTheme(currentTheme) X-Ref |
| Returns an action object used in signalling that the current theme has been received. 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. 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 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. 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. |
| receiveEmbedPreview(url, preview) X-Ref |
| Returns an action object used in signalling that the preview data for a given URl has been received. return: {Object} Action object. param: {string} url URL to preview the embed for. param: {*} preview Preview data. |
| __unstableCreateUndoLevel() X-Ref |
| Forces the creation of a new undo level. return: {Object} Action object. |
| 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. 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. |
| receiveAutosaves(postId, autosaves) X-Ref |
| Returns an action object used in signalling that the autosaves for a post have been received. 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. |
| 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. |
| items() 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() 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() 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() X-Ref |
| Reducer managing authors state. Keyed by id. return: {Object} Updated state. param: {Object} state Current state. param: {Object} action Dispatched action. |
| currentUser() X-Ref |
| Reducer managing current user state. return: {Object} Updated state. param: {Object} state Current state. param: {Object} action Dispatched action. |
| taxonomies() X-Ref |
| Reducer managing taxonomies. return: {Object} Updated state. param: {Object} state Current state. param: {Object} action Dispatched action. |
| currentTheme() X-Ref |
| Reducer managing the current theme. return: {string|undefined} Updated state. param: {string|undefined} state Current state. param: {Object} action Dispatched action. |
| currentGlobalStylesId() 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() 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() 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() X-Ref |
| Reducer keeping track of the registered entities. return: {Object} Updated state. param: {Object} state Current state. param: {Object} action Dispatched action. |
| reducer_undo() X-Ref |
| Reducer keeping track of entity edit undo history. return: {UndoState} Updated state. param: {UndoState} state Current state. param: {Object} action Dispatched action. |
| embedPreviews() X-Ref |
| Reducer managing embed preview data. return: {Object} Updated state. param: {Object} state Current state. param: {Object} action Dispatched action. |
| userPermissions() 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() 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() X-Ref |
| No description |
| blockPatternCategories() X-Ref |
| No description |
| arrayOf( value ) X-Ref |
| Returns the first argument as the sole entry in an array. return: {Array} Value returned as entry in array. param: {*} value Value to return. |
| isObjectLike( value ) X-Ref |
| Returns true if the value passed is object-like, or false otherwise. A value is object-like if it can support property assignment, e.g. object or array. return: {boolean} Whether value is object-like. param: {*} value Value to test. |
| createCache() X-Ref |
| Creates and returns a new cache object. return: {Object} Cache object. |
| isShallowEqual( a, b, fromIndex ) X-Ref |
| Returns true if entries within the two arrays are strictly equal by reference from a starting index. return: {boolean} Whether arrays are shallowly equal. param: {Array} a First array. param: {Array} b Second array. param: {number} fromIndex Index from which to start comparison. |
| rememo(selector, getDependants ) X-Ref |
| Returns a memoized selector function. The getDependants function argument is called before the memoized selector and is expected to return an immutable reference or array of references on which the selector depends for computing its own return value. The memoize cache is preserved only as long as those dependant references remain the same. If getDependants returns a different reference(s), the cache is cleared and the selector value regenerated. return: {Function} Memoized selector. param: {Function} selector Selector function. param: {Function} getDependants Dependant getter returning an immutable |
| getRootCache() X-Ref |
| Returns the root cache. If WeakMap is supported, this is assigned to the root WeakMap cache set, otherwise it is a shared instance of the default cache object. return: {(WeakMap|Object)} Root cache object. |
| getWeakMapCache( dependants ) X-Ref |
| Returns the cache for a given dependants array. When possible, a WeakMap will be used to create a unique cache for each set of dependants. This is feasible due to the nature of WeakMap in allowing garbage collection to occur on entries where the key object is no longer referenced. Since WeakMap requires the key to be an object, this is only possible when the dependant is object-like. The root cache is created as a hierarchy where each top-level key is the first entry in a dependants set, the value a WeakMap where each key is the next dependant, and so on. This continues so long as the dependants are object-like. If no dependants are object- like, then the cache is shared across all invocations. return: {Object} Cache object. param: {Array} dependants Selector dependants. |
| clear() X-Ref |
| Resets root memoization cache. |
| callSelector( ) X-Ref |
| The augmented selector call, considering first whether dependants have changed before passing it to underlying memoize function. return: {*} Selector result. param: {Object} source Source object for derivation. param: {...*} extraArgs Additional arguments to pass to selector. |
| 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. |
| 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. |
| getAuthors(state, query) X-Ref |
| Returns all available authors. return: {Array} Authors list. param: {Object} state Data state. param: {Object|undefined} query Optional object of query parameters to |
| getCurrentUser(state) X-Ref |
| Returns the current user. return: {Object} Current user object. param: {Object} state Data state. |
| getEntitiesByKind(state, kind) X-Ref |
| Returns the loaded entities for the given kind. return: {Array<Object>} Array of entities with config matching kind. param: {Object} state Data state. param: {string} kind Entity kind. |
| getEntitiesConfig(state, kind) X-Ref |
| Returns the loaded entities for the given kind. return: {Array<Object>} Array of entities with config matching kind. param: {Object} state Data state. param: {string} kind Entity kind. |
| getEntity(state, kind, name) X-Ref |
| Returns the entity config given its kind and name. return: {Object} Entity config param: {Object} state Data state. param: {string} kind Entity kind. param: {string} name Entity name. |
| getEntityConfig(state, kind, name) X-Ref |
| Returns the entity config given its kind and name. return: {Object} Entity config param: {Object} state Data state. param: {string} kind Entity kind. param: {string} 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: {Object|null} Record. param: {Object} state State tree param: {string} kind Entity kind. param: {string} name Entity name. param: {number} 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: {boolean} Whether entity records have been received. param: {Object} state State tree param: {string} kind Entity kind. param: {string} name Entity name. param: {?Object} query Optional terms query. |
| getEntityRecords(state, kind, name, query) X-Ref |
| Returns the Entity's records. return: {?Array} Records. param: {Object} state State tree param: {string} kind Entity kind. param: {string} name Entity name. param: {?Object} query Optional terms query. |
| getEntityRecordEdits(state, kind, name, recordId) X-Ref |
| Returns the specified entity record's edits. return: {Object?} The entity record's edits. param: {Object} state State tree. param: {string} kind Entity kind. param: {string} name Entity name. param: {number} recordId Record ID. |
| hasEditsForEntityRecord(state, kind, name, recordId) X-Ref |
| Returns true if the specified entity record has edits, and false otherwise. return: {boolean} Whether the entity record has edits or not. param: {Object} state State tree. param: {string} kind Entity kind. param: {string} name Entity name. param: {number|string} recordId Record ID. |
| isAutosavingEntityRecord(state, kind, name, recordId) X-Ref |
| Returns true if the specified entity record is autosaving, and false otherwise. return: {boolean} Whether the entity record is autosaving or not. param: {Object} state State tree. param: {string} kind Entity kind. param: {string} name Entity name. param: {number} recordId Record ID. |
| isSavingEntityRecord(state, kind, name, recordId) X-Ref |
| Returns true if the specified entity record is saving, and false otherwise. return: {boolean} Whether the entity record is saving or not. param: {Object} state State tree. param: {string} kind Entity kind. param: {string} name Entity name. param: {number|string} recordId Record ID. |
| isDeletingEntityRecord(state, kind, name, recordId) X-Ref |
| Returns true if the specified entity record is deleting, and false otherwise. return: {boolean} Whether the entity record is deleting or not. param: {Object} state State tree. param: {string} kind Entity kind. param: {string} name Entity name. param: {number} recordId Record ID. |
| getLastEntitySaveError(state, kind, name, recordId) X-Ref |
| Returns the specified entity record's last save error. return: {Object?} The entity record's save error. param: {Object} state State tree. param: {string} kind Entity kind. param: {string} name Entity name. param: {number} recordId Record ID. |
| getLastEntityDeleteError(state, kind, name, recordId) X-Ref |
| Returns the specified entity record's last delete error. return: {Object?} The entity record's save error. param: {Object} state State tree. param: {string} kind Entity kind. param: {string} name Entity name. param: {number} recordId Record ID. |
| getCurrentUndoOffset(state) X-Ref |
| Returns the current undo offset for the entity records edits history. The offset represents how many items from the end of the history stack we are at. 0 is the last edit, -1 is the second last, and so on. return: {number} The current undo offset. param: {Object} state State tree. |
| getUndoEdit(state) X-Ref |
| Returns the previous edit from the current undo offset for the entity records edits history, if any. return: {Object?} The edit. param: {Object} 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: {Object?} The edit. param: {Object} 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: {boolean} Whether there is a previous edit or not. param: {Object} 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: {boolean} Whether there is a next edit or not. param: {Object} state State tree. |
| getCurrentTheme(state) X-Ref |
| Return the current theme. return: {Object} The current theme. param: {Object} state Data state. |
| __experimentalGetCurrentGlobalStylesId(state) X-Ref |
| Return the ID of the current global styles object. return: {string} The current global styles ID. param: {Object} state Data state. |
| getThemeSupports(state) X-Ref |
| Return theme supports data in the index. return: {*} Index data. param: {Object} 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: {Object} state Data state. param: {string} 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: {boolean} Is the preview for the URL an oEmbed link fallback. param: {Object} state Data state. param: {string} 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: {boolean|undefined} Whether or not the user can perform the action, param: {Object} state Data state. param: {string} action Action to check. One of: 'create', 'read', 'update', 'delete'. param: {string} resource REST resource to check, e.g. 'media' or 'posts'. param: {string=} 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: {boolean|undefined} Whether or not the user can edit, param: {Object} state Data state. param: {string} kind Entity kind. param: {string} name Entity name. param: {string} 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: {?Array} An array of autosaves for the post, or undefined if there is none. param: {Object} state State tree. param: {string} postType The type of the parent post. param: {number} postId The id of the parent post. |
| getAutosave(state, postType, postId, authorId) X-Ref |
| Returns the autosave for the post and author. return: {?Object} The autosave for the post and author. param: {Object} state State tree. param: {string} postType The type of the parent post. param: {number} postId The id of the parent post. param: {number} authorId The id of the author. |
| __experimentalGetTemplateForLink(state, link) X-Ref |
| Retrieve the frontend template used for a given link. return: {Object?} The template record. param: {Object} state Editor state. param: {string} link Link. |
| __experimentalGetCurrentThemeBaseGlobalStyles(state) X-Ref |
| Retrieve the current theme's base global styles return: {Object|null} The Global Styles object. param: {Object} state Editor state. |
| __experimentalGetCurrentThemeGlobalStylesVariations(state) X-Ref |
| Return the ID of the current global styles object. return: {string|null} The current global styles ID. param: {Object} state Data state. |
| getBlockPatterns(state) X-Ref |
| Retrieve the list of registered block patterns. return: {Array} Block pattern list. param: {Object} state Data state. |
| getBlockPatternCategories(state) X-Ref |
| Retrieve the list of registered block pattern categories. return: {Array} Block pattern category list. param: {Object} state Data state. |
| deepCopyLocksTreePath(tree, path) X-Ref |
| No description |
| getNode(tree, path) X-Ref |
| No description |
| hasConflictingLock(_ref, locks) X-Ref |
| No description |
| locks() 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, _ref) 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, _ref) X-Ref |
| No description |
| __unstableReleaseStoreLock(lock) X-Ref |
| No description |
| EntityProvider(_ref) 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. |
| 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. |
| 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: {string} [_id] An entity ID to use instead of the context-provided one. |
| useEntityBlockEditor(kind, name) 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 peristent changes. They map directly to the props of a `BlockEditorProvider` and are intended to be used with it, or similar components or hooks. return: {[WPBlock[], 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. |
| __experimentalUseQuerySelect(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 |
| __experimentalUseEntityRecord(kind, name, recordId) X-Ref |
| Resolves the specified entity record. return: {EntityRecordResolution<RecordType>} Entity record data. param: kind Kind of the requested entity. param: name Name of the requested entity. param: recordId Record ID of the requested entity. param: options Hook options. param: [options.enabled=true] Whether to run the query or short-circuit and return null. Defaults to true. |
| __experimentalUseEntityRecords(kind, name) X-Ref |
| Resolves the specified entity records. return: Entity records data. param: kind Kind of the requested entities. param: name Name of the requested entities. param: queryArgs HTTP query for the requested entities. param: options Hook options. |
| _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 |
| memize( fn, options ) X-Ref |
| Accepts a function to be memoized, and returns a new memoized function, with optional options. return: {F & MemizeMemoizedFunction} Memoized function. param: {F} fn Function to memoize. param: {MemizeOptions} [options] Options object. |
| memoized( ) X-Ref |
| No description |
| __webpack_require__(moduleId) X-Ref |
| No description |
| conservativeMapItem(item, nextItem) X-Ref |
| No description |
| rng() X-Ref |
| No description |
| validate(uuid) X-Ref |
| No description |
| stringify(arr) X-Ref |
| No description |
| v4(options, buf, offset) X-Ref |
| No description |
| receiveItems(items, edits) 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. |
| removeItems(kind, name, records) 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) 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. |
| createBatch() 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: Thu Nov 21 01:00:03 2024 | Cross-referenced by PHPXref 0.7.1 |