Skip to content

Pages: Add "Set as posts page" action #67650

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
mikachan merged 18 commits into from
Dec 13, 2024
Merged

Pages: Add "Set as posts page" action #67650

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
57ec70f
Move getItemTitle to its own file
mikachan Dec 5, 2024
fbc91d7
Add unset homepage action
mikachan Dec 5, 2024
d42e0c1
Add unset as posts page action
mikachan Dec 5, 2024
4a90867
Add set as posts page action
mikachan Dec 5, 2024
4b29bcb
Update homepage action tests
mikachan Dec 5, 2024
d892300
Rename unset options to reset
mikachan Dec 5, 2024
f68a189
Reword posts page reset notice
mikachan Dec 5, 2024
4ac3a3c
Merge branch 'trunk' into add/more-homepage-actions
mikachan Dec 6, 2024
2cc8058
Ensure Move to trash is always at end of list
mikachan Dec 6, 2024
61c7d48
Update packages/editor/src/components/post-actions/actions.js
mikachan Dec 10, 2024
711f65c
Update packages/editor/src/components/post-actions/reset-homepage.js
mikachan Dec 10, 2024
30a7f2a
Remove getItemTitle from utils index.js
mikachan Dec 10, 2024
7a775e4
Merge branch 'trunk' into add/more-homepage-actions
mikachan Dec 11, 2024
8ef850c
Remove reset actions
mikachan Dec 11, 2024
bc1b218
Slight refactor to modal warning in set as posts page action
mikachan Dec 11, 2024
2cfd817
Remove use of saveEditedEntityRecord
mikachan Dec 11, 2024
f60fa36
Check for currentPostsPage before setting modalwarning
mikachan Dec 12, 2024
35cea15
Add full stop to action success notices
mikachan Dec 12, 2024
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
Prev Previous commit
Next Next commit
Rename unset options to reset
  • Loading branch information
@mikachan
mikachan committed Dec 5, 2024
commit d892300b51b0b4cecdbe9a1ab8e510ede76f15e3
16 changes: 8 additions & 8 deletions packages/editor/src/components/post-actions/actions.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ import { store as coreStore } from '@wordpress/core-data';
import { store as editorStore } from '../../store';
import { unlock } from '../../lock-unlock';
import { useSetAsHomepageAction } from './set-as-homepage';
import { useUnsetAsHomepageAction } from './unset-as-homepage';
import { useResetHomepageAction } from './reset-homepage';
import { useSetAsPostsPageAction } from './set-as-posts-page';
import { useUnsetAsPostsPageAction } from './unset-as-posts-page';
import { useResetPostsPageAction } from './reset-posts-page';

export function usePostActions( { postType, onActionPerformed, context } ) {
const { defaultActions } = useSelect(
Expand Down Expand Up @@ -46,9 +46,9 @@ export function usePostActions( { postType, onActionPerformed, context } ) {
);

const setAsHomepageAction = useSetAsHomepageAction();
const unsetAsHomepageAction = useUnsetAsHomepageAction();
const resetHomepageAction = useResetHomepageAction();
const setAsPostsPageAction = useSetAsPostsPageAction();
const unsetAsPostsPageAction = useUnsetAsPostsPageAction();
const resetPostsPageAction = useResetPostsPageAction();
const shouldShowHomepageActions =
canManageOptions && ! hasFrontPageTemplate;

Expand All @@ -62,9 +62,9 @@ export function usePostActions( { postType, onActionPerformed, context } ) {
if ( shouldShowHomepageActions ) {
actions.push(
setAsHomepageAction,
unsetAsHomepageAction,
resetHomepageAction,
setAsPostsPageAction,
unsetAsPostsPageAction
resetPostsPageAction
);
}

Expand Down Expand Up @@ -133,10 +133,10 @@ export function usePostActions( { postType, onActionPerformed, context } ) {
context,
defaultActions,
onActionPerformed,
resetHomepageAction,
resetPostsPageAction,
setAsHomepageAction,
setAsPostsPageAction,
shouldShowHomepageActions,
unsetAsHomepageAction,
unsetAsPostsPageAction,
] );
}
61 changes: 24 additions & 37 deletions ...ponents/post-actions/unset-as-homepage.js → ...components/post-actions/reset-homepage.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,36 +18,25 @@ import { store as noticesStore } from '@wordpress/notices';
*/
import { getItemTitle } from '../../utils';

const UnsetAsHomepageModal = ( { items, closeModal } ) => {
const ResetHomepageModal = ( { items, closeModal } ) => {
const [ item ] = items;
const pageTitle = getItemTitle( item );
const { isPageForPostsSet, currentHomePage, isSaving } = useSelect(
( select ) => {
const { getEntityRecord, isSavingEntityRecord } =
select( coreStore );
const siteSettings = getEntityRecord( 'root', 'site' );
const currentHomePageItem = getEntityRecord(
'postType',
'page',
siteSettings?.page_on_front
);
return {
isPageForPostsSet: siteSettings?.page_for_posts !== 0,
currentHomePage: currentHomePageItem,
isSaving: isSavingEntityRecord( 'root', 'site' ),
};
}
);
const currentHomePageTitle = currentHomePage
? getItemTitle( currentHomePage )
: '';
const { isPageForPostsSet, isSaving } = useSelect( ( select ) => {
const { getEntityRecord, isSavingEntityRecord } = select( coreStore );
const siteSettings = getEntityRecord( 'root', 'site' );

return {
isPageForPostsSet: siteSettings?.page_for_posts !== 0,
isSaving: isSavingEntityRecord( 'root', 'site' ),
};
} );

const { saveEditedEntityRecord, saveEntityRecord } =
useDispatch( coreStore );
const { createSuccessNotice, createErrorNotice } =
useDispatch( noticesStore );

async function onUnsetPageAsHomepage( event ) {
async function onResetHomepage( event ) {
event.preventDefault();

try {
Expand All @@ -65,15 +54,15 @@ const UnsetAsHomepageModal = ( { items, closeModal } ) => {
show_on_front: isPageForPostsSet ? 'page' : 'posts',
} );

createSuccessNotice( __( 'Homepage unset' ), {
createSuccessNotice( __( 'Homepage reset' ), {
type: 'snackbar',
} );
} catch ( error ) {
const typedError = error;
const errorMessage =
typedError.message && typedError.code !== 'unknown_error'
? typedError.message
: __( 'An error occurred while unsetting the homepage' );
: __( 'An error occurred while resetting the homepage' );
createErrorNotice( errorMessage, { type: 'snackbar' } );
} finally {
closeModal?.();
Expand All @@ -82,24 +71,22 @@ const UnsetAsHomepageModal = ( { items, closeModal } ) => {

const modalWarning = ! isPageForPostsSet
? __( 'This will set the homepage to display latest posts.' )
: sprintf(
// translators: %s: title of the current home page.
__( 'This will replace the current homepage: "%s"' ),
currentHomePageTitle
);
: '';

const modalText = sprintf(
// translators: %1$s: title of the page to be unset as the homepage, %2$s: homepage replacement warning message.
__( 'Unset "%1$s" as the site homepage? %2$s' ),
__(
'Reset the site homepage? "%1$s" will no longer be set as the homepage. %2$s'
),
pageTitle,
modalWarning
);

// translators: Button label to confirm unsetting the specified page as the homepage.
const modalButtonLabel = __( 'Unset as homepage' );
// translators: Button label to confirm resetting the homepage.
const modalButtonLabel = __( 'Reset homepage' );

return (
<form onSubmit={ onUnsetPageAsHomepage }>
<form onSubmit={ onResetHomepage }>
<VStack spacing="5">
<Text>{ modalText }</Text>
<HStack justify="right">
Expand Down Expand Up @@ -129,7 +116,7 @@ const UnsetAsHomepageModal = ( { items, closeModal } ) => {
);
};

export const useUnsetAsHomepageAction = () => {
export const useResetHomepageAction = () => {
const { pageOnFront } = useSelect( ( select ) => {
const { getEntityRecord } = select( coreStore );
const siteSettings = getEntityRecord( 'root', 'site' );
Expand All @@ -140,16 +127,16 @@ export const useUnsetAsHomepageAction = () => {

return useMemo(
() => ( {
id: 'unset-as-homepage',
label: __( 'Unset as homepage' ),
id: 'reset-homepage',
label: __( 'Reset homepage' ),
isEligible( post ) {
if ( pageOnFront !== post.id ) {
return false;
}

return true;
},
RenderModal: UnsetAsHomepageModal,
RenderModal: ResetHomepageModal,
} ),
[ pageOnFront ]
);
Expand Down
26 changes: 14 additions & 12 deletions ...nents/post-actions/unset-as-posts-page.js → ...mponents/post-actions/reset-posts-page.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import { store as noticesStore } from '@wordpress/notices';
*/
import { getItemTitle } from '../../utils';

const UnsetAsPostsPageModal = ( { items, closeModal } ) => {
const ResetPostsPageModal = ( { items, closeModal } ) => {
const [ item ] = items;
const pageTitle = getItemTitle( item );
const { isPageOnFrontSet, isSaving } = useSelect( ( select ) => {
Expand All @@ -35,7 +35,7 @@ const UnsetAsPostsPageModal = ( { items, closeModal } ) => {
const { createSuccessNotice, createErrorNotice } =
useDispatch( noticesStore );

async function onUnsetPageAsPostsPage( event ) {
async function onResetPostsPage( event ) {
event.preventDefault();

try {
Expand All @@ -53,15 +53,15 @@ const UnsetAsPostsPageModal = ( { items, closeModal } ) => {
show_on_front: isPageOnFrontSet ? 'page' : 'posts',
} );

createSuccessNotice( __( 'Posts page unset' ), {
createSuccessNotice( __( 'Posts page reset' ), {
type: 'snackbar',
} );
} catch ( error ) {
Copy link
Contributor

@t-hamano t-hamano Dec 10, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Is this exception error actually possible? Because saveEntityRecord doesn't seem to throw any exceptions by default.

https://github.com/WordPress/gutenberg/blob/add/more-homepage-actions/packages/core-data/README.md#saveentityrecord

Copy link
Member Author

@mikachan mikachan Dec 10, 2024

Choose a reason for hiding this comment

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

I think it's nice to have the catch block anyway, to catch any other errors (like a network error maybe). But I completely see your point, I don't think saveEntityRecord throws any exceptions.

const typedError = error;
const errorMessage =
typedError.message && typedError.code !== 'unknown_error'
? typedError.message
: __( 'An error occurred while unsetting the posts page' );
: __( 'An error occurred while resetting the posts page' );
createErrorNotice( errorMessage, { type: 'snackbar' } );
} finally {
closeModal?.();
Expand All @@ -74,16 +74,18 @@ const UnsetAsPostsPageModal = ( { items, closeModal } ) => {

const modalText = sprintf(
// translators: %1$s: title of the page to be unset as the posts page, %2$s: post pages warning message.
__( 'Unset "%1$s" as the posts page? %2$s' ),
__(
'Reset the posts page? "%1$s" will no longer be the posts page. %2$s'
),
pageTitle,
modalWarning
);

// translators: Button label to confirm unsetting the specified page as the posts page.
const modalButtonLabel = __( 'Unset as posts page' );
// translators: Button label to confirm resetting the posts page.
const modalButtonLabel = __( 'Reset posts page' );

return (
<form onSubmit={ onUnsetPageAsPostsPage }>
<form onSubmit={ onResetPostsPage }>
<VStack spacing="5">
<Text>{ modalText }</Text>
<HStack justify="right">
Expand Down Expand Up @@ -113,7 +115,7 @@ const UnsetAsPostsPageModal = ( { items, closeModal } ) => {
);
};

export const useUnsetAsPostsPageAction = () => {
export const useResetPostsPageAction = () => {
const { pageForPosts } = useSelect( ( select ) => {
const { getEntityRecord } = select( coreStore );
const siteSettings = getEntityRecord( 'root', 'site' );
Expand All @@ -124,16 +126,16 @@ export const useUnsetAsPostsPageAction = () => {

return useMemo(
() => ( {
id: 'unset-as-posts-page',
label: __( 'Unset as posts page' ),
id: 'reset-posts-page',
label: __( 'Reset posts page' ),
isEligible( post ) {
if ( pageForPosts !== post.id ) {
return false;
}

return true;
},
RenderModal: UnsetAsPostsPageModal,
RenderModal: ResetPostsPageModal,
} ),
[ pageForPosts ]
);
Expand Down
4 changes: 2 additions & 2 deletions test/e2e/specs/site-editor/homepage-settings.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ test.describe( 'Homepage Settings via Editor', () => {
page.getByRole( 'menuitem', { name: 'Set as posts page' } )
).toBeHidden();
await expect(
page.getByRole( 'menuitem', { name: 'Unset as homepage' } )
page.getByRole( 'menuitem', { name: 'Reset homepage' } )
).toBeVisible();

const samplePageTwo = page
Expand All @@ -110,7 +110,7 @@ test.describe( 'Homepage Settings via Editor', () => {
page.getByRole( 'menuitem', { name: 'Set as posts page' } )
).toBeHidden();
await expect(
page.getByRole( 'menuitem', { name: 'Unset as posts page' } )
page.getByRole( 'menuitem', { name: 'Reset posts page' } )
).toBeVisible();
} );
} );
Loading