Skip to content
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

Navigation: Don't create duplicate wp_navigation CPTs when updating inner blocks #48587

Closed
wants to merge 3 commits into from
Closed

Navigation: Don't create duplicate wp_navigation CPTs when updating inner blocks #48587

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3be217d
Navigation: Don't create a fallback navigation menu if there are inne…
scruffian Feb 28, 2023
8b2b205
move const declarations higher
scruffian Feb 28, 2023
25a9a0d
Navigation: Don't create duplicate navigation menus when creating new…
scruffian Feb 28, 2023
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
29 changes: 16 additions & 13 deletions packages/block-library/src/navigation/edit/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,14 +275,27 @@ function Navigation( {
isCreatingNavigationMenu,
fallbackNavigationMenus,
hasUncontrolledInnerBlocks,
createNavigationMenuIsSuccess,
] );

const isEntityAvailable =
! isNavigationMenuMissing && isNavigationMenuResolved;

// If the block has inner blocks, but no menu id, then these blocks are either:
// - inserted via a pattern.
// - inserted directly via Code View (or otherwise).
// - from an older version of navigation block added before the block used a wp_navigation entity.
// Consider this state as 'unsaved' and offer an uncontrolled version of inner blocks,
// that automatically saves the menu as an entity when changes are made to the inner blocks.
const hasUnsavedBlocks = hasUncontrolledInnerBlocks && ! isEntityAvailable;

useEffect( () => {
if (
ref ||
! hasResolvedNavigationMenus ||
isConvertingClassicMenu ||
fallbackNavigationMenus?.length > 0
fallbackNavigationMenus?.length > 0 ||
hasUnsavedBlocks
) {
return;
}
Expand Down Expand Up @@ -323,13 +336,14 @@ function Navigation( {
if ( getBlockType( 'core/page-list' ) ) {
defaultBlocks = [ createBlock( 'core/page-list' ) ];
}

createNavigationMenu(
'Navigation', // TODO - use the template slug in future
defaultBlocks,
'publish'
);
}
}, [ hasResolvedNavigationMenus ] );
}, [ hasResolvedNavigationMenus, hasUnsavedBlocks ] );

const navRef = useRef();

Expand All @@ -349,9 +363,6 @@ function Navigation( {
classicMenus?.length === 0 &&
! hasUncontrolledInnerBlocks;

const isEntityAvailable =
! isNavigationMenuMissing && isNavigationMenuResolved;

// "loading" state:
// - there is a menu creation process in progress.
// - there is a classic menu conversion process in progress.
Expand Down Expand Up @@ -726,14 +737,6 @@ function Navigation( {
</>
);

// If the block has inner blocks, but no menu id, then these blocks are either:
// - inserted via a pattern.
// - inserted directly via Code View (or otherwise).
// - from an older version of navigation block added before the block used a wp_navigation entity.
// Consider this state as 'unsaved' and offer an uncontrolled version of inner blocks,
// that automatically saves the menu as an entity when changes are made to the inner blocks.
const hasUnsavedBlocks = hasUncontrolledInnerBlocks && ! isEntityAvailable;

const isManageMenusButtonDisabled =
! hasManagePermissions || ! hasResolvedNavigationMenus;

Expand Down
11 changes: 10 additions & 1 deletion packages/block-library/src/navigation/edit/unsaved-inner-blocks.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,11 @@ export default function UnsavedInnerBlocks( {

const { hasResolvedNavigationMenus } = useNavigationMenu();

// We need to use a ref to track whether the effect has been called.
// Otherwise the effect will be called when blocks changes, which
// happens faster than the state of navigation menu creation is updated.
const createNavigationEffectCalled = useRef( false );

// Automatically save the uncontrolled blocks.
useEffect( () => {
// The block will be disabled when used in a BlockPreview.
Expand All @@ -139,11 +144,14 @@ export default function UnsavedInnerBlocks( {
! hasResolvedDraftNavigationMenus ||
! hasResolvedNavigationMenus ||
! hasSelection ||
! innerBlocksAreDirty
! innerBlocksAreDirty ||
createNavigationEffectCalled.current
) {
return;
}

// Setting this to true so that this effect is only called once.
createNavigationEffectCalled.current = true;
createNavigationMenu( null, blocks );
}, [
blocks,
Expand All @@ -154,6 +162,7 @@ export default function UnsavedInnerBlocks( {
hasResolvedNavigationMenus,
innerBlocksAreDirty,
hasSelection,
createNavigationEffectCalled,
] );

const Wrapper = isSaving ? Disabled : 'div';
Expand Down
4 changes: 2 additions & 2 deletions packages/block-library/src/navigation/index.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -446,8 +446,8 @@ function block_core_navigation_get_default_pages_fallback() {
$wp_insert_post_result = wp_insert_post(
array(
'post_content' => $default_blocks,
'post_title' => 'Navigation', // TODO - use the template slug in future.
'post_name' => 'Navigation', // TODO - use the template slug in future.
'post_title' => 'Navigation PHP', // TODO - use the template slug in future.
'post_name' => 'Navigation PHP', // TODO - use the template slug in future.
'post_status' => 'publish',
'post_type' => 'wp_navigation',
),
Expand Down