| [ Index ] |
PHP Cross Reference of WordPress Trunk (Updated Daily) |
[Source view] [Print] [Project Stats]
(no description)
| File Size: | 4453 lines (146 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| __webpack_require__(moduleId) X-Ref |
| No description |
| getDefault() X-Ref |
| No description |
| getModuleExports() X-Ref |
| No description |
| _arrayWithoutHoles(arr) X-Ref |
| No description |
| _nonIterableSpread() X-Ref |
| No description |
| _toConsumableArray(arr) X-Ref |
| No description |
| _iterableToArrayLimit(arr, i) X-Ref |
| No description |
| _slicedToArray(arr, i) X-Ref |
| No description |
| _arrayLikeToArray(arr, len) X-Ref |
| No description |
| _unsupportedIterableToArray(o, minLen) X-Ref |
| No description |
| _iterableToArray(iter) X-Ref |
| No description |
| _arrayWithHoles(arr) X-Ref |
| No description |
| _nonIterableRest() 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. |
| 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. |
| conservativeMapItem(item, nextItem) X-Ref |
| Given the current and next item entity, 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. |
| ownKeys(object, enumerableOnly) X-Ref |
| No description |
| _objectSpread(target) X-Ref |
| No description |
| 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. |
| actions_ownKeys(object, enumerableOnly) X-Ref |
| No description |
| actions_objectSpread(target) X-Ref |
| No description |
| receiveItems(items) X-Ref |
| Returns an action object used in signalling that items have been received. return: {Object} Action object. param: {Array} items Items received. |
| 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. |
| 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. |
| 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. |
| apiFetch(request) X-Ref |
| Trigger an API Fetch request. return: {Object} control descriptor. param: {Object} request API Fetch Request Object. |
| controls_select(selectorName) X-Ref |
| Calls a selector using the current state. return: {Object} control descriptor. param: {string} selectorName Selector name. param: {Array} args Selector arguments. |
| resolveSelect(selectorName) X-Ref |
| Dispatches a control action for triggering a registry select that has a resolver. return: {Object} control descriptor. param: {string} selectorName param: {Array} args Arguments for the select. |
| build_module_actions_ownKeys(object, enumerableOnly) X-Ref |
| No description |
| build_module_actions_objectSpread(target) X-Ref |
| No description |
| 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. param: {string} name Name of the received entity. param: {Array|Object} records Records received. param: {?Object} query Query Object. param: {?boolean} invalidateCache Should invalidate query caches |
| receiveThemeSupports(themeSupports) X-Ref |
| Returns an action object used in signalling that the index has been received. return: {Object} Action object. param: {Object} themeSupports Theme support for the current theme. |
| 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. |
| actions_editEntityRecord(kind, name, recordId, edits) X-Ref |
| Returns an action object that triggers an edit to an entity record. return: {Object} Action object. param: {string} kind Kind of the edited entity record. param: {string} name Name of the edited entity record. param: {number} recordId Record ID of the edited entity record. param: {Object} edits The edits. param: {Object} options Options for the edit. param: {boolean} options.undoIgnore Whether to ignore the edit in undo history or not. |
| undo() X-Ref |
| Action triggered to undo the last edit to an entity record, if any. |
| redo() X-Ref |
| Action triggered to redo the last undoed edit to an entity record, if any. |
| __unstableCreateUndoLevel() X-Ref |
| Forces the creation of a new undo level. return: {Object} Action object. |
| saveEntityRecord(kind, name, record) X-Ref |
| Action triggered to save an entity record. param: {string} kind Kind of the received entity. param: {string} name Name of the received entity. param: {Object} record Record to be saved. param: {Object} options Saving options. |
| saveEditedEntityRecord(kind, name, recordId, options) X-Ref |
| Action triggered to save an entity record's edits. param: {string} kind Kind of the entity. param: {string} name Name of the entity. param: {Object} recordId ID of the record. param: {Object} options Saving options. |
| 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. |
| loadPostTypeEntities() X-Ref |
| Returns the list of post type entities. return: {Promise} Entities promise |
| loadTaxonomyEntities() X-Ref |
| Returns the list of the taxonomies entities. return: {Promise} Entities promise |
| getKindEntities(kind) X-Ref |
| Loads the kind entities into the store. return: {Array} Entities param: {string} kind Kind |
| reducer_ownKeys(object, enumerableOnly) X-Ref |
| No description |
| reducer_objectSpread(target) 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. |
| reducer_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. |
| build_module_reducer_ownKeys(object, enumerableOnly) X-Ref |
| No description |
| build_module_reducer_objectSpread(target) X-Ref |
| No description |
| 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. |
| reducer_users() X-Ref |
| Reducer managing authors state. Keyed by id. return: {Object} Updated state. param: {Object} state Current state. param: {Object} action Dispatched action. |
| reducer_currentUser() X-Ref |
| Reducer managing current user state. return: {Object} Updated state. param: {Object} state Current state. param: {Object} action Dispatched action. |
| reducer_taxonomies() X-Ref |
| Reducer managing taxonomies. return: {Object} Updated state. param: {Object} state Current state. param: {Object} action Dispatched action. |
| themeSupports() X-Ref |
| Reducer managing theme supports data. return: {Object} Updated state. param: {Object} state Current state. param: {Object} action Dispatched action. |
| reducer_entity(entityConfig) X-Ref |
| Higher Order Reducer for a given entity config. It supports: - Fetching - Editing - Saving return: {Function} 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 |
| No description |
| 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. |
| reducer_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. |
| selectors_ownKeys(object, enumerableOnly) X-Ref |
| No description |
| selectors_objectSpread(target) X-Ref |
| No description |
| getAuthors(state) X-Ref |
| Returns all available authors. return: {Array} Authors list. param: {Object} state Data state. |
| getCurrentUser(state) X-Ref |
| Returns the current user. return: {Object} Current user object. param: {Object} state Data state. |
| getEntitiesByKind(state, kind) X-Ref |
| Returns whether the entities for the give kind are loaded. return: {boolean} Whether the entities are loaded param: {Object} state Data state. param: {string} kind Entity kind. |
| selectors_getEntity(state, kind, name) X-Ref |
| Returns the entity object given its kind and name. return: {Object} Entity param: {Object} state Data state. param: {string} kind Entity kind. param: {string} name Entity name. |
| getEntityRecord(state, kind, name, key) X-Ref |
| Returns the Entity's record object by key. return: {Object?} Record. param: {Object} state State tree param: {string} kind Entity kind. param: {string} name Entity name. param: {number} key Record's key |
| __experimentalGetEntityRecordNoResolver(state, kind, name, key) X-Ref |
| Returns the Entity's record object by key. Doesn't trigger a resolver nor requests the entity from the API if the entity record isn't available in the local state. return: {Object?} Record. param: {Object} state State tree param: {string} kind Entity kind. param: {string} name Entity name. param: {number} key Record's key |
| 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} 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} 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. |
| 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. |
| 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. |
| hasUploadPermissions(state) X-Ref |
| Returns whether the current user can upload media. Calling this may trigger an OPTIONS request to the REST API via the `canUser()` resolver. https://developer.wordpress.org/rest-api/reference/ return: {boolean} Whether or not the user can upload media. Defaults to `true` if the OPTIONS param: {Object} state Data state. |
| 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. |
| 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. |
| resolvers_ownKeys(object, enumerableOnly) X-Ref |
| No description |
| resolvers_objectSpread(target) X-Ref |
| No description |
| resolvers_getAuthors() X-Ref |
| Requests authors from the REST API. |
| resolvers_getCurrentUser() X-Ref |
| Requests the current user from the REST API. |
| resolvers_getEntityRecord(kind, name) X-Ref |
| Requests an entity's record from the REST API. param: {string} kind Entity kind. param: {string} name Entity name. param: {number} key Record's key |
| resolvers_getEntityRecords(kind, name) X-Ref |
| Requests the entity's records from the REST API. param: {string} kind Entity kind. param: {string} name Entity name. param: {Object?} query Query Object. |
| resolvers_getThemeSupports() X-Ref |
| Requests theme supports data from the index. |
| resolvers_getEmbedPreview(url) X-Ref |
| Requests a preview from the from the Embed API. param: {string} url URL to get the preview for. |
| resolvers_hasUploadPermissions() X-Ref |
| Requests Upload Permissions from the REST API. |
| resolvers_canUser(action, resource, id) X-Ref |
| Checks whether the current user can perform the given action on the given REST resource. param: {string} action Action to check. One of: 'create', 'read', 'update', param: {string} resource REST resource to check, e.g. 'media' or 'posts'. param: {?string} id ID of the rest resource to check. |
| resolvers_getAutosaves(postType, postId) X-Ref |
| Request autosave data from the REST API. param: {string} postType The type of the parent post. param: {number} postId The id of the parent post. |
| resolvers_getAutosave(postType, postId) X-Ref |
| Request autosave data from the REST API. This resolver exists to ensure the underlying autosaves are fetched via `getAutosaves` when a call to the `getAutosave` selector is made. param: {string} postType The type of the parent post. param: {number} postId The id of the parent post. |
| entity_provider_ownKeys(object, enumerableOnly) X-Ref |
| No description |
| entity_provider_objectSpread(target) X-Ref |
| No description |
| EntityProvider(_ref) X-Ref |
| Context provider component for providing an entity for a specific entity type. 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 type. param: {number} props.id The entity ID. param: {*} props.children The children to wrap. |
| useEntityId(kind, type) X-Ref |
| Hook that returns the ID for the nearest provided entity of the specified type. param: {string} kind The entity kind. param: {string} type The entity type. |
| useEntityProp(kind, type, prop) 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]} A tuple where the first item is the param: {string} kind The entity kind. param: {string} type The entity type. param: {string} prop The property name. |
| useEntityBlockEditor(kind, type) 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} type The entity type. param: {Object} options param: {Object} [options.initialEdits] Initial edits object for the entity record. param: {string} [options.blocksProp='blocks'] The name of the entity prop that holds the blocks array. param: {string} [options.contentProp='content'] The name of the entity prop that holds the serialized blocks. |
| build_module_ownKeys(object, enumerableOnly) X-Ref |
| No description |
| build_module_objectSpread(target) X-Ref |
| No description |
| _defineProperty(obj, key, value) X-Ref |
| No description |
| _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 |
| Generated : Wed Apr 1 08:20:01 2020 | Cross-referenced by PHPXref |