malhuda/fictioneer
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases 112 Wiki Activity

Update fictioneer_get_card_list function

Browse Source 
Excluding IDs based on a paginated result and then query again was not guaranteed to work since the new query could include new IDs that need excluding.
This commit is contained in:
Tetrakern 2023-11-12 14:23:44 +01:00
parent c1a09e9fd7
commit d0e3417e2e
3 changed files with 58 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
INSTALLATION.md
View File

@ -917,6 +917,7 @@ define( 'CONSTANT_NAME', value );
| FICTIONEER_SHORTCODE_TRANSIENT_EXPIRATION | integer | Expiration duration for shortcode Transients in seconds. Default `300`.
| FICTIONEER_STORY_COMMENT_COUNT_TIMEOUT | integer | Timeout between comment count refreshes for stories in _seconds_. Default `900`.
| FICTIONEER_REQUESTS_PER_MINUTE | integer | Maximum requests per minute and action if the rate limit is enabled. Default `5`.
| FICTIONEER_POST_NOT_IN_LIMIT | integer | Maximum allowed IDs in the 'post__not_in' query argument. Default `100`.
| FICTIONEER_CACHE_PURGE_ASSIST | boolean | Whether to call the cache purge assist function on post updates. Default `true`.
| FICTIONEER_RELATIONSHIP_PURGE_ASSIST | boolean | Whether to purge related post caches. Default `true`.
| FICTIONEER_CHAPTER_LIST_TRANSIENTS | boolean | Whether to cache chapter lists on story pages as Transients. Default `true`.

7
functions.php
View File

@ -264,6 +264,13 @@ if ( ! defined( 'FICTIONEER_REQUESTS_PER_MINUTE' ) ) {
define( 'FICTIONEER_REQUESTS_PER_MINUTE', 5 );
}
// Integer: Maximum of 'post__not_in' query argument to prevent performance degradation.
// If exceeded, the whole argument will be ignored in certain queries, which account for
// this case in the view.
if ( ! defined( 'FICTIONEER_POST_NOT_IN_LIMIT' ) ) {
define( 'FICTIONEER_POST_NOT_IN_LIMIT', 100 );
}
/*
* Booleans
*/

60
includes/functions/_query_helpers.php
View File

@ -60,7 +60,8 @@ if ( ! function_exists( 'fictioneer_get_card_list' ) ) {
'order' => 'DESC',
'posts_per_page' => get_option( 'posts_per_page' ),
'no_found_rows' => $query_args['no_found_rows'] ?? false,
'update_post_meta_cache' => true
'update_post_meta_cache' => true,
'update_post_term_cache' => true
);
// Default card arguments
@ -74,22 +75,38 @@ if ( ! function_exists( 'fictioneer_get_card_list' ) ) {
// Query (but not if 'post__in' is set and empty)
if ( ! ( isset( $the_query_args['post__in'] ) && empty( $the_query_args['post__in'] ) ) ) {
$all_query = new WP_Query( $the_query_args );
// Get complete set for filtering (required due to pagination)
$all_query = new WP_Query(
array_merge( $the_query_args, array( 'posts_per_page' => -1, 'no_found_rows' => true ) )
);
// Get excluded posts (faster than meta query)
$excluded = [];
foreach ( $all_query->posts as $candidate ) {
if (
fictioneer_get_field( 'fictioneer_chapter_hidden', $candidate->ID ) ||
fictioneer_get_field( 'fictioneer_chapter_no_chapter', $candidate->ID ) ||
fictioneer_get_field( 'fictioneer_story_hidden', $candidate->ID )
) {
$excluded[] = $candidate->ID;
// Chapter hidden or excluded?
if ( $candidate->post_type === 'fcn_chapter' ) {
if (
fictioneer_get_field( 'fictioneer_chapter_hidden', $candidate->ID ) ||
fictioneer_get_field( 'fictioneer_chapter_no_chapter', $candidate->ID )
) {
$excluded[] = $candidate->ID;
}
continue;
}
// Story hidden?
if ( $candidate->post_type === 'fcn_story' ) {
if ( fictioneer_get_field( 'fictioneer_story_hidden', $candidate->ID ) ) {
$excluded[] = $candidate->ID;
}
continue;
}
}
if ( ! empty( $excluded ) ) {
if ( ! empty( $excluded ) && count( $excluded ) <= FICTIONEER_POST_NOT_IN_LIMIT ) {
$the_query_args['post__not_in'] = array_merge( $excluded, ( $the_query_args['post__not_in'] ?? [] ) );
}
@ -111,9 +128,32 @@ if ( ! function_exists( 'fictioneer_get_card_list' ) ) {
// Loop results
if ( $query && $query->have_posts() ) {
$card_partial = 'partials/_card-' . str_replace( 'fcn_', '', $post_type );
while ( $query->have_posts() ) {
$query->the_post();
get_template_part( 'partials/_card-' . str_replace( 'fcn_', '', $post_type ), null, $the_card_args );
switch ( $post_type ) {
case 'fcn_story':
if ( fictioneer_get_field( 'fictioneer_story_hidden', get_the_ID() ) ) {
get_template_part( 'partials/_card-hidden', null, $the_card_args );
} else {
get_template_part( $card_partial, null, $the_card_args );
}
break;
case 'fcn_chapter':
if (
fictioneer_get_field( 'fictioneer_chapter_hidden', get_the_ID() ) ||
fictioneer_get_field( 'fictioneer_chapter_no_chapter', get_the_ID() )
) {
get_template_part( 'partials/_card-hidden', null, $the_card_args );
} else {
get_template_part( $card_partial, null, $the_card_args );
}
break;
default:
get_template_part( $card_partial, null, $the_card_args );
}
}
wp_reset_postdata();