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

Refactor blog shortcode

Browse Source
This commit is contained in:
Tetrakern 2023-09-16 01:40:06 +02:00
parent f7b3aca1eb
commit 038d165e48
2 changed files with 67 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
FILTERS.md
View File

@ -653,7 +653,7 @@ Filters the query arguments in the `fictioneer_article_cards` shortcode. The opt
* $fictioneer_query_name (string) – `'article_cards'`
* $post_type (array) – `'$args['post_type']'`
* $post_status (string) – `'publish'`
* $ignore_sticky_posts (boolean|null) – `$args['ignore_sticky']`
* $ignore_sticky_posts (boolean) – `$args['ignore_sticky']`
* $post__in (array|null) – `$args['post_ids']`
* $order (string) – `$args['order']`
* $orderby (string) – `$args['orderby']`
@ -696,23 +696,23 @@ Filters the query arguments in the `fictioneer_blog` shortcode.
* $post_status (string) – `'publish'`
* $ignore_sticky_posts (boolean) – `$args['ignore_sticky']`
* $author_name (string|null) – `$args['author']`
* $tag__not_in (\[string]|null) – Array extracted from `$args['exclude_tag_ids']`.
* $category__not_in (\[string]|null) – Array extracted from `$args['exclude_cat_ids']`.
* $paged (int) – Current main query page.
* $posts_per_page (int) – `$args['per_page']` or theme default.
* $tax_query (array|null) – Query arguments for taxonomies.
* $category__not_in (array|null) – `$args['excluded_cats']`
* $tag__not_in (array|null) – `$args['excluded_tags']`
* $paged (int) – Current main query page number.
* $posts_per_page (int) – `$args['posts_per_page']`
* $tax_query (array|null) – `fictioneer_get_shortcode_tax_query( $args )`
**$args:**
* $per_page (string|null) – Optional. The number of posts per page.
* $author (string|null) – Optional. The author provided by the shortcode.
* $ignore_sticky (boolean|null) – Optional. Whether to ignore sticky posts. Default `false`.
* $ignore_protected (boolean|null) – Optional. Whether to ignore protected posts. Default `false`.
* $exclude_tag_ids (string|null) – Optional. Comma-separated list of tag IDs.
* $exclude_cat_ids (string|null) – Optional. Comma-separated list of category IDs.
* $categories (string|null) – Optional. Comma-separated list of category names.
* $tags (string|null) – Optional. Comma-separated list of tag names.
* $rel (string|null) – Optional. Relationship between taxonomies (`AND` or `OR`).
* $class (string|null) – Optional. Additional CSS classes.
**$attr:**
* $posts_per_page (int) – The number of posts per page. Defaults to WordPress.
* $page (int) – Current main query page number. Default `1`.
* $ignore_sticky (boolean) – Optional. Whether to ignore sticky posts. Default `false`.
* $ignore_protected (boolean) – Optional. Whether to ignore protected posts. Default `false`.
* $author (boolean|string) – Limit posts to a specific author. Default `false`.
* $author_ids (array) – Limit posts to specific author IDs. Default empty.
* $excluded_tags (array) – Exclude specific tag names. Default empty.
* $excluded_cats (array) – Exclude specific category names. Default empty.
* $relation (string) – Relationship between taxonomies. Default `'AND'`.
* $classes (string) – String of additional CSS classes. Default empty.
---

96
includes/functions/_shortcodes.php
View File

@ -1290,73 +1290,72 @@ add_shortcode( 'fictioneer_search', 'fictioneer_shortcode_search' );
function fictioneer_shortcode_blog( $attr ) {
// Setup
$author = $attr['author'] ?? false;
$taxonomies = fictioneer_get_shortcode_taxonomies( $attr );
$exclude_tag_ids = fictioneer_explode_list( $attr['exclude_tag_ids'] ?? '' );
$exclude_cat_ids = fictioneer_explode_list( $attr['exclude_cat_ids'] ?? '' );
$exclude_author_ids = fictioneer_explode_list( $attr['exclude_author_ids'] ?? '' );
$author_ids = fictioneer_explode_list( $attr['author_ids'] ?? '' );
$ignore_sticky = filter_var( $attr['ignore_sticky'] ?? 0, FILTER_VALIDATE_BOOLEAN );
$ignore_protected = filter_var( $attr['ignore_protected'] ?? 0, FILTER_VALIDATE_BOOLEAN );
$classes = esc_attr( wp_strip_all_tags( $attr['class'] ?? '' ) );
$rel = strtolower( $attr['rel'] ?? 'and' ) === 'or' ? 'OR' : 'AND';
$args = array(
'posts_per_page' => absint( $attr['per_page'] ?? 0 ) ?: get_option( 'posts_per_page' ),
'page' => max( 1, get_query_var( 'page' ) ?: get_query_var( 'paged' ) ),
'ignore_sticky' => filter_var( $attr['ignore_sticky'] ?? 0, FILTER_VALIDATE_BOOLEAN ),
'ignore_protected' => filter_var( $attr['ignore_protected'] ?? 0, FILTER_VALIDATE_BOOLEAN ),
'author' => $attr['author'] ?? false,
'author_ids' => fictioneer_explode_list( $attr['author_ids'] ?? '' ),
'excluded_authors' => fictioneer_explode_list( $attr['exclude_author_ids'] ?? '' ),
'excluded_cats' => fictioneer_explode_list( $attr['exclude_cat_ids'] ?? '' ),
'excluded_tags' => fictioneer_explode_list( $attr['exclude_tag_ids'] ?? '' ),
'taxonomies' => fictioneer_get_shortcode_taxonomies( $attr ),
'relation' => strtolower( $attr['rel'] ?? 'and' ) === 'or' ? 'OR' : 'AND',
'classes' => esc_attr( wp_strip_all_tags( $attr['class'] ?? '' ) )
);
// Page
$page = get_query_var( 'page' ) ?? get_query_var( 'paged' ) ?? 1;
// Arguments
// Query arguments
$query_args = array(
'post_type' => 'post',
'post_status' => 'publish',
'paged' => max( 1, $page ),
'posts_per_page' => $attr['per_page'] ?? get_option( 'posts_per_page' ),
'ignore_sticky_posts' => $ignore_sticky
'paged' => $args['page'],
'posts_per_page' => $args['posts_per_page'],
'ignore_sticky_posts' => $args['ignore_sticky']
);
// Author?
if ( ! empty( $author ) ) {
$query_args['author_name'] = $author;
if ( ! empty( $args['author'] ) ) {
$query_args['author_name'] = $args['author'];
}
// Author IDs?
if ( ! empty( $author_ids ) ) {
$query_args['author__in'] = $author_ids;
if ( ! empty( $args['author_ids'] ) ) {
$query_args['author__in'] = $args['author_ids'];
}
// Taxonomies?
if ( ! empty( $taxonomies ) ) {
$taxonomies['relation'] = $rel;
$taxonomies['taxonomies'] = $taxonomies;
$query_args['tax_query'] = fictioneer_get_shortcode_tax_query( $taxonomies );
if ( ! empty( $args['taxonomies'] ) ) {
$query_args['tax_query'] = fictioneer_get_shortcode_tax_query( $args );
}
// Excluded tags?
if ( ! empty( $exclude_tag_ids ) ) {
$query_args['tag__not_in'] = $exclude_tag_ids;
if ( ! empty( $args['excluded_tags'] ) ) {
$query_args['tag__not_in'] = $args['excluded_tags'];
}
// Excluded categories?
if ( ! empty( $exclude_cat_ids ) ) {
$query_args['category__not_in'] = $exclude_cat_ids;
if ( ! empty( $args['excluded_cats'] ) ) {
$query_args['category__not_in'] = $args['excluded_cats'];
}
// Excluded authors?
if ( ! empty( $exclude_author_ids ) ) {
$query_args['author__not_in'] = $exclude_author_ids;
if ( ! empty( $args['excluded_authors'] ) ) {
$query_args['author__not_in'] = $args['excluded_authors'];
}
// Exclude protected
if ( $ignore_protected ) {
if ( $args['ignore_protected'] ) {
add_filter( 'posts_where', 'fictioneer_exclude_protected_posts' );
}
// Apply filters
$query_args = apply_filters( 'fictioneer_filter_shortcode_blog_query_args', $query_args, $attr );
$query_args = apply_filters( 'fictioneer_filter_shortcode_blog_query_args', $query_args, $args );
// Transient?
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED ) {
$base = serialize( $query_args ) . serialize( $attr ) . $page;
$transient_key = "fictioneer_shortcode_chapter_list_html_" . md5( $base );
$base = serialize( $query_args ) . serialize( $args );
$transient_key = 'fictioneer_shortcode_chapter_list_html_' . md5( $base );
$transient = get_transient( $transient_key );
if ( ! empty( $transient ) ) {
@ -1375,28 +1374,33 @@ function fictioneer_shortcode_blog( $attr ) {
update_post_author_caches( $blog_query->posts );
}
// Pagination
$pag_args = array(
'current' => $args['page'],
'total' => $blog_query->max_num_pages,
'prev_text' => fcntr( 'previous' ),
'next_text' => fcntr( 'next' ),
'add_fragment' => '#blog'
);
// Buffer
ob_start();
if ( $blog_query->have_posts() ) {
// Start HTML ---> ?>
<section class="blog-posts _nested <?php echo $classes; ?>" id="blog">
<section class="blog-posts _nested <?php echo $args['classes']; ?>" id="blog">
<?php
while ( $blog_query->have_posts() ) {
$blog_query->the_post();
get_template_part( 'partials/_post', null, ['nested' => true] );
$pag_args = array(
'current' => max( 1, $page ),
'total' => $blog_query->max_num_pages,
'prev_text' => fcntr( 'previous' ),
'next_text' => fcntr( 'next' ),
'add_fragment' => '#blog'
);
}
wp_reset_postdata();
if ( $blog_query->max_num_pages > 1 ) {
echo '<nav class="pagination">' . fictioneer_paginate_links( $pag_args ) . '</nav>';
}
?>
<nav class="pagination"><?php echo fictioneer_paginate_links( $pag_args ); ?></nav>
</section>
<?php // <--- End HTML
} else {
@ -1497,7 +1501,7 @@ function fictioneer_shortcode_article_cards( $attr ) {
'order' => $attr['order'] ?? 'DESC',
'orderby' => $attr['orderby'] ?? 'date',
'page' => max( 1, get_query_var( 'page' ) ?: get_query_var( 'paged' ) ),
'posts_per_page' => $attr['per_page'] ?? get_option( 'posts_per_page' ),
'posts_per_page' => absint( $attr['per_page'] ?? 0 ) ?: get_option( 'posts_per_page' ),
'post_ids' => fictioneer_explode_list( $attr['post_ids'] ?? '' ),
'author_ids' => fictioneer_explode_list( $attr['author_ids'] ?? '' ),
'excluded_authors' => fictioneer_explode_list( $attr['exclude_author_ids'] ?? '' ),