gutenberg / build / scripts / block-library / query.php

query.php in Gutenberg 24.0.0, at build/scripts/block-library/query.php

154 lines 5.7 KB

Raw Download Zip

1	<?php
2	/**
3	* Server-side rendering of the `core/query` block.
4	*
5	* @package WordPress
6	*/
7
8	/**
9	* Modifies the static `core/query` block on the server.
10	*
11	* @since 6.4.0
12	*
13	* @param array $attributes Block attributes.
14	* @param string $content Block default content.
15	* @param WP_Block $block The block instance.
16	*
17	* @return string Returns the modified output of the query block.
18	*/
19	function gutenberg_render_block_core_query( $attributes, $content, $block ) {
20	$is_interactive = isset( $attributes['enhancedPagination'] )
21	&& true === $attributes['enhancedPagination']
22	&& isset( $attributes['queryId'] )
23	&& is_scalar( $attributes['queryId'] );
24
25	// Enqueue the script module and add the necessary directives if the block is
26	// interactive.
27	if ( $is_interactive ) {
28	wp_enqueue_script_module( '@wordpress/block-library/query/view' );
29
30	$p = new WP_HTML_Tag_Processor( $content );
31	if ( $p->next_tag() ) {
32	// Add the necessary directives.
33	$p->set_attribute( 'data-wp-interactive', 'core/query' );
34	$p->set_attribute( 'data-wp-router-region', 'query-' . $attributes['queryId'] );
35	$p->set_attribute( 'data-wp-context', '{}' );
36	$p->set_attribute( 'data-wp-key', $attributes['queryId'] );
37	$content = $p->get_updated_html();
38	}
39	}
40
41	// Add the styles to the block type if the block is interactive and remove
42	// them if it's not.
43	$style_asset = 'wp-block-query';
44	if ( ! wp_style_is( $style_asset ) ) {
45	$style_handles = $block->block_type->style_handles;
46	// If the styles are not needed, and they are still in the `style_handles`, remove them.
47	if ( ! $is_interactive && in_array( $style_asset, $style_handles, true ) ) {
48	$block->block_type->style_handles = array_diff( $style_handles, array( $style_asset ) );
49	}
50	// If the styles are needed, but they were previously removed, add them again.
51	if ( $is_interactive && ! in_array( $style_asset, $style_handles, true ) ) {
52	$block->block_type->style_handles = array_merge( $style_handles, array( $style_asset ) );
53	}
54	}
55
56	return $content;
57	}
58
59	/**
60	* Registers the `core/query` block on the server.
61	*
62	* @since 5.8.0
63	*/
64	function gutenberg_register_block_core_query() {
65	register_block_type_from_metadata(
66	__DIR__ . '/query',
67	array(
68	'render_callback' => 'gutenberg_render_block_core_query',
69	)
70	);
71	}
72	add_action( 'init', 'gutenberg_register_block_core_query', 20 );
73
74	/**
75	* Traverse the tree of blocks looking for any plugin block (i.e., a block from
76	* an installed plugin) inside a Query block with the enhanced pagination
77	* enabled. If at least one is found, the enhanced pagination is effectively
78	* disabled to prevent any potential incompatibilities.
79	*
80	* @since 6.4.0
81	*
82	* @param array $parsed_block The block being rendered.
83	* @return array Returns the parsed block, unmodified.
84	*/
85	function gutenberg_block_core_query_disable_enhanced_pagination( $parsed_block ) {
86	static $enhanced_query_stack = array();
87	static $dirty_enhanced_queries = array();
88	static $render_query_callback = null;
89
90	$block_name = $parsed_block['blockName'];
91	$block_type = WP_Block_Type_Registry::get_instance()->get_registered( $block_name );
92	$has_enhanced_pagination = isset( $parsed_block['attrs']['enhancedPagination'] ) && true === $parsed_block['attrs']['enhancedPagination'] && isset( $parsed_block['attrs']['queryId'] ) && is_scalar( $parsed_block['attrs']['queryId'] );
93	/*
94	* Client side navigation can be true in two states:
95	* - supports.interactivity = true;
96	* - supports.interactivity.clientNavigation = true;
97	*/
98	$supports_client_navigation = ( isset( $block_type->supports['interactivity']['clientNavigation'] ) && true === $block_type->supports['interactivity']['clientNavigation'] )
99	\|\| ( isset( $block_type->supports['interactivity'] ) && true === $block_type->supports['interactivity'] );
100
101	if ( 'core/query' === $block_name && $has_enhanced_pagination ) {
102	$enhanced_query_stack[] = $parsed_block['attrs']['queryId'];
103
104	if ( ! isset( $render_query_callback ) ) {
105	/**
106	* Filter that disables the enhanced pagination feature during block
107	* rendering when a plugin block has been found inside. It does so
108	* by adding an attribute called `data-wp-navigation-disabled` which
109	* is later handled by the front-end logic.
110	*
111	* @param string $content The block content.
112	* @param array $block The full block, including name and attributes.
113	* @return string Returns the modified output of the query block.
114	*/
115	$render_query_callback = static function ( $content, $block ) use ( &$enhanced_query_stack, &$dirty_enhanced_queries, &$render_query_callback ) {
116	$has_enhanced_pagination = isset( $block['attrs']['enhancedPagination'] ) && true === $block['attrs']['enhancedPagination'] && isset( $block['attrs']['queryId'] ) && is_scalar( $block['attrs']['queryId'] );
117
118	if ( ! $has_enhanced_pagination ) {
119	return $content;
120	}
121
122	if ( isset( $dirty_enhanced_queries[ $block['attrs']['queryId'] ] ) ) {
123	// Disable navigation in the router store config.
124	wp_interactivity_config( 'core/router', array( 'clientNavigationDisabled' => true ) );
125	$dirty_enhanced_queries[ $block['attrs']['queryId'] ] = null;
126	}
127
128	array_pop( $enhanced_query_stack );
129
130	if ( empty( $enhanced_query_stack ) ) {
131	remove_filter( 'render_block_core/query', $render_query_callback );
132	$render_query_callback = null;
133	}
134
135	return $content;
136	};
137
138	add_filter( 'render_block_core/query', $render_query_callback, 10, 2 );
139	}
140	} elseif (
141	! empty( $enhanced_query_stack ) &&
142	isset( $block_name ) &&
143	( ! $supports_client_navigation )
144	) {
145	foreach ( $enhanced_query_stack as $query_id ) {
146	$dirty_enhanced_queries[ $query_id ] = true;
147	}
148	}
149
150	return $parsed_block;
151	}
152
153	add_filter( 'render_block_data', 'gutenberg_block_core_query_disable_enhanced_pagination', 10, 1 );
154