Repository navigation
Expand file tree
/
Copy pathhm-query-loop.php
More file actions
606 lines (505 loc) · 18.8 KB
/
Copy pathhm-query-loop.php
File metadata and controls
606 lines (505 loc) · 18.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
<?php
/**
* Plugin Name: HM Query Loop
* Plugin URI: https://humanmade.com
* Description: Extends the Query Loop block with advanced controls for multiple query loops on a single page
* Version: __VERSION__
* Author: Human Made
* Author URI: https://humanmade.com
* License: GPL-2.0+
* Text Domain: hm-query-loop
*/
namespace HM\QueryLoop;
use WP_Block;
use WP_Query;
// Exit if accessed directly.
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
define( 'HM_QUERY_LOOP_VERSION', '__VERSION__' );
define( 'HM_QUERY_LOOP_PATH', plugin_dir_path( __FILE__ ) );
define( 'HM_QUERY_LOOP_URL', plugin_dir_url( __FILE__ ) );
// Load query presets functionality.
require_once HM_QUERY_LOOP_PATH . 'inc/query-presets.php';
// Load sticky posts functionality.
require_once HM_QUERY_LOOP_PATH . 'inc/sticky-posts.php';
// Load PHP-side post exclusions.
require_once HM_QUERY_LOOP_PATH . 'inc/deferred-exclusions.php';
/**
* Initialize the plugin.
*/
function init() {
// Enqueue block editor assets.
add_action( 'enqueue_block_editor_assets', __NAMESPACE__ . '\\enqueue_block_editor_assets', 9 );
// Deduplicate query IDs for query loop blocks.
add_filter( 'pre_render_block', __NAMESPACE__ . '\\deduplicate_query_ids', 10, 2 );
// Register block filters.
add_filter( 'pre_render_block', __NAMESPACE__ . '\\pre_render_block', 11, 3 );
add_filter( 'render_block', __NAMESPACE__ . '\\render_block', 11, 2 );
// Hook query_loop_block_query_vars to modify the query.
add_filter( 'query_loop_block_query_vars', __NAMESPACE__ . '\\filter_query_loop_block_query_vars', 11, 3 );
// Hook into the_posts to track displayed posts and limit post-template posts.
add_filter( 'the_posts', __NAMESPACE__ . '\\track_displayed_posts', 10, 2 );
// Add contexts to query and post-template block.
add_filter( 'block_type_metadata', __NAMESPACE__ . '\\filter_block_metadata' );
// Initialize query presets functionality.
QueryPresets\init();
// Initialize sticky posts functionality.
StickyPosts\bootstrap();
// Initialize PHP-side post exclusions.
DeferredExclusions\init();
}
add_action( 'init', __NAMESPACE__ . '\\init', 9 );
/**
* Whether ElasticPress is available for use with query loops.
*
* Filterable so sites can force the integration on or off independently of
* whether ElasticPress is installed and activated.
*
* @return bool
*/
function is_elasticpress_available(): bool {
$available = class_exists( '\ElasticPress\Features' );
return (bool) apply_filters( 'hm_query_loop_elasticpress_available', $available );
}
/**
* Enqueue block editor assets.
*/
function enqueue_block_editor_assets() {
$asset_file = include HM_QUERY_LOOP_PATH . 'build/index.asset.php';
wp_enqueue_script(
'hm-query-loop-editor',
HM_QUERY_LOOP_URL . 'build/index.js',
$asset_file['dependencies'],
$asset_file['version'],
[
'in_footer' => false,
]
);
// Pass settings to JavaScript.
wp_localize_script(
'hm-query-loop-editor',
'hmQueryLoopSettings',
[
'postsPerPage' => (int) get_option( 'posts_per_page', 10 ),
'elasticPressAvailable' => is_elasticpress_available(),
]
);
wp_enqueue_style(
'hm-query-loop-editor',
HM_QUERY_LOOP_URL . 'build/index.css',
[],
$asset_file['version']
);
}
/**
* Filter block metadata to add context.
*
* @param array $metadata Block metadata.
* @return array Modified metadata.
*/
function filter_block_metadata( $metadata ) {
if ( $metadata['name'] === 'core/query' ) {
$metadata['providesContext'] = array_merge(
$metadata['providesContext'] ?? [],
[ 'hmQueryLoop' => 'hmQueryLoop' ]
);
}
if ( $metadata['name'] === 'core/post-template' ) {
$metadata['usesContext'] = array_merge(
$metadata['usesContext'] ?? [],
[ 'hmQueryLoop' ]
);
}
return $metadata;
}
/**
* Track displayed post IDs across query loops.
*
* @var array
*/
$displayed_post_ids = [];
/**
* Track used post IDs within each query loop block.
* Keyed by block ID to scope posts to each query loop.
*
* @var array
*/
$query_loop_used_posts = [];
/**
* Track post template per page settings within each query loop.
* Keyed by query ID, stores array of per page values in order.
*
* @var array
*/
$query_loop_post_template_per_pages = [];
/**
* The set of displayed post IDs each query loop excluded, keyed by query ID.
*
* A query loop renders several queries — one per post template, plus the ones
* the pagination and total blocks run — and each of those must exclude the same
* posts to produce the same SQL, and therefore share one cache entry. Taking the
* snapshot once per loop stops the set growing as the loop's own posts are
* tracked.
*
* @var array
*/
$query_loop_exclusion_snapshots = [];
/**
* Get displayed post IDs.
*
* @return array
*/
function get_displayed_post_ids() {
global $displayed_post_ids;
return $displayed_post_ids ?? [];
}
/**
* Add displayed post IDs.
*
* @param array $post_ids Post IDs to add.
*/
function add_displayed_post_ids( $post_ids ) {
global $displayed_post_ids;
if ( ! is_array( $displayed_post_ids ) ) {
$displayed_post_ids = [];
}
$displayed_post_ids = array_unique( array_merge( $displayed_post_ids, $post_ids ) );
}
/**
* Get used post IDs for a specific query loop.
*
* @param string $query_id Query loop block ID.
* @return array
*/
function get_query_loop_used_posts( $query_id ) {
global $query_loop_used_posts;
return $query_loop_used_posts[ $query_id ] ?? [];
}
/**
* Add used post IDs for a specific query loop.
*
* @param string $query_id Query loop block ID.
* @param array $post_ids Post IDs to add.
*/
function add_query_loop_used_posts( $query_id, $post_ids ) {
global $query_loop_used_posts;
if ( ! isset( $query_loop_used_posts[ $query_id ] ) ) {
$query_loop_used_posts[ $query_id ] = [];
}
$query_loop_used_posts[ $query_id ] = array_unique( array_merge( $query_loop_used_posts[ $query_id ], $post_ids ) );
}
/**
* Ensure each core/query block has a unique queryId during server-side rendering.
*
* Uses a static instance counter combined with the current post ID to generate
* unique query IDs. Dynamically adds a render_block_context filter to set the
* queryId for child core/post-template blocks, and removes it when the query
* block finishes rendering.
*
* @param string|null $pre_render The pre-rendered content. Default null.
* @param array $parsed_block The block being rendered.
* @return string|null
*/
function deduplicate_query_ids( $pre_render, $parsed_block ) {
static $instance_count = 0;
static $used_query_ids = [];
if ( 'core/query' !== $parsed_block['blockName'] ) {
return $pre_render;
}
$original_query_id = $parsed_block['attrs']['queryId'] ?? null;
// Only override the queryId if it has already been used by a previous
// query block. This preserves the original value when possible,
// improving interoperability with other plugins.
if ( $original_query_id !== null && ! in_array( $original_query_id, $used_query_ids, true ) ) {
$used_query_ids[] = $original_query_id;
return $pre_render;
}
$instance_count++;
$post_id = get_the_ID() ?: 0;
$unique_query_id = $post_id * 1000 + $instance_count;
// Ensure the generated ID doesn't collide with any already-used ID.
while ( in_array( $unique_query_id, $used_query_ids, true ) ) {
$instance_count++;
$unique_query_id = $post_id * 1000 + $instance_count;
}
$used_query_ids[] = $unique_query_id;
// Track nesting depth so the render_block cleanup only fires
// for this specific query block, not nested ones.
$depth = 0;
// Dynamically add a render_block_context filter to propagate the reassigned
// queryId to every descendant that inherited the original id — the
// post-template plus any sibling blocks that build query URLs from it
// (core/query-pagination, core/search, and the query-filter blocks).
// Match on the inherited queryId rather than the block name so a nested
// core/query, which provides its own queryId to its children, is left
// untouched.
$context_filter = function ( $context ) use ( $unique_query_id, $original_query_id ) {
if ( ( $context['queryId'] ?? null ) === $original_query_id ) {
$context['queryId'] = $unique_query_id;
}
return $context;
};
// Track nested core/query blocks to avoid premature cleanup.
$pre_depth_filter = function ( $pre, $block ) use ( &$depth ) {
if ( 'core/query' === $block['blockName'] ) {
$depth++;
}
return $pre;
};
// Remove the context filter when this query block finishes rendering.
$render_filter = function ( $block_content, $block ) use ( $context_filter, &$render_filter, &$pre_depth_filter, &$depth ) {
if ( 'core/query' !== $block['blockName'] ) {
return $block_content;
}
if ( $depth > 0 ) {
$depth--;
return $block_content;
}
remove_filter( 'render_block_context', $context_filter, 10 );
remove_filter( 'render_block', $render_filter, 9 );
remove_filter( 'pre_render_block', $pre_depth_filter, 9 );
return $block_content;
};
add_filter( 'render_block_context', $context_filter, 10, 2 );
add_filter( 'pre_render_block', $pre_depth_filter, 9, 2 );
add_filter( 'render_block', $render_filter, 9, 2 );
return $pre_render;
}
/**
* Pre-render block callback.
*
* @param string|null $pre_render The pre-rendered content. Default null.
* @param array $parsed_block The block being rendered.
* @return string|null Null to allow normal rendering.
*/
function pre_render_block( $pre_render, $parsed_block ) {
global $original_paged;
// Only process core/query blocks.
if ( 'core/query' !== $parsed_block['blockName'] ) {
return $pre_render;
}
$attrs = $parsed_block['attrs'] ?? [];
if ( ! ( $attrs['query']['inherit'] ?? false ) ) {
return $pre_render;
}
// We need to restore this for loops that resume normal pagination.
if ( empty( $original_paged ) ) {
$original_paged = (int) get_query_var( 'paged', 1 );
}
// Run the main query again to trigger the pre_get_posts hook if we're inheriting.
global $wp_query;
// On the blog posts page, $wp_query->query contains page-related args
// (e.g., ['pagename' => 'blog']) instead of posts query args.
// WordPress Core converts this to a posts query, but that transformation
// is lost when we re-run the query. Use explicit post query args instead.
if ( is_home() && ! is_front_page() ) {
$query_args = [
'post_type' => 'post',
'paged' => $original_paged,
];
} else {
$query_args = $wp_query->query;
}
$query_args = modify_query_from_block_attrs( $query_args, $attrs );
$wp_query->query( $query_args );
// ElasticPress and similar plugins use posts_pre_query to return cached results,
// ignoring our posts_per_page setting. Manually slice the posts array to enforce the limit.
$settings = $attrs['hmQueryLoop'] ?? [];
if ( isset( $settings['perPage'] ) && is_numeric( $settings['perPage'] ) && $settings['perPage'] > 0 ) {
$per_page = (int) $settings['perPage'];
if ( count( $wp_query->posts ) > $per_page ) {
$wp_query->posts = array_slice( $wp_query->posts, 0, $per_page );
$wp_query->post_count = count( $wp_query->posts );
}
}
// The global query can happen again in some cases, so avoid double collecting,
// especially with AQL or similar plugins to this one.
$wp_query->set( 'hm_query_loop_collect_ids', false );
return $pre_render;
}
/**
* Render block callback.
*
* @param string $block_content Block content.
* @param array $block Block data.
* @return string Block content.
*/
function render_block( $block_content, $block ) {
if ( 'core/query' !== $block['blockName'] ) {
return $block_content;
}
global $original_paged;
// Check if block should be hidden on pagination.
$settings = $block['attrs']['hmQueryLoop'] ?? [];
$hide_on_paged = $settings['hideOnPaged'] ?? false;
if ( $hide_on_paged && $original_paged > 1 ) {
return '';
}
return $block_content;
}
/**
* Filter queries for loops that do not inherit from the main query.
*
* @param array $query Query args for the query loop.
* @param WP_Block $block Current block instance.
* @param int $page Current page of the loop.
* @return array The modified query vars.
*/
function filter_query_loop_block_query_vars( $query, WP_Block $block, $page = 1 ) {
$query_id = $block->context['queryId'] ?? 0;
$query = DeferredExclusions\track_loop( $query, $query_id );
$query = modify_query_from_block_attrs( $query, $block->context, $query_id );
if ( $block->name !== 'core/post-template' ) {
return $query;
}
global $query_loop_post_template_per_pages;
// Merge hmQueryLoop context with the post template's own attribute.
$settings = wp_parse_args(
$block->parsed_block['attrs']['hmQueryLoop'] ?? [],
$block->context['hmQueryLoop'] ?? [],
);
if ( ! isset( $query_loop_post_template_per_pages[ $query_id ] ) ) {
$query_loop_post_template_per_pages[ $query_id ] = [];
}
// How many posts the loop as a whole reads, as core worked it out.
$loop_per_page = (int) ( $query['posts_per_page'] ?? get_option( 'posts_per_page', 10 ) );
// Posts claimed by the post templates that already rendered in this loop.
$window_start = (int) array_sum( $query_loop_post_template_per_pages[ $query_id ] );
$window_size = $settings['perPage'] ?? null;
$window_size = empty( $window_size ) ? max( 1, $loop_per_page - $window_start ) : (int) $window_size;
$query_loop_post_template_per_pages[ $query_id ][] = $window_size;
// Every post template in the loop reads the same slice of the same result
// set and takes its own window out of it in PHP. Narrowing the query per
// template instead — with a smaller `posts_per_page` and the preceding
// templates' posts in `post__not_in` — gives each template SQL of its own,
// and so a cache entry of its own.
return DeferredExclusions\set_window( $query, $window_start, $window_size );
}
/**
* Get the posts a query loop should exclude because an earlier loop showed them.
*
* Snapshotted per loop: see $query_loop_exclusion_snapshots.
*
* @param string|int $query_id The loop's query ID.
* @return array Post IDs.
*/
function get_loop_exclusions( $query_id ): array {
global $query_loop_exclusion_snapshots;
if ( ! isset( $query_loop_exclusion_snapshots[ $query_id ] ) ) {
$query_loop_exclusion_snapshots[ $query_id ] = get_displayed_post_ids();
}
return $query_loop_exclusion_snapshots[ $query_id ];
}
/**
* Exclude posts from a query by handling both post__not_in and post__in parameters.
*
* When post__in is set, WordPress ignores post__not_in. This function ensures
* exclusions work correctly by filtering post__in directly when present.
*
* @param array $query The query args array.
* @param array $excluded_ids Post IDs to exclude.
* @return array Modified query args.
*/
function exclude_posts_from_query( $query, $excluded_ids ) {
if ( empty( $excluded_ids ) ) {
return $query;
}
// If post__in is set, filter out excluded IDs from it.
// This is necessary because post__in takes precedence over post__not_in in WordPress.
if ( ! empty( $query['post__in'] ) && is_array( $query['post__in'] ) ) {
$query['post__in'] = array_values( array_diff( $query['post__in'], $excluded_ids ) );
}
// Also set post__not_in for queries without post__in.
$existing_exclusions = $query['post__not_in'] ?? [];
if ( ! is_array( $existing_exclusions ) ) {
$existing_exclusions = [];
}
$query['post__not_in'] = array_unique( array_merge( $existing_exclusions, $excluded_ids ) );
return $query;
}
/**
* Modify query args based on block attributes.
*
* @param array $query The query args array.
* @param array $attrs The block attributes/context.
* @param string|int|null $query_id The loop's query ID, or null for the main
* query, where exclusions cannot be deferred.
* @return array Modified query args.
*/
function modify_query_from_block_attrs( $query = [], $attrs = [], $query_id = null ) {
global $original_paged;
// Get the hmQueryLoop settings object.
$settings = $attrs['hmQueryLoop'] ?? [];
$is_deferred = null !== $query_id;
if ( ! $is_deferred ) {
// Start collecting post IDs. Loops that go through track_loop() are
// flagged out of band instead, so this never reaches the cache key.
$query['hm_query_loop_collect_ids'] = true;
}
// If hiding on paginated URLs force the page to page 1. `offset` takes
// precedence over `paged` in the LIMIT clause, so only set it where it can
// actually change the result — otherwise it is dead weight in the cache key.
if ( ! isset( $query['offset'] ) ) {
if ( ! empty( $settings['hideOnPaged'] ) ) {
$query['paged'] = 1;
} elseif ( ! empty( $original_paged ) ) {
$query['paged'] = $original_paged;
}
}
// Apply custom posts per page if set and is a valid number.
if ( isset( $settings['perPage'] ) && is_numeric( $settings['perPage'] ) && $settings['perPage'] > 0 ) {
$query['posts_per_page'] = (int) $settings['perPage'];
}
// Route query through ElasticPress if enabled and available.
if ( ! empty( $settings['useElasticPress'] ) && is_elasticpress_available() ) {
$query['ep_integrate'] = true;
}
// Carry pinned post IDs through to the ORDER BY clause. This is an
// ordering concern rather than a query var, so it is stashed on the query
// and read back in StickyPosts\apply_sticky_order(). Unlike this plugin's
// own bookkeeping it has to reach WP_Query, but it only repeats IDs that
// the ORDER BY already carries, so it adds no cache-key fragmentation.
$sticky_posts = StickyPosts\normalize_ids( $settings['stickyPosts'] ?? [] );
if ( ! empty( $sticky_posts ) ) {
$query[ StickyPosts\QUERY_VAR ] = $sticky_posts;
}
// Exclude posts shown by earlier query loops on this page.
if ( ! empty( $settings['excludeDisplayed'] ) ) {
$displayed_ids = $is_deferred ? get_loop_exclusions( $query_id ) : get_displayed_post_ids();
if ( ! empty( $displayed_ids ) ) {
$query = $is_deferred
? DeferredExclusions\add_exclusions( $query, $displayed_ids )
: exclude_posts_from_query( $query, $displayed_ids );
}
}
return $query;
}
/**
* Track displayed posts using the_posts filter.
*
* @param array $posts Array of post objects.
* @param \WP_Query $query The WP_Query instance.
* @return array Array of post objects.
*/
function track_displayed_posts( $posts, $query ) {
if ( ! $query instanceof WP_Query ) {
return $posts;
}
// Query loop blocks are flagged out of band so that nothing this plugin
// adds ends up in the query's cache key; the main query still uses a query
// var, which is unique to that request anyway.
$context = DeferredExclusions\get_context( $query );
if ( null === $context && ! $query->get( 'hm_query_loop_collect_ids' ) ) {
return $posts;
}
// Runs at priority 10, after DeferredExclusions\filter_posts() has trimmed
// the over-fetched result set, so only posts that really render are tracked.
if ( ! empty( $posts ) ) {
$post_ids = wp_list_pluck( $posts, 'ID' );
add_displayed_post_ids( $post_ids );
add_query_loop_used_posts( $context['query_id'] ?? $query->get( 'query_id', -1 ), $post_ids );
}
DeferredExclusions\release_context( $query );
return $posts;
}