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

Jump to bottom

Send registered patterns in HTML and combine them with REST ones #40818

Merged
merged 6 commits into from
May 17, 2022
Merged

Send registered patterns in HTML and combine them with REST ones #40818

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ac88588
Send registered patterns in HTML and combine them with REST ones
jsnajdr May 4, 2022
7768d5b
Fix formatting
jsnajdr May 4, 2022
2200b15
Use the outside_init_only param when getting patterns in edit-site page
jsnajdr May 12, 2022
d64536d
Add patterns to settings only if enabled by filter
jsnajdr May 16, 2022
21da9ea
Remove filter and rename settings fields instead
jsnajdr May 17, 2022
f50c928
Support all settings forms in both WP 5.9 and 6.0
jsnajdr May 17, 2022
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
12 changes: 12 additions & 0 deletions lib/compat/wordpress-5.9/edit-site-page.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,18 @@ static function( $classes ) {
'__unstableHomeTemplate' => gutenberg_resolve_home_template(),
);

/**
* Filter to enable adding non-REST block patterns to editor settings.
*
* @since 6.0.0
*
* @param bool $should_add_to_settings
*/
if ( apply_filters( 'should_add_block_patterns_to_editor_settings', false ) ) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
if ( apply_filters( 'should_add_block_patterns_to_editor_settings', false ) ) {
if ( apply_filters( 'gutenberg_add_block_patterns_to_editor_settings', false ) ) {

🔢 Would need to be renamed throughout

$custom_settings['__experimentalBlockPatterns'] = WP_Block_Patterns_Registry::get_instance()->get_all_registered( true );
$custom_settings['__experimentalBlockPatternCategories'] = WP_Block_Pattern_Categories_Registry::get_instance()->get_all_registered( true );
}

/**
* Make the WP Screen object aware that this is a block editor page.
* Since custom blocks check whether the screen is_block_editor,
Expand Down
15 changes: 1 addition & 14 deletions lib/compat/wordpress-6.0/block-editor-settings.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,17 +194,4 @@ function gutenberg_get_block_editor_settings( $settings ) {

add_filter( 'block_editor_settings_all', 'gutenberg_get_block_editor_settings', PHP_INT_MAX );

/**
* Removes the unwanted block patterns fields from block editor settings.
*
* @param array $settings Existing block editor settings.
*
* @return array New block editor settings.
*/
function gutenberg_remove_block_patterns_settings( $settings ) {
unset( $settings['__experimentalBlockPatterns'] );
unset( $settings['__experimentalBlockPatternCategories'] );
return $settings;
}

add_filter( 'block_editor_settings_all', 'gutenberg_remove_block_patterns_settings', PHP_INT_MAX );
add_filter( 'should_add_block_patterns_to_editor_settings', '__return_true' );
85 changes: 49 additions & 36 deletions packages/edit-site/src/components/block-editor/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
* External dependencies
*/
import classnames from 'classnames';
import { unionBy } from 'lodash';

/**
* WordPress dependencies
*/
import { useSelect, useDispatch } from '@wordpress/data';
import { useCallback, useRef, Fragment } from '@wordpress/element';
import { useCallback, useMemo, useRef, Fragment } from '@wordpress/element';
import { useEntityBlockEditor, store as coreStore } from '@wordpress/core-data';
import {
BlockList,
Expand Down Expand Up @@ -48,44 +49,17 @@ const LAYOUT = {
};

export default function BlockEditor( { setIsInserterOpen } ) {
const { settings } = useSelect(
const { storedSettings, templateType, templateId, page } = useSelect(
( select ) => {
let storedSettings = select( editSiteStore ).getSettings(
setIsInserterOpen
);

if ( ! storedSettings.__experimentalBlockPatterns ) {
storedSettings = {
...storedSettings,
__experimentalBlockPatterns: select(
coreStore
).getBlockPatterns(),
};
}

if ( ! storedSettings.__experimentalBlockPatternCategories ) {
storedSettings = {
...storedSettings,
__experimentalBlockPatternCategories: select(
coreStore
).getBlockPatternCategories(),
};
}

return {
settings: storedSettings,
};
},
[ setIsInserterOpen ]
);

const { templateType, templateId, page } = useSelect(
( select ) => {
const { getEditedPostType, getEditedPostId, getPage } = select(
editSiteStore
);
const {
getSettings,
getEditedPostType,
getEditedPostId,
getPage,
} = select( editSiteStore );

return {
storedSettings: getSettings( setIsInserterOpen ),
templateType: getEditedPostType(),
templateId: getEditedPostId(),
page: getPage(),
Expand All @@ -94,6 +68,45 @@ export default function BlockEditor( { setIsInserterOpen } ) {
[ setIsInserterOpen ]
);

const {
__experimentalBlockPatterns: settingsBlockPatterns,
__experimentalBlockPatternCategories: settingsBlockPatternCategories,
} = storedSettings;

const { restBlockPatterns, restBlockPatternCategories } = useSelect(
( select ) => ( {
restBlockPatterns: select( coreStore ).getBlockPatterns(),
restBlockPatternCategories: select(
coreStore
).getBlockPatternCategories(),
} ),
[]
);

const blockPatterns = useMemo(
() => unionBy( settingsBlockPatterns, restBlockPatterns, 'name' ),
[ settingsBlockPatterns, restBlockPatterns ]
);

const blockPatternCategories = useMemo(
() =>
unionBy(
settingsBlockPatternCategories,
restBlockPatternCategories,
'name'
),
[ settingsBlockPatternCategories, restBlockPatternCategories ]
);

const settings = useMemo(
() => ( {
...storedSettings,
__experimentalBlockPatterns: blockPatterns,
__experimentalBlockPatternCategories: blockPatternCategories,
} ),
[ storedSettings, blockPatterns, blockPatternCategories ]
);

const [ blocks, onInput, onChange ] = useEntityBlockEditor(
'postType',
templateType
Expand Down
30 changes: 22 additions & 8 deletions packages/editor/src/components/provider/use-block-editor-settings.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* External dependencies
*/
import { pick, defaultTo } from 'lodash';
import { pick, defaultTo, unionBy } from 'lodash';

/**
* WordPress dependencies
Expand Down Expand Up @@ -66,15 +66,29 @@ function useBlockEditorSettings( settings, hasTemplate ) {
__experimentalBlockPatternCategories: settingsBlockPatternCategories,
} = settings;

const { blockPatterns, blockPatternCategories } = useSelect(
const { restBlockPatterns, restBlockPatternCategories } = useSelect(
( select ) => ( {
blockPatterns:
settingsBlockPatterns ?? select( coreStore ).getBlockPatterns(),
blockPatternCategories:
settingsBlockPatternCategories ??
select( coreStore ).getBlockPatternCategories(),
restBlockPatterns: select( coreStore ).getBlockPatterns(),
restBlockPatternCategories: select(
coreStore
).getBlockPatternCategories(),
} ),
[ settingsBlockPatterns, settingsBlockPatternCategories ]
[]
);

const blockPatterns = useMemo(
() => unionBy( settingsBlockPatterns, restBlockPatterns, 'name' ),
[ settingsBlockPatterns, restBlockPatterns ]
);

const blockPatternCategories = useMemo(
() =>
unionBy(
settingsBlockPatternCategories,
restBlockPatternCategories,
'name'
),
[ settingsBlockPatternCategories, restBlockPatternCategories ]
);

const { undo } = useDispatch( editorStore );
Expand Down