Skip to content

Commit

Permalink
add gallery_id to block context attributes
Browse files Browse the repository at this point in the history
  • Loading branch information
@madhusudhand
madhusudhand committed Sep 3, 2024
1 parent 93f745f commit 6b233eb
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 39 deletions.
4 changes: 4 additions & 0 deletions packages/block-library/src/gallery/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@
"keywords": [ "images", "photos" ],
"textdomain": "default",
"attributes": {
"galleryId": {
"type": "number"
},
"images": {
"type": "array",
"default": [],
Expand Down Expand Up @@ -105,6 +108,7 @@
}
},
"providesContext": {
"galleryId": "galleryId",
"allowResize": "allowResize",
"imageCrop": "imageCrop",
"fixedHeight": "fixedHeight"
Expand Down
45 changes: 13 additions & 32 deletions packages/block-library/src/gallery/index.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,47 +40,32 @@ function block_core_gallery_data_id_backcompatibility( $parsed_block ) {
* @since 6.7.0
*
* @param string $block_content Rendered block content.
* @param array $block Block object.
*
* @return string Filtered block content.
*/
function block_core_gallery_interactivity_state( $block_content, $block ) {
if ( 'core/gallery' !== $block['blockName'] ) {
function block_core_gallery_interactivity_state( $block_content ) {
if ( 'core/gallery' !== $block_content['blockName'] ) {
return $block_content;
}

$unique_gallery_id = uniqid();

Check warning on line 51 in packages/block-library/src/gallery/index.php

View workflow job for this annotation

GitHub Actions / PHP coding standards 

Equals sign not aligned with surrounding assignments; expected 4 spaces but found 1 space
interactive_block_gallery_id( $unique_gallery_id );
$filter_block_context = static function ( $context ) use ( $unique_gallery_id ) {
$context['galleryId'] = $unique_gallery_id;

Check warning on line 53 in packages/block-library/src/gallery/index.php

View workflow job for this annotation

GitHub Actions / PHP coding standards 

Equals sign not aligned correctly; expected 1 space but found 3 spaces
return $context;
};
add_filter( 'render_block_context', $filter_block_context, 1 );

wp_interactivity_state(
'core/gallery',
array(
'images' => array(),

Check warning on line 61 in packages/block-library/src/gallery/index.php

View workflow job for this annotation

GitHub Actions / PHP coding standards 

Array double arrow not aligned correctly; expected 1 space(s) between "'images'" and double arrow, but found 4.
'galleryId' => $unique_gallery_id,
)
);

return $block_content;
}

add_filter( 'render_block_data', 'block_core_gallery_interactivity_state', 15, 2 );

/**
* Returns the current gallery block id.
* Used in image block to get the gallery id and render the lightbox.
*
* @since 6.7.0
*
* @param string $id The id of the gallery block.
* @return array|void Returns the current gallery block id.
*/
function interactive_block_gallery_id( $id = null ) {
static $gallery_id = 0;
if ( isset( $id ) ) {
$gallery_id = $id;
}
return $gallery_id;
}
add_filter( 'render_block_data', 'block_core_gallery_interactivity_state' );

/**
* Renders the `core/gallery` block on the server.
Expand All @@ -91,7 +76,7 @@ function interactive_block_gallery_id( $id = null ) {
* @param string $content Content of the block being rendered.
* @return string The content of the block being rendered.
*/
function block_core_gallery_render( $attributes, $content ) {
function block_core_gallery_render( $attributes, $content, $block ) {
// Adds a style tag for the --wp--style--unstable-gallery-gap var.
// The Gallery block needs to recalculate Image block width based on
// the current gap setting in order to maintain the number of flex columns
Expand Down Expand Up @@ -169,8 +154,7 @@ function block_core_gallery_render( $attributes, $content ) {
)
);

$state = wp_interactivity_state( 'core/gallery' );
$gallery_id = interactive_block_gallery_id( );
$gallery_id = $block->context['galleryId'];

$processed_content->set_attribute( 'data-wp-interactive', 'core/gallery' );
$processed_content->set_attribute(
Expand All @@ -184,7 +168,7 @@ function block_core_gallery_render( $attributes, $content ) {
)
);

add_filter( 'render_block_core/gallery', 'block_core_gallery_render_lightbox' );
add_filter( 'render_block_core/gallery', 'block_core_gallery_render_lightbox', 15, 3 );

// The WP_HTML_Tag_Processor class calls get_updated_html() internally
// when the instance is treated as a string, but here we explicitly
Expand Down Expand Up @@ -245,9 +229,9 @@ static function () use ( $image_blocks, &$i ) {
*
* @return string Filtered block content.
*/
function block_core_gallery_render_lightbox( $block_content ) {
function block_core_gallery_render_lightbox( $block_content, $content, $block ) {
$state = wp_interactivity_state( 'core/gallery' );
$gallery_id = interactive_block_gallery_id();
$gallery_id = $block->context['galleryId'];
$images = $state['images'][ $gallery_id ] ?? array();
$translations = array();

Expand Down Expand Up @@ -280,9 +264,6 @@ function block_core_gallery_render_lightbox( $block_content ) {
}
}

// reset galleryId
interactive_block_gallery_id( 0 );

return $block_content;
}

Expand Down
2 changes: 1 addition & 1 deletion packages/block-library/src/image/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"name": "core/image",
"title": "Image",
"category": "media",
"usesContext": [ "allowResize", "imageCrop", "fixedHeight" ],
"usesContext": [ "galleryId", "allowResize", "imageCrop", "fixedHeight" ],
"description": "Insert an image to make a visual statement.",
"keywords": [ "img", "photo", "picture" ],
"textdomain": "default",
Expand Down
14 changes: 8 additions & 6 deletions packages/block-library/src/image/index.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ function render_block_core_image( $attributes, $content, $block ) {
* if the way the blocks are rendered changes, or if a new kind of filter is
* introduced.
*/
add_filter( 'render_block_core/image', 'block_core_image_render_lightbox', 15, 2 );
add_filter( 'render_block_core/image', 'block_core_image_render_lightbox', 15, 3 );
} else {
/*
* Remove the filter if previously added by other Image blocks.
Expand Down Expand Up @@ -142,12 +142,13 @@ function block_core_image_get_lightbox_settings( $block ) {
*
* @since 6.4.0
*
* @param string $block_content Rendered block content.
* @param array $block Block object.
* @param string $block_content Rendered block content.
* @param array $block Block object.
* @param array $block_instance Block instance.
*
* @return string Filtered block content.
*/
function block_core_image_render_lightbox( $block_content, $block ) {
function block_core_image_render_lightbox( $block_content, $block, $block_instance ) {
/*
* If there's no IMG tag in the block then return the given block content
* as-is. There's nothing that this code can knowingly modify to add the
Expand Down Expand Up @@ -205,9 +206,10 @@ function block_core_image_render_lightbox( $block_content, $block ) {
)
);

$state = wp_interactivity_state( 'core/gallery' );
$gallery_id = gutenberg_interactive_block_gallery_id( );
$gallery_id = $block_instance->context['galleryId'] ?? null;

if ( isset( $gallery_id ) ) {
$state = wp_interactivity_state( 'core/gallery' );
$images = $state['images'][ $gallery_id ];
if ( ! isset( $images ) ) {
$images = array();
Expand Down

0 comments on commit 6b233eb

Please sign in to comment.