-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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
Move the directives and markup needed for the lightbox to block supports #51232
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
00285e8
Move behaviors to block supports
SantosGuillamot 984e0ac
Remove apply from block supports and format PHP
SantosGuillamot 90ed870
Update core-blocks reference docs
SantosGuillamot 326b1d5
Merge branch 'trunk' into update/behaviors-to-block-supports
SantosGuillamot d29fc03
Update latests changes to the image lightbox
SantosGuillamot 0bb0d30
Add comment to explain the priority
SantosGuillamot 55b30c6
Change function name to match patterns
SantosGuillamot 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
There are no files selected for viewing
This file contains 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 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,138 @@ | ||
| <?php | ||
| /** | ||
| * Behaviors block support flag. | ||
| * | ||
| * @package gutenberg | ||
| */ | ||
|
|
||
| /** | ||
| * Registers the behaviors block attribute for block types that support it. | ||
| * And add the needed hooks to add those behaviors. | ||
| * | ||
| * @param WP_Block_Type $block_type Block Type. | ||
| */ | ||
| function gutenberg_register_behaviors_support( $block_type ) { | ||
| $has_behaviors_support = block_has_support( $block_type, array( 'behaviors' ), false ); | ||
| if ( ! $has_behaviors_support ) { | ||
| return; | ||
| } | ||
|
|
||
| if ( ! $block_type->attributes ) { | ||
| $block_type->attributes = array(); | ||
| } | ||
|
|
||
| $block_type->attributes['behaviors'] = array( | ||
| 'type' => 'object', | ||
| ); | ||
|
|
||
| // If it supports the lightbox behavior, add the hook to that block. | ||
| // In the future, this should be a loop with all the behaviors. | ||
| $has_lightbox_support = block_has_support( $block_type, array( 'behaviors', 'lightbox' ), false ); | ||
| if ( $has_lightbox_support ) { | ||
| // Use priority 15 to run this hook after other hooks/plugins. | ||
| // They could use the `render_block_{$this->name}` filter to modify the markup. | ||
| add_filter( 'render_block_' . $block_type->name, 'gutenberg_render_behaviors_support_lightbox', 15, 2 ); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Add the directives and layout needed for the lightbox behavior. | ||
| * This functions shouldn't be in this file. It should be moved to a package (or somewhere else), where all the behaviors logic is defined. | ||
| * | ||
| * @param string $block_content Rendered block content. | ||
| * @param array $block Block object. | ||
| * @return string Filtered block content. | ||
| */ | ||
| function gutenberg_render_behaviors_support_lightbox( $block_content, $block ) { | ||
| $experiments = get_option( 'gutenberg-experiments' ); | ||
| $link_destination = isset( $block['attrs']['linkDestination'] ) ? $block['attrs']['linkDestination'] : 'none'; | ||
| // Get the lightbox setting from the block attributes. | ||
| if ( isset( $block['attrs']['behaviors']['lightbox'] ) ) { | ||
| $lightbox = $block['attrs']['behaviors']['lightbox']; | ||
| // If the lightbox setting is not set in the block attributes, get it from the theme.json file. | ||
| } else { | ||
| $theme_data = WP_Theme_JSON_Resolver_Gutenberg::get_merged_data()->get_data(); | ||
| if ( isset( $theme_data['behaviors']['blocks'][ $block['blockName'] ]['lightbox'] ) ) { | ||
| $lightbox = $theme_data['behaviors']['blocks'][ $block['blockName'] ]['lightbox']; | ||
| } else { | ||
| $lightbox = false; | ||
| } | ||
| } | ||
|
|
||
| if ( ! $lightbox || 'none' !== $link_destination || empty( $experiments['gutenberg-interactivity-api-core-blocks'] ) ) { | ||
| return $block_content; | ||
| } | ||
|
|
||
| $processor = new WP_HTML_Tag_Processor( $block_content ); | ||
|
|
||
| $aria_label = __( 'Enlarge image', 'gutenberg' ); | ||
|
|
||
| $alt_attribute = trim( $processor->get_attribute( 'alt' ) ); | ||
|
|
||
| if ( $alt_attribute ) { | ||
| /* translators: %s: Image alt text. */ | ||
| $aria_label = sprintf( __( 'Enlarge image: %s', 'gutenberg' ), $alt_attribute ); | ||
| } | ||
| $content = $processor->get_updated_html(); | ||
|
|
||
| $w = new WP_HTML_Tag_Processor( $content ); | ||
| $w->next_tag( 'figure' ); | ||
| $w->add_class( 'wp-lightbox-container' ); | ||
| $w->set_attribute( 'data-wp-interactive', true ); | ||
| $w->set_attribute( 'data-wp-context', '{ "core": { "image": { "initialized": false, "lightboxEnabled": false } } }' ); | ||
| $body_content = $w->get_updated_html(); | ||
|
|
||
| // Wrap the image in the body content with a button. | ||
| $img = null; | ||
| preg_match( '/<img[^>]+>/', $content, $img ); | ||
| $button = '<div class="img-container"> | ||
| <button type="button" aria-haspopup="dialog" aria-label="' . esc_attr( $aria_label ) . '" data-wp-on--click="actions.core.image.showLightbox"></button>' | ||
| . $img[0] . | ||
| '</div>'; | ||
| $body_content = preg_replace( '/<img[^>]+>/', $button, $body_content ); | ||
|
|
||
| // Add directive to expand modal image if appropriate. | ||
| $m = new WP_HTML_Tag_Processor( $content ); | ||
| $m->next_tag( 'img' ); | ||
| $m->set_attribute( 'data-wp-context', '{ "core": { "image": { "imageSrc": "' . wp_get_attachment_url( $block['attrs']['id'] ) . '"} } }' ); | ||
| $m->set_attribute( 'data-wp-bind--src', 'selectors.core.image.imageSrc' ); | ||
| $modal_content = $m->get_updated_html(); | ||
|
|
||
| $background_color = esc_attr( wp_get_global_styles( array( 'color', 'background' ) ) ); | ||
|
|
||
| $close_button_icon = '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="15" height="15" aria-hidden="true" focusable="false"><path d="M13 11.8l6.1-6.3-1-1-6.1 6.2-6.1-6.2-1 1 6.1 6.3-6.5 6.7 1 1 6.5-6.6 6.5 6.6 1-1z"></path></svg>'; | ||
| $close_button_color = esc_attr( wp_get_global_styles( array( 'color', 'text' ) ) ); | ||
| $dialog_label = $alt_attribute ? esc_attr( $alt_attribute ) : esc_attr__( 'Image', 'gutenberg' ); | ||
| $close_button_label = esc_attr__( 'Close', 'gutenberg' ); | ||
|
|
||
| $lightbox_html = <<<HTML | ||
| <div data-wp-body="" class="wp-lightbox-overlay" | ||
| data-wp-bind--role="selectors.core.image.roleAttribute" | ||
| aria-label="$dialog_label" | ||
| data-wp-class--initialized="context.core.image.initialized" | ||
| data-wp-class--active="context.core.image.lightboxEnabled" | ||
| data-wp-bind--aria-hidden="!context.core.image.lightboxEnabled" | ||
| data-wp-bind--aria-modal="context.core.image.lightboxEnabled" | ||
| data-wp-effect="effects.core.image.initLightbox" | ||
| data-wp-on--keydown="actions.core.image.handleKeydown" | ||
| data-wp-on--mousewheel="actions.core.image.hideLightbox" | ||
| data-wp-on--click="actions.core.image.hideLightbox" | ||
| > | ||
| <button type="button" aria-label="$close_button_label" style="fill: $close_button_color" class="close-button" data-wp-on--click="actions.core.image.hideLightbox"> | ||
| $close_button_icon | ||
| </button> | ||
| $modal_content | ||
| <div class="scrim" style="background-color: $background_color"></div> | ||
| </div> | ||
| HTML; | ||
|
|
||
| return str_replace( '</figure>', $lightbox_html . '</figure>', $body_content ); | ||
| } | ||
|
|
||
| // Register the block support. | ||
| WP_Block_Supports::get_instance()->register( | ||
| 'behaviors', | ||
| array( | ||
| 'register_attribute' => 'gutenberg_register_behaviors_support', | ||
| ) | ||
| ); | ||
This file contains 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 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 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 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Bit late to this, but I think there's a dedicated
applyargument toWP_Block_Supports::get_instance()->register()that's typically used to render the block-supports on the frontend based on the attribute(s) registered (see e.g. how thealignblock-support does it).Maybe that would be a better fit here rather than using the (more generic)
render_block_{$type}filter?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We won't be landing this into 6.3, so I guess is not to late to update it (or make another PR to update it).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can definitely explore that option deeper. I think we tried, but we didn't fully understand how that worked, so we ended up using a filter like the duotone. We need to run this code after other filters, like the duotone, run, so we thought using another filter with lower priority was the proper way. But I'm happy to explore other possibilities if you think that's possible.