add option to exclude current post from query block

g-elwell · Aug 29, 2024 · c213872 · c213872
1 parent 520fa41
commit c213872
Show file tree

Hide file tree

Showing 6 changed files with 46 additions and 1 deletion.
diff --git a/gutenberg.php b/gutenberg.php
@@ -74,3 +74,16 @@ function gutenberg_pre_init() {
 
 	require_once __DIR__ . '/lib/load.php';
 }
+
+/**
+ * This is included for demonstration purposes only.
+ * We should make this change in the core `build_query_vars_from_query_block` function.
+ */
+function filter_query_block_exclude_current( $query, $block ) {
+	if ( isset( $block->context['query']['excludeCurrent'] ) && $block->context['query']['excludeCurrent'] ) {
+		$query['post__not_in'] = array( get_the_ID() );
+	}
+
+	return $query;
+}
+add_filter( 'query_loop_block_query_vars', 'filter_query_block_exclude_current', 10, 2 );
diff --git a/packages/block-library/package.json b/packages/block-library/package.json
@@ -45,6 +45,7 @@
 		"@wordpress/date": "file:../date",
 		"@wordpress/deprecated": "file:../deprecated",
 		"@wordpress/dom": "file:../dom",
+		"@wordpress/editor": "file:../editor",
 		"@wordpress/element": "file:../element",
 		"@wordpress/escape-html": "file:../escape-html",
 		"@wordpress/hooks": "file:../hooks",

diff --git a/packages/block-library/src/post-template/edit.js b/packages/block-library/src/post-template/edit.js
@@ -19,6 +19,7 @@ import {
 } from '@wordpress/block-editor';
 import { Spinner, ToolbarGroup } from '@wordpress/components';
 import { store as coreStore } from '@wordpress/core-data';
+import { store as editorStore } from '@wordpress/editor';
 import { list, grid } from '@wordpress/icons';
 
 const TEMPLATE = [
@@ -85,6 +86,7 @@ export default function PostTemplateEdit( {
 			author,
 			search,
 			exclude,
+			excludeCurrent,
 			sticky,
 			inherit,
 			taxQuery,
@@ -109,6 +111,7 @@ export default function PostTemplateEdit( {
 		( select ) => {
 			const { getEntityRecords, getTaxonomies } = select( coreStore );
 			const { getBlocks } = select( blockEditorStore );
+			const { getCurrentPostId } = select( editorStore );
 			const templateCategory =
 				inherit &&
 				templateSlug?.startsWith( 'category-' ) &&
@@ -160,6 +163,13 @@ export default function PostTemplateEdit( {
 			if ( exclude?.length ) {
 				query.exclude = exclude;
 			}
+			if ( excludeCurrent ) {
+				if ( query.exclude ) {
+					query.exclude = [ ...query.exclude, getCurrentPostId() ];
+				} else {
+					query.exclude = [ getCurrentPostId() ];
+				}
+			}
 			if ( parents?.length ) {
 				query.parent = parents;
 			}

diff --git a/packages/block-library/src/query/block.json b/packages/block-library/src/query/block.json
@@ -25,7 +25,8 @@
 				"sticky": "",
 				"inherit": true,
 				"taxQuery": null,
-				"parents": []
+				"parents": [],
+				"excludeCurrent": false
 			}
 		},
 		"tagName": {

diff --git a/packages/block-library/src/query/edit/inspector-controls/index.js b/packages/block-library/src/query/edit/inspector-controls/index.js
@@ -9,6 +9,7 @@ import {
 	__experimentalToggleGroupControl as ToggleGroupControl,
 	__experimentalToggleGroupControlOption as ToggleGroupControlOption,
 	Notice,
+	ToggleControl,
 	__experimentalToolsPanel as ToolsPanel,
 	__experimentalToolsPanelItem as ToolsPanelItem,
 } from '@wordpress/components';
@@ -58,6 +59,7 @@ export default function QueryInspectorControls( props ) {
 		inherit,
 		taxQuery,
 		parents,
+		excludeCurrent,
 	} = query;
 	const allowedControls = useAllowedControls( attributes );
 	const [ showSticky, setShowSticky ] = useState( postType === 'post' );
@@ -119,6 +121,8 @@ export default function QueryInspectorControls( props ) {
 		! inherit &&
 		showSticky &&
 		isControlAllowed( allowedControls, 'sticky' );
+	const showExcludeCurrentControl =
+		! inherit && isControlAllowed( allowedControls, 'excludeCurrent' );
 	const showSettingsPanel =
 		showInheritControl ||
 		showPostTypeControl ||
@@ -262,6 +266,21 @@ export default function QueryInspectorControls( props ) {
 							}
 						/>
 					) }
+					{ showExcludeCurrentControl && (
+						<ToggleControl
+							__nextHasNoMarginBottom
+							label={ __( 'Exclude current post' ) }
+							help={ __(
+								'Exclude the current post from the query.'
+							) }
+							checked={ excludeCurrent }
+							onChange={ ( value ) => {
+								setQuery( {
+									excludeCurrent: !! value,
+								} );
+							} }
+						/>
+					) }
 					<EnhancedPaginationControl
 						enhancedPagination={ enhancedPagination }
 						setAttributes={ setAttributes }

diff --git a/packages/block-library/src/query/index.js b/packages/block-library/src/query/index.js
@@ -34,6 +34,7 @@ export const settings = {
 				search: '',
 				sticky: 'exclude',
 				inherit: false,
+				excludeCurrent: false,
 			},
 		},
 		innerBlocks: [