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.

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

Block API: Render alias block with canonical block class name #6582

Draft
wants to merge 1 commit into
base: trunk
Choose a base branch
from

Conversation

tjcafferkey
Copy link

@tjcafferkey tjcafferkey commented May 20, 2024

Trac ticket:

Consider the following markup:

<!-- wp:social-links -->
<ul class="wp-block-social-links">
	<!-- wp:social-link {"url":"Tumblr.com","service":"tumblr"} /-->
	<!-- wp:core/social-link/wordpress {"url":"wordpress.com","service":"wordpress"} /-->
</ul>
<!-- /wp:social-links -->

The second social link has an alias core/social-link/wordpress which we need to render correctly on the frontend with the correct CSS class names.

All WP_Block_Type's are registered under their canonical form, meaning aliases are not in the registry. So when we are rendering an alias block type we need to know what the alias is so we can generate the appropriate class names for it, for the above mark up this would be: wp-social-link wp-social-link-wordpress wp-block-social-link.

This PR uses a new utility function to check if the block name we are generating a class name for is a variation (e.g. has an alias) or not and if so we generate an additional CSS class for the canonical block name.


This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

@tjcafferkey tjcafferkey changed the title Block API: Render canonical block with class name May 20, 2024
@@ -54,6 +54,11 @@ function wp_apply_generated_classname_support( $block_type ) {
if ( $has_generated_classname_support ) {
$block_classname = wp_get_block_default_classname( $block_type->name );

// If the block is a variation and thus has an alias, generate a classname based on the canonical block name.
if ( block_is_variation( $block_type->name ) ) {
Copy link
Author

Choose a reason for hiding this comment

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

Maybe instead of amending the WP_Block_Type_Registry->get_registered() method to derive the canonical block name, we should do it here? I'm not sure.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
1 participant