Skip to content

Revisions: Fix template revisions retrieval and sorting #76760

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ellatrix merged 1 commit into from
Mar 26, 2026
Merged

Revisions: Fix template revisions retrieval and sorting #76760

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 29 additions & 7 deletions packages/editor/src/components/post-revisions-preview/revisions-slider.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,23 @@ function RevisionsSlider() {
}

const entityConfig = getEntityConfig( 'postType', postType );
const _revisionKey = entityConfig?.revisionKey || 'id';
const query = {
per_page: -1,
context: 'edit',
_fields:
'id,date,author,meta,title.raw,excerpt.raw,content.raw',
_fields: [
...new Set( [
'id',
'date',
'modified',
'author',
'meta',
'title.raw',
'excerpt.raw',
'content.raw',
_revisionKey,
] ),
].join(),
};
return {
revisions: getRevisions( 'postType', postType, postId, query ),
Expand All @@ -52,22 +64,29 @@ function RevisionsSlider() {
currentRevisionId: unlock(
select( editorStore )
).getCurrentRevisionId(),
revisionKey: entityConfig?.revisionKey || 'id',
revisionKey: _revisionKey,
};
},
[]
);

const { setCurrentRevisionId } = unlock( useDispatch( editorStore ) );

// Template revisions use the template REST API format, which exposes
// 'modified' instead of 'date'.
const revisionDateField = revisionKey === 'wp_id' ? 'modified' : 'date';
Comment on lines +75 to +77
Copy link
Copy Markdown
Contributor Author

@t-hamano t-hamano Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Strictly speaking, I believe template revisions were not working correctly even before #76347 was merged, as they were not referencing the modified field.

Copy link
Copy Markdown
Member

@ellatrix ellatrix Mar 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's kind of weird that template revisions are doing something different.


const sortedRevisions = useMemo( () => {
return (
revisions
?.slice()
.sort( ( a, b ) => new Date( a.date ) - new Date( b.date ) ) ??
[]
.sort(
( a, b ) =>
new Date( a[ revisionDateField ] ) -
new Date( b[ revisionDateField ] )
) ?? []
);
}, [ revisions ] );
}, [ revisions, revisionDateField ] );

const selectedIndex = sortedRevisions.findIndex(
( r ) => r[ revisionKey ] === currentRevisionId
Expand All @@ -87,7 +106,10 @@ function RevisionsSlider() {
if ( ! revision ) {
return index;
}
return dateI18n( dateSettings.formats.datetime, revision.date );
return dateI18n(
dateSettings.formats.datetime,
revision[ revisionDateField ]
);
};

if ( isLoading ) {
Expand Down
27 changes: 24 additions & 3 deletions packages/editor/src/store/private-actions.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -627,6 +627,11 @@ export const restoreRevision =
const postType = select.getCurrentPostType();
const postId = select.getCurrentPostId();

const entityConfig = registry
.select( coreStore )
.getEntityConfig( 'postType', postType );
const revisionKey = entityConfig?.revisionKey || 'id';

// Use resolveSelect to ensure the revision is fetched if not yet
// in the store. The _fields parameter matches the query used by
// getRevisions so the result is served from cache without an
Expand All @@ -635,8 +640,19 @@ export const restoreRevision =
.resolveSelect( coreStore )
.getRevision( 'postType', postType, postId, revisionId, {
context: 'edit',
_fields:
'id,date,author,meta,title.raw,excerpt.raw,content.raw',
_fields: [
...new Set( [
'id',
'date',
'modified',
'author',
'meta',
'title.raw',
'excerpt.raw',
'content.raw',
revisionKey,
] ),
].join(),
} );

if ( ! revision ) {
Expand Down Expand Up @@ -672,7 +688,12 @@ export const restoreRevision =
sprintf(
/* translators: %s: Date and time of the revision. */
__( 'Restored to revision from %s.' ),
dateI18n( getDateSettings().formats.datetime, revision.date )
dateI18n(
getDateSettings().formats.datetime,
// Template revisions use the template REST API format, which
// exposes 'modified' instead of 'date'.
revisionKey === 'wp_id' ? revision.modified : revision.date
)
),
{
type: 'snackbar',
Expand Down
62 changes: 46 additions & 16 deletions packages/editor/src/store/private-selectors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -390,6 +390,11 @@ export const getCurrentRevision = createRegistrySelector(
}

const { type: postType, id: postId } = getCurrentPost( state );
const entityConfig = select( coreStore ).getEntityConfig(
'postType',
postType
);
const revisionKey = entityConfig?.revisionKey || 'id';
// - Use getRevisions (plural) instead of getRevision (singular) to
// avoid a race condition where both API calls complete around the
// same time and the single revision fetch overwrites the list in the
Expand All @@ -404,19 +409,27 @@ export const getCurrentRevision = createRegistrySelector(
{
per_page: -1,
context: 'edit',
_fields:
'id,date,author,meta,title.raw,excerpt.raw,content.raw',
_fields: [
...new Set( [
'id',
'date',
'modified',
'author',
'meta',
'title.raw',
'excerpt.raw',
'content.raw',
revisionKey,
] ),
].join(),
}
);
if ( ! revisions ) {
return null;
}
const entityConfig = select( coreStore ).getEntityConfig(
'postType',
postType
return (
revisions.find( ( r ) => r[ revisionKey ] === revisionId ) ?? null
);
const revKey = entityConfig?.revisionKey || 'id';
return revisions.find( ( r ) => r[ revKey ] === revisionId ) ?? null;
}
);

Expand Down Expand Up @@ -457,34 +470,51 @@ export const getPreviousRevision = createRegistrySelector(
}

const { type: postType, id: postId } = getCurrentPost( state );
const entityConfig = select( coreStore ).getEntityConfig(
'postType',
postType
);
const revisionKey = entityConfig?.revisionKey || 'id';
const revisions = select( coreStore ).getRevisions(
'postType',
postType,
postId,
{
per_page: -1,
context: 'edit',
_fields:
'id,date,author,meta,title.raw,excerpt.raw,content.raw',
_fields: [
...new Set( [
'id',
'date',
'modified',
'author',
'meta',
'title.raw',
'excerpt.raw',
'content.raw',
revisionKey,
] ),
].join(),
}
);
if ( ! revisions ) {
return null;
}

// Template revisions use the template REST API format, which exposes
// 'modified' instead of 'date'. Regular post revisions use 'date'.
const revisionDateField = revisionKey === 'wp_id' ? 'modified' : 'date';

// Sort by date ascending (oldest first).
const sortedRevisions = [ ...revisions ].sort(
( a, b ) => new Date( a.date ) - new Date( b.date )
( a, b ) =>
new Date( a[ revisionDateField ] ) -
new Date( b[ revisionDateField ] )
);

// Find current revision index.
const entityConfig = select( coreStore ).getEntityConfig(
'postType',
postType
);
const revKey = entityConfig?.revisionKey || 'id';
const currentIndex = sortedRevisions.findIndex(
( r ) => r[ revKey ] === currentRevisionId
( r ) => r[ revisionKey ] === currentRevisionId
);

// Return the previous revision (older one) if it exists.
Expand Down
Loading