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

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

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