-
Notifications
You must be signed in to change notification settings - Fork 4.7k
Adds block supports for metadata #43986
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.
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
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next
Next commit
Adds metadata supports
- Loading branch information
commit b71c06cfbef272fdee0f3c652aa44e39197325c7
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| /** | ||
| * WordPress dependencies | ||
| */ | ||
| import { addFilter } from '@wordpress/hooks'; | ||
| /** | ||
| * Internal dependencies | ||
| */ | ||
| import { hasBlockMetadataSupport } from './metadata'; | ||
|
|
||
| /** | ||
| * Filters registered block settings, adding an `__experimentalLabel` callback if one does not already exist. | ||
| * | ||
| * @param {Object} settings Original block settings. | ||
| * | ||
| * @return {Object} Filtered block settings. | ||
| */ | ||
| export function addLabelCallback( settings ) { | ||
| // If blocks provide their own label callback, do not override it. | ||
| if ( settings.__experimentalLabel ) { | ||
| return settings; | ||
| } | ||
|
|
||
| const supportsBlockNaming = hasBlockMetadataSupport( | ||
| settings, | ||
| 'name', | ||
| false | ||
getdave marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ); | ||
|
|
||
| // Check whether block metadata is supported before using it. | ||
| if ( supportsBlockNaming ) { | ||
| settings.__experimentalLabel = ( attributes, { context } ) => { | ||
| const { metadata } = attributes; | ||
|
|
||
| // In the list view, use the block's name sattribute as the label. | ||
getdave marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| if ( context === 'list-view' && metadata?.name ) { | ||
| return metadata.name; | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| return settings; | ||
| } | ||
|
|
||
| addFilter( | ||
| 'blocks.registerBlockType', | ||
| 'core/metadata/addLabelCallback', | ||
| addLabelCallback | ||
| ); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| /** | ||
| * WordPress dependencies | ||
| */ | ||
| import { addFilter } from '@wordpress/hooks'; | ||
| import { getBlockSupport } from '@wordpress/blocks'; | ||
|
|
||
| const META_ATTRIBUTE_NAME = 'metadata'; | ||
|
|
||
| export function hasBlockMetadataSupport( blockType, feature = '' ) { | ||
| const support = getBlockSupport( blockType, '__experimentalMetadata' ); | ||
| return !! ( true === support || support?.[ feature ] ); | ||
| } | ||
|
|
||
| /** | ||
| * Filters registered block settings, extending attributes to include `metadata`. | ||
| * | ||
| * see: https://github.com/WordPress/gutenberg/pull/40393/files#r864632012 | ||
| * | ||
| * @param {Object} blockTypeSettings Original block settings. | ||
| * @return {Object} Filtered block settings. | ||
| */ | ||
| export function addMetaAttribute( blockTypeSettings ) { | ||
| // Allow blocks to specify their own attribute definition with default values if needed. | ||
| if ( blockTypeSettings?.attributes?.[ META_ATTRIBUTE_NAME ]?.type ) { | ||
| return blockTypeSettings; | ||
| } | ||
|
|
||
| const supportsBlockNaming = hasBlockMetadataSupport( | ||
| blockTypeSettings, | ||
| 'name', | ||
| false | ||
| ); | ||
|
|
||
| if ( supportsBlockNaming ) { | ||
| blockTypeSettings.attributes = { | ||
| ...blockTypeSettings.attributes, | ||
| [ META_ATTRIBUTE_NAME ]: { | ||
| type: 'object', | ||
| }, | ||
| }; | ||
| } | ||
|
|
||
| return blockTypeSettings; | ||
| } | ||
|
|
||
| export function addSaveProps( extraProps, blockType, attributes ) { | ||
| if ( hasBlockMetadataSupport( blockType ) ) { | ||
| extraProps[ META_ATTRIBUTE_NAME ] = attributes[ META_ATTRIBUTE_NAME ]; | ||
| } | ||
|
|
||
| return extraProps; | ||
| } | ||
|
|
||
| addFilter( | ||
| 'blocks.registerBlockType', | ||
| 'core/metadata/addMetaAttribute', | ||
| addMetaAttribute | ||
| ); | ||
|
|
||
| addFilter( | ||
| 'blocks.getSaveContent.extraProps', | ||
| 'core/metadata/save-props', | ||
| addSaveProps | ||
| ); |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.