Add initial API to register patterns from themes and plugins #21074
Conversation
youknowriad
added
[Type] New API
youknowriad
requested review from
ajitbohra,
chrisvanpatten,
mkaz and
TimothyBJacobs
as code owners
youknowriad
added
the
[Feature] Extensibility
youknowriad
force-pushed
the
add/api-patterns
branch
from
ca8fd6f
to
a199ca5
Compare
|
Size Change: +545 B (0%) Total Size: 857 kB
ℹ️ View Unchanged
|
| @@ -0,0 +1,35 @@ | |||
| # Patterns | |||
|
|
|||
There was a problem hiding this comment.
Let's add a disclaimer that this are is still under active development.
There was a problem hiding this comment.
Thinking of adding __experimental prefix as well.
docs/designers-developers/developers/block-api/block-patterns.md
Outdated
Show resolved
Hide resolved
docs/designers-developers/developers/block-api/block-patterns.md
Outdated
Show resolved
Hide resolved
Co-Authored-By: Alex Kirk <akirk@users.noreply.github.com>
docs/designers-developers/developers/block-api/block-patterns.md
Outdated
Show resolved
Hide resolved
Co-Authored-By: Alex Kirk <akirk@users.noreply.github.com>
| /* | ||
| * Register default patterns if not registered in Core already. | ||
| */ | ||
| if ( ! WP_Patterns_Registry::get_instance()->is_registered( 'text-two-columns' ) ) { | ||
| register_pattern( 'core/text-two-columns', gutenberg_load_block_pattern( 'text-two-columns' ) ); | ||
| register_pattern( 'core/two-buttons', gutenberg_load_block_pattern( 'two-buttons' ) ); | ||
| register_pattern( 'core/cover-abc', gutenberg_load_block_pattern( 'cover-abc' ) ); | ||
| register_pattern( 'core/two-images', gutenberg_load_block_pattern( 'two-images' ) ); | ||
| } |
There was a problem hiding this comment.
This is problematic for the plugin build.
See:
| function register_pattern( $pattern_name, $pattern_properties ) { | ||
| return WP_Patterns_Registry::get_instance()->register( $pattern_name, $pattern_properties ); | ||
| } |
There was a problem hiding this comment.
Would it be better to have named this as specific to blocks: register_block_pattern ?
Same goes for:
unregister_patternWP_Patterns_Registry
When considering the WordPress function API broadly, it's not obvious by these names they have anything to do with blocks.
There was a problem hiding this comment.
I think it was decided to name these "Patterns" and not "Block Patterns". cc @mtias
|
Few suggestions:
More on #3. You are using the html code from the command: |
|
I am concerned about the names of the PHP functions being suggested. Without a meaningful descriptor, they go against the function naming guidelines:
This is because, in WordPress, a "pattern" could be many things or it could be nothing. https://make.wordpress.org/core/2020/03/26/whats-new-in-gutenberg-25-march/#comment-38306
In short:
|
|
I can't seem to find where this was discussed right now, but it was and I believe we settled on "Patterns" over "Block Patterns" and I believe the function names should follow the actual naming of the concepts in the UI otherwise it gets confusing, feel free to open an issue to rediscuss this more largely though. |
|
I think calling the function |
The API looks like this:
register_pattern( 'my-plugin/my-awesome-pattern', array( 'title' => __( 'Two buttons' ), 'content' => "<!-- wp:buttons {\"align\":\"center\"} -->\n<div class=\"wp-block-buttons aligncenter\"><!-- wp:button {\"backgroundColor\":\"very-dark-gray\",\"borderRadius\":0} -->\n<div class=\"wp-block-button\"><a class=\"wp-block-button__link has-background has-very-dark-gray-background-color no-border-radius\">Button One</a></div>\n<!-- /wp:button -->\n\n<!-- wp:button {\"textColor\":\"very-dark-gray\",\"borderRadius\":0,\"className\":\"is-style-outline\"} -->\n<div class=\"wp-block-button is-style-outline\"><a class=\"wp-block-button__link has-text-color has-very-dark-gray-color no-border-radius\">Button Two</a></div>\n<!-- /wp:button --></div>\n<!-- /wp:buttons -->", ) );