From 1e21dc3ef4161c9d0c1578ce3fd3aa601687ea05 Mon Sep 17 00:00:00 2001 From: Miguel Fonseca <150562+mcsf@users.noreply.github.com> Date: Fri, 7 Aug 2026 10:07:24 +0100 Subject: [PATCH] Document editEntityRecord's options.isCached param Param added in 2023 in #51644, but docblock forgotten. --- docs/reference-guides/data/data-core.md | 1 + packages/core-data/README.md | 1 + packages/core-data/src/actions.js | 14 +++----------- 3 files changed, 5 insertions(+), 11 deletions(-) diff --git a/docs/reference-guides/data/data-core.md b/docs/reference-guides/data/data-core.md index bd69bebabdd3c2..a6d52f560f4c96 100644 --- a/docs/reference-guides/data/data-core.md +++ b/docs/reference-guides/data/data-core.md @@ -841,6 +841,7 @@ _Parameters_ - _edits_ `Object`: The edits. - _options_ `Object`: Options for the edit. - _options.undoIgnore_ `[boolean]`: Whether to ignore the edit in undo history or not. +- _options.isCached_ `[boolean]`: Whether the edit is transient (e.g. typing). Transient edits are staged and eventually merged into the preceding undo level instead of creating a new one. _Returns_ diff --git a/packages/core-data/README.md b/packages/core-data/README.md index 3feb3f2f97b996..255e1b0acc5ec8 100644 --- a/packages/core-data/README.md +++ b/packages/core-data/README.md @@ -214,6 +214,7 @@ _Parameters_ - _edits_ `Object`: The edits. - _options_ `Object`: Options for the edit. - _options.undoIgnore_ `[boolean]`: Whether to ignore the edit in undo history or not. +- _options.isCached_ `[boolean]`: Whether the edit is transient (e.g. typing). Transient edits are staged and eventually merged into the preceding undo level instead of creating a new one. _Returns_ diff --git a/packages/core-data/src/actions.js b/packages/core-data/src/actions.js index ddc10e6a3d97d0..549eb54a7b1847 100644 --- a/packages/core-data/src/actions.js +++ b/packages/core-data/src/actions.js @@ -1,19 +1,8 @@ -/** - * External dependencies - */ import fastDeepEqual from 'fast-deep-equal/es6/index.js'; import { v4 as uuid } from 'uuid'; - -/** - * WordPress dependencies - */ import apiFetch from '@wordpress/api-fetch'; import { addQueryArgs } from '@wordpress/url'; import deprecated from '@wordpress/deprecated'; - -/** - * Internal dependencies - */ import { clearUnchangedEdits, getNestedValue, setNestedValue } from './utils'; import { receiveItems, removeItems, receiveQueriedItems } from './queried-data'; import { DEFAULT_ENTITY_KEY } from './entities'; @@ -445,6 +434,9 @@ export const deleteEntityRecord = * @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. + * @param {boolean} [options.isCached] Whether the edit is transient (e.g. typing). Transient + * edits are staged and eventually merged into the + * preceding undo level instead of creating a new one. * * @return {Object} Action object. */