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

Add cache parameter to shortcodes

Browse Source
This commit is contained in:
Tetrakern 2024-09-07 00:28:36 +02:00
parent 1a4ca6bcd5
commit 4620a82cec
2 changed files with 38 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
DOCUMENTATION.md
View File

@ -714,6 +714,7 @@ Renders the action row of the specified story. All buttons and links will work a
* **download:** Whether to render the ePUB/eBook download button (if enabled). Default `true`.
* **rss:** Whether to render the RSS link (if enabled). Default `true`.
* **share:** Whether to render the Share modal button (if enabled). Default `true`.
* **cache:** Whether the shortcode should be cached. Default `true`.
```
[fictioneer_story_actions story_id="106"]
@ -733,6 +734,7 @@ Renders the chapters, groups, and tabs of the specified story. It will look just
* **blog:** Whether to render the blog tab. Default `false`.
* **pages:** Whether to render the custom page tabs. Default `false`.
* **scheduled:** Whether to render the scheduled chapter note. Default `false`.
* **cache:** Whether the shortcode should be cached. Default `true`.
```
[fictioneer_story_section story_id="106"]
@ -843,6 +845,7 @@ Renders a multi-column grid of paginated medium cards ordered by publishing date
* **aspect_ratio:** CSS [aspect-ratio](https://developer.mozilla.org/en-US/docs/Web/CSS/aspect-ratio) value for the image (X/Y). Default `3/1`.
* **class:** Additional CSS classes, separated by whitespace.
* **splide:** Configuration JSON to turn the grid into a slider. See [Slider](#slider).
* **cache:** Whether the shortcode should be cached. Default `true`.
```
[fictioneer_article_cards]
@ -879,6 +882,7 @@ Renders paginated blog posts akin to the main blog page, but with options. Only
* **tags:** Comma-separated list of tag names (case-insensitive), if you want to pick from a curated pool.
* **rel:** Relationship between different taxonomies, either `AND` or `OR`. Default `AND`.
* **class:** Additional CSS classes, separated by whitespace.
* **cache:** Whether the shortcode should be cached. Default `true`.
```
[fictioneer_blog]
@ -926,6 +930,7 @@ Renders a list of chapters identical to those on story pages, ordered by sequenc
* **heading:** Show a heading with collapse toggle above the list.
* **group:** Only show chapters with a specific group name, which can transcend stories.
* **class:** Additional CSS classes, separated by whitespace. `no-auto-collapse` prevents default group collapsing (if set).
* **cache:** Whether the shortcode should be cached. Default `true`.
```
[fictioneer_chapter_list story="69"]
@ -1018,6 +1023,7 @@ Renders a multi-column grid of small cards, showing the latest four chapters ord
* **aspect_ratio:** CSS [aspect-ratio](https://developer.mozilla.org/en-US/docs/Web/CSS/aspect-ratio) value for the image (X/Y; vertical only). Default `3/1`.
* **class:** Additional CSS classes, separated by whitespace.
* **splide:** Configuration JSON to turn the grid into a slider. See [Slider](#slider).
* **cache:** Whether the shortcode should be cached. Default `true`.
```
[fictioneer_latest_chapters]
@ -1064,6 +1070,7 @@ Renders the last blog post or a list of blog posts, ignoring sticky posts, order
* **tags:** Comma-separated list of tag names (case-insensitive), if you want to pick from a curated pool.
* **rel:** Relationship between different taxonomies, either `AND` or `OR`. Default `AND`.
* **class:** Additional CSS classes, separated by whitespace.
* **cache:** Whether the shortcode should be cached. Default `true`.
```
[fictioneer_latest_posts]
@ -1110,6 +1117,7 @@ Renders a multi-column grid of small cards, showing the latest four recommendati
* **aspect_ratio:** CSS [aspect-ratio](https://developer.mozilla.org/en-US/docs/Web/CSS/aspect-ratio) value for the image (X/Y; vertical only). Default `3/1`.
* **class:** Additional CSS classes, separated by whitespace.
* **splide:** Configuration JSON to turn the grid into a slider. See [Slider](#slider).
* **cache:** Whether the shortcode should be cached. Default `true`.
```
[fictioneer_latest_recommendations]
@ -1170,6 +1178,7 @@ Renders a multi-column grid of small cards, showing the latest four stories orde
* **aspect_ratio:** CSS [aspect-ratio](https://developer.mozilla.org/en-US/docs/Web/CSS/aspect-ratio) value for the image (X/Y; vertical only). Default `3/1`.
* **class:** Additional CSS classes, separated by whitespace.
* **splide:** Configuration JSON to turn the grid into a slider. See [Slider](#slider).
* **cache:** Whether the shortcode should be cached. Default `true`.
```
[fictioneer_latest_stories]
@ -1248,6 +1257,7 @@ Renders a multi-column grid of small cards, showing the latest four updated stor
* **footer_rating:** Whether to show the story age rating. Default `true`.
* **class:** Additional CSS classes, separated by whitespace.
* **splide:** Configuration JSON to turn the grid into a slider. See [Slider](#slider).
* **cache:** Whether the shortcode should be cached. Default `true`.
```
[fictioneer_latest_updates]
@ -1342,6 +1352,7 @@ Renders dynamic grid of thumbnails with title, showing the latest eight posts of
* **width:** Override the item minimum width (it will still be stretched to fill the space).
* **class:** Additional CSS classes, separated by whitespace.
* **splide:** Configuration JSON to turn the grid into a slider. See [Slider](#slider).
* **cache:** Whether the shortcode should be cached. Default `true`.
```
[fictioneer_showcase for="collections"]

50
includes/functions/_setup-shortcodes.php
View File

@ -216,7 +216,8 @@ function fictioneer_get_default_shortcode_args( $attr, $def_count = -1 ) {
'classes' => esc_attr( wp_strip_all_tags( $attr['classes'] ?? $attr['class'] ?? '' ) ),
'infobox' => filter_var( $attr['infobox'] ?? 1, FILTER_VALIDATE_BOOLEAN ),
'source' => filter_var( $attr['source'] ?? 1, FILTER_VALIDATE_BOOLEAN ),
'splide' => sanitize_text_field( $attr['splide'] ?? '' )
'splide' => sanitize_text_field( $attr['splide'] ?? '' ),
'cache' => filter_var( $attr['cache'] ?? 1, FILTER_VALIDATE_BOOLEAN )
);
//--- Fixes ------------------------------------------------------------------
@ -453,7 +454,7 @@ function fictioneer_shortcode_showcase( $attr ) {
}
// Transient?
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED ) {
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED && $args['cache'] ) {
$base = serialize( $args ) . serialize( $attr );
$type = $args['post_type'];
$transient_key = "fictioneer_shortcode_showcase_{$type}_html_" . md5( $base );
@ -475,7 +476,7 @@ function fictioneer_shortcode_showcase( $attr ) {
$html .= '<script class="temp-script">document.querySelectorAll(".splide:not(.no-auto-splide, .is-initialized)").forEach(e=>{"undefined"!=typeof Splide&&new Splide(e).mount()}),document.querySelector(".temp-script").remove();</script>';
}
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED ) {
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED && $args['cache'] ) {
set_transient( $transient_key, $html, FICTIONEER_SHORTCODE_TRANSIENT_EXPIRATION );
}
@ -548,7 +549,7 @@ function fictioneer_shortcode_latest_chapters( $attr ) {
}
// Transient?
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED ) {
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED && $args['cache'] ) {
$base = serialize( $args ) . serialize( $attr );
$transient_key = "fictioneer_shortcode_latest_chapters_{$type}_html_" . md5( $base );
$transient = get_transient( $transient_key );
@ -579,7 +580,7 @@ function fictioneer_shortcode_latest_chapters( $attr ) {
$html .= '<script class="temp-script">document.querySelectorAll(".splide:not(.no-auto-splide, .is-initialized)").forEach(e=>{"undefined"!=typeof Splide&&new Splide(e).mount()}),document.querySelector(".temp-script").remove();</script>';
}
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED ) {
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED && $args['cache'] ) {
set_transient( $transient_key, $html, FICTIONEER_SHORTCODE_TRANSIENT_EXPIRATION );
}
@ -655,7 +656,7 @@ function fictioneer_shortcode_latest_stories( $attr ) {
}
// Transient?
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED ) {
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED && $args['cache'] ) {
$base = serialize( $args ) . serialize( $attr );
$transient_key = "fictioneer_shortcode_latest_stories_{$type}_html_" . md5( $base );
$transient = get_transient( $transient_key );
@ -685,7 +686,7 @@ function fictioneer_shortcode_latest_stories( $attr ) {
$html .= '<script class="temp-script">document.querySelectorAll(".splide:not(.no-auto-splide, .is-initialized)").forEach(e=>{"undefined"!=typeof Splide&&new Splide(e).mount()}),document.querySelector(".temp-script").remove();</script>';
}
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED ) {
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED && $args['cache'] ) {
set_transient( $transient_key, $html, FICTIONEER_SHORTCODE_TRANSIENT_EXPIRATION );
}
@ -764,7 +765,7 @@ function fictioneer_shortcode_latest_story_updates( $attr ) {
}
// Transient?
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED ) {
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED && $args['cache'] ) {
$base = serialize( $args ) . serialize( $attr );
$transient_key = "fictioneer_shortcode_latest_updates_{$type}_html_" . md5( $base );
$transient = get_transient( $transient_key );
@ -794,7 +795,7 @@ function fictioneer_shortcode_latest_story_updates( $attr ) {
$html .= '<script class="temp-script">document.querySelectorAll(".splide:not(.no-auto-splide, .is-initialized)").forEach(e=>{"undefined"!=typeof Splide&&new Splide(e).mount()}),document.querySelector(".temp-script").remove();</script>';
}
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED ) {
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED && $args['cache'] ) {
set_transient( $transient_key, $html, FICTIONEER_SHORTCODE_TRANSIENT_EXPIRATION );
}
@ -859,7 +860,7 @@ function fictioneer_shortcode_latest_recommendations( $attr ) {
}
// Transient?
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED ) {
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED && $args['cache'] ) {
$base = serialize( $args ) . serialize( $attr );
$transient_key = "fictioneer_shortcode_latest_recommendations_{$type}_html_" . md5( $base );
$transient = get_transient( $transient_key );
@ -886,7 +887,7 @@ function fictioneer_shortcode_latest_recommendations( $attr ) {
$html .= '<script class="temp-script">document.querySelectorAll(".splide:not(.no-auto-splide, .is-initialized)").forEach(e=>{"undefined"!=typeof Splide&&new Splide(e).mount()}),document.querySelector(".temp-script").remove();</script>';
}
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED ) {
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED && $args['cache'] ) {
set_transient( $transient_key, $html, FICTIONEER_SHORTCODE_TRANSIENT_EXPIRATION );
}
@ -927,7 +928,7 @@ function fictioneer_shortcode_latest_posts( $attr ) {
$args = fictioneer_get_default_shortcode_args( $attr, 1 );
// Transient?
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED ) {
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED && $args['cache'] ) {
$base = serialize( $args ) . serialize( $attr );
$transient_key = "fictioneer_shortcode_latest_posts_html_" . md5( $base );
$transient = get_transient( $transient_key );
@ -944,7 +945,7 @@ function fictioneer_shortcode_latest_posts( $attr ) {
$html = fictioneer_minify_html( ob_get_clean() );
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED ) {
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED && $args['cache'] ) {
set_transient( $transient_key, $html, FICTIONEER_SHORTCODE_TRANSIENT_EXPIRATION );
}
@ -1085,6 +1086,7 @@ function fictioneer_shortcode_chapter_list( $attr ) {
}
// Setup
$cache = filter_var( $attr['cache'] ?? 1, FILTER_VALIDATE_BOOLEAN );
$count = max( -1, intval( $attr['count'] ?? -1 ) );
$offset = max( 0, intval( $attr['offset'] ?? 0 ) );
$group = empty( $attr['group'] ) ? false : strtolower( trim( $attr['group'] ) );
@ -1147,7 +1149,7 @@ function fictioneer_shortcode_chapter_list( $attr ) {
);
// Transient?
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED ) {
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED && $cache ) {
$base = serialize( $query_args ) . serialize( $attr ) . $classes;
$base .= ( $hide_icons ? '1' : '0' ) . ( $can_checkmarks ? '1' : '0' );
$transient_key = "fictioneer_shortcode_chapter_list_html_" . md5( $base );
@ -1302,7 +1304,7 @@ function fictioneer_shortcode_chapter_list( $attr ) {
// Store buffer
$html = fictioneer_minify_html( ob_get_clean() );
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED ) {
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED && $cache ) {
set_transient( $transient_key, $html, FICTIONEER_SHORTCODE_TRANSIENT_EXPIRATION );
}
@ -1575,7 +1577,7 @@ function fictioneer_shortcode_blog( $attr ) {
$query_args = apply_filters( 'fictioneer_filter_shortcode_blog_query_args', $query_args, $args );
// Transient?
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED ) {
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED && $args['cache'] ) {
$base = serialize( $query_args ) . serialize( $args ) . serialize( $attr );
$transient_key = 'fictioneer_shortcode_blog_html_' . md5( $base );
$transient = get_transient( $transient_key );
@ -1636,7 +1638,7 @@ function fictioneer_shortcode_blog( $attr ) {
// Store buffer
$html = fictioneer_minify_html( ob_get_clean() );
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED ) {
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED && $args['cache'] ) {
set_transient( $transient_key, $html, FICTIONEER_SHORTCODE_TRANSIENT_EXPIRATION );
}
@ -1739,7 +1741,7 @@ function fictioneer_shortcode_article_cards( $attr ) {
}
// Transient?
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED ) {
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED && $args['cache'] ) {
$base = serialize( $args ) . serialize( $attr );
$transient_key = "fictioneer_shortcode_article_cards_html_" . md5( $base );
$transient = get_transient( $transient_key );
@ -1760,7 +1762,7 @@ function fictioneer_shortcode_article_cards( $attr ) {
$html .= '<script class="temp-script">document.querySelectorAll(".splide:not(.no-auto-splide, .is-initialized)").forEach(e=>{"undefined"!=typeof Splide&&new Splide(e).mount()}),document.querySelector(".temp-script").remove();</script>';
}
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED ) {
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED && $args['cache'] ) {
set_transient( $transient_key, $html, FICTIONEER_SHORTCODE_TRANSIENT_EXPIRATION );
}
@ -1801,6 +1803,7 @@ function fictioneer_shortcode_story_section( $attr ) {
}
// Setup
$cache = filter_var( $attr['cache'] ?? 1, FILTER_VALIDATE_BOOLEAN );
$story_id = fictioneer_validate_id( $attr['story_id'] ?? 0, 'fcn_story' );
$post = get_post( $story_id );
$story_data = fictioneer_get_story_data( $story_id );
@ -1830,7 +1833,7 @@ function fictioneer_shortcode_story_section( $attr ) {
}
// Transient?
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED ) {
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED && $cache ) {
$base = serialize( $attr ) . $classes;
$transient_key = "fictioneer_shortcode_story_section_html_" . md5( $base );
$transient = get_transient( $transient_key );
@ -1878,7 +1881,7 @@ function fictioneer_shortcode_story_section( $attr ) {
wp_reset_postdata();
// Cache in Transient
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED ) {
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED && $cache ) {
set_transient( $transient_key, $html, FICTIONEER_SHORTCODE_TRANSIENT_EXPIRATION );
}
@ -1919,6 +1922,7 @@ function fictioneer_shortcode_story_actions( $attr ) {
}
// Setup
$cache = filter_var( $attr['cache'] ?? 1, FILTER_VALIDATE_BOOLEAN );
$story_id = fictioneer_validate_id( $attr['story_id'] ?? 0, 'fcn_story' );
$story_data = fictioneer_get_story_data( $story_id );
$classes = wp_strip_all_tags( $attr['class'] ?? '' );
@ -1949,7 +1953,7 @@ function fictioneer_shortcode_story_actions( $attr ) {
);
// Transient?
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED ) {
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED && $cache ) {
$base = serialize( $attr ) . $classes;
$transient_key = "fictioneer_shortcode_story_actions_html_" . md5( $base );
$transient = get_transient( $transient_key );
@ -1974,7 +1978,7 @@ function fictioneer_shortcode_story_actions( $attr ) {
$html = fictioneer_minify_html( $html );
// Cache in Transient
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED ) {
if ( FICTIONEER_SHORTCODE_TRANSIENTS_ENABLED && $cache ) {
set_transient( $transient_key, $html, FICTIONEER_SHORTCODE_TRANSIENT_EXPIRATION );
}