Merge pull request #155 from ryanwelcher/fix/only-cache-when-control-is-enabled

Fix and improve caching controls

Author: ryanwelcher

includes/query-loop.php

@@ -179,6 +179,8 @@ function ( $null_return, $query ) {
 
 		if ( ! $query->is_admin &&
 			isset( $query->query['is_aql'] ) &&
+			isset( $query->query['enable_caching'] ) &&
+			true === $query->query['enable_caching'] &&
 			! isset( $_GET['context'] ) && // phpcs:ignore
 			! isset( $_GET['canvas'] ) // phpcs:ignore
 		) {
@@ -204,6 +206,8 @@ function ( $null_return, $query ) {
 	function ( $posts, $query ) {
 		if ( ! $query->is_admin &&
 			isset( $query->query['is_aql'] ) &&
+			isset( $query->query['enable_caching'] ) &&
+			true === $query->query['enable_caching'] &&
 			! isset( $_GET['context'] ) && // phpcs:ignore
 			! isset( $_GET['canvas'] ) // phpcs:ignore
 		) {

readme.md

@@ -65,7 +65,11 @@ Sort in ascending or descending order by:
 
 #### Disable Pagination
 
-Improve the performance of the query by disabling pagination. This is done automatically when there is now Pagination block in teh Post Template.
+Improve the performance of the query by disabling pagination.
+
+#### Enable Caching
+
+Store query results in a transient for one hour to reduce database load on subsequent page loads. The caching toggle is unavailable when the order is set to Random, and switching to Random order will clear any existing caching setting. Found in the **AQL: Performance Controls** panel.
 
 ## Filtering the available controls
 
@@ -103,6 +107,7 @@ add_filter(
 -   `'date_query_dynamic_range'`
 -   `'date_query_relationship'`
 -   `'pagination'`
+-   `'enable_caching'`
 
 ## Extending AQL
 

readme.txt

@@ -86,9 +86,9 @@ Sort your content exactly how you want:
 
 ==== ⚡ Performance Optimization ====
 
-* **Smart pagination**: Automatically disable pagination when not needed
+* **Disable pagination**: Reduce query overhead by turning off pagination when it is not needed
+* **Enable caching**: Store query results in a transient for one hour to reduce database load on subsequent page loads. The caching toggle is unavailable when the order is set to Random, and switching to Random order will clear any existing caching setting
 * **Efficient queries**: Optimized database queries for better performance
-* **Caching friendly**: Works seamlessly with popular caching plugins
 
 === Customization & Extensibility ===
 
@@ -116,11 +116,13 @@ add_filter(
 * `'post_meta_query'` - Meta field queries
 * `'post_order'` - Sorting options
 * `'exclude_current_post'` - Current post exclusion
+* `'exclude_posts'` - Exclude a curated list of posts
 * `'include_posts'` - Manual post inclusion
 * `'child_items_only'` - Child post filtering
 * `'date_query_dynamic_range'` - Date range queries
 * `'date_query_relationship'` - Date query logic
 * `'pagination'` - Pagination controls
+* `'enable_caching'` - Query result caching
 
 ==== Developer-Friendly ====
 

src/components/performance-controls.js

@@ -11,17 +11,33 @@ import {
 
 import { __ } from '@wordpress/i18n';
 
-export const PerformanceControls = ( { attributes, setAttributes } ) => {
+export const PerformanceControls = ( {
+	attributes,
+	setAttributes,
+	allowedControls,
+} ) => {
 	const { query: { enable_caching: enableCaching, orderBy } = {} } =
 		attributes;
+
+	if ( ! allowedControls.includes( 'enable_caching' ) ) {
+		return null;
+	}
+
 	return (
 		<ToolsPanel
-			label={ __( 'AQL: Performance Controls' ) }
-			resetAll={ () => {} }
+			label={ __( 'AQL: Performance Controls', 'advanced-query-loop' ) }
+			resetAll={ () =>
+				setAttributes( {
+					query: {
+						...attributes.query,
+						enable_caching: false,
+					},
+				} )
+			}
 		>
 			<ToolsPanelItem
 				hasValue={ () => !! enableCaching }
-				label={ __( 'Caching' ) }
+				label={ __( 'Caching', 'advanced-query-loop' ) }
 				onDeselect={ () =>
 					setAttributes( {
 						query: {

src/components/post-order-controls.js

@@ -94,6 +94,9 @@ export const PostOrderControls = ( {
 						query: {
 							...attributes.query,
 							orderBy: newOrderBy,
+							...( newOrderBy === 'rand' && {
+								enable_caching: false,
+							} ),
 						},
 					} );
 				} }