Skip to content

Commit

Permalink
feat(homepage-posts): add custom taxonomy exclusions filter (#1641)
Browse files Browse the repository at this point in the history 
This PR adds custom taxonomy exclusions to the Homepage Posts block, providing some more flexibility for the type of content that can be displayed (or not displayed) via the block.
  • Loading branch information
@chickenn00dle @dkoo
chickenn00dle authored and dkoo committed Jan 24, 2024
1 parent f5c707e commit 947ed9a
Show file tree
Hide file tree
Showing 7 changed files with 91 additions and 21 deletions.
34 changes: 23 additions & 11 deletions includes/class-newspack-blocks.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -625,17 +625,18 @@ public static function build_articles_query( $attributes, $block_name ) {
if ( current_user_can( 'edit_others_posts' ) && isset( $attributes['includedPostStatuses'] ) ) {
$included_post_statuses = $attributes['includedPostStatuses'];
}
$authors = isset( $attributes['authors'] ) ? $attributes['authors'] : array();
$categories = isset( $attributes['categories'] ) ? $attributes['categories'] : array();
$include_subcategories = isset( $attributes['includeSubcategories'] ) ? intval( $attributes['includeSubcategories'] ) : false;
$tags = isset( $attributes['tags'] ) ? $attributes['tags'] : array();
$custom_taxonomies = isset( $attributes['customTaxonomies'] ) ? $attributes['customTaxonomies'] : array();
$tag_exclusions = isset( $attributes['tagExclusions'] ) ? $attributes['tagExclusions'] : array();
$category_exclusions = isset( $attributes['categoryExclusions'] ) ? $attributes['categoryExclusions'] : array();
$specific_posts = isset( $attributes['specificPosts'] ) ? $attributes['specificPosts'] : array();
$posts_to_show = intval( $attributes['postsToShow'] );
$specific_mode = isset( $attributes['specificMode'] ) ? intval( $attributes['specificMode'] ) : false;
$args = array(
$authors = isset( $attributes['authors'] ) ? $attributes['authors'] : array();
$categories = isset( $attributes['categories'] ) ? $attributes['categories'] : array();
$include_subcategories = isset( $attributes['includeSubcategories'] ) ? intval( $attributes['includeSubcategories'] ) : false;
$tags = isset( $attributes['tags'] ) ? $attributes['tags'] : array();
$custom_taxonomies = isset( $attributes['customTaxonomies'] ) ? $attributes['customTaxonomies'] : array();
$tag_exclusions = isset( $attributes['tagExclusions'] ) ? $attributes['tagExclusions'] : array();
$category_exclusions = isset( $attributes['categoryExclusions'] ) ? $attributes['categoryExclusions'] : array();
$custom_taxonomy_exclusions = isset( $attributes['customTaxonomyExclusions'] ) ? $attributes['customTaxonomyExclusions'] : array();
$specific_posts = isset( $attributes['specificPosts'] ) ? $attributes['specificPosts'] : array();
$posts_to_show = intval( $attributes['postsToShow'] );
$specific_mode = isset( $attributes['specificMode'] ) ? intval( $attributes['specificMode'] ) : false;
$args = array(
'post_type' => $post_type,
'post_status' => $included_post_statuses,
'suppress_filters' => false,
Expand Down Expand Up @@ -694,6 +695,17 @@ public static function build_articles_query( $attributes, $block_name ) {
}
}
}
if ( $custom_taxonomy_exclusions && count( $custom_taxonomy_exclusions ) ) {
foreach ( $custom_taxonomy_exclusions as $exclusion ) {
$args['tax_query'][] = [
'field' => 'term_id',
'include_children' => false,
'operator' => 'NOT IN',
'taxonomy' => $exclusion['slug'],
'terms' => $exclusion['terms'],
];
}
}

$is_co_authors_plus_active = class_exists( 'CoAuthors_Guest_Authors' );

Expand Down
18 changes: 18 additions & 0 deletions src/blocks/homepage-articles/block.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,24 @@
"default": [],
"items": { "type": "integer" }
},
"customTaxonomyExclusions": {
"type": "array",
"default": [],
"items": {
"type": "object",
"properties": {
"slug": {
"type": "string"
},
"terms": {
"type": "array",
"items": {
"type": "integer"
}
}
}
}
},
"specificPosts": {
"type": "array",
"default": [],
Expand Down
2 changes: 1 addition & 1 deletion src/blocks/homepage-articles/class-wp-rest-newspack-articles-controller.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ public function get_items( $request ) {
array_merge(
array_map(
function( $attribute ) {
return false === $attribute ? '0' : str_replace( '#', '%23', $attribute );
return false === $attribute ? '0' : $attribute;
},
$attributes
),
Expand Down
3 changes: 3 additions & 0 deletions src/blocks/homepage-articles/edit.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -293,6 +293,7 @@ class Edit extends Component {
tags,
tagExclusions,
categoryExclusions,
customTaxonomyExclusions,
} = attributes;

const imageSizeOptions = [
Expand Down Expand Up @@ -370,6 +371,8 @@ class Edit extends Component {
onTagExclusionsChange={ handleAttributeChange( 'tagExclusions' ) }
categoryExclusions={ categoryExclusions }
onCategoryExclusionsChange={ handleAttributeChange( 'categoryExclusions' ) }
customTaxonomyExclusions={ customTaxonomyExclusions }
onCustomTaxonomyExclusionsChange={ handleAttributeChange( 'customTaxonomyExclusions' ) }
postType={ postType }
/>
{ postLayout === 'grid' && (
Expand Down
4 changes: 4 additions & 0 deletions src/blocks/homepage-articles/utils.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ const POST_QUERY_ATTRIBUTES = [
'specificMode',
'tagExclusions',
'categoryExclusions',
'customTaxonomyExclusions',
'postType',
'includedPostStatuses',
'deduplicate',
Expand All @@ -55,6 +56,7 @@ type HomepageArticlesAttributes = {
specificMode: boolean;
tagExclusions: TagId[];
categoryExclusions: CategoryId[];
customTaxonomyExclusions: Taxonomy[];
};

type HomepageArticlesProps = {
Expand Down Expand Up @@ -100,6 +102,7 @@ export const queryCriteriaFromAttributes = ( attributes: Block[ 'attributes' ] )
specificMode,
tagExclusions,
categoryExclusions,
customTaxonomyExclusions,
includedPostStatuses,
} = pick( attributes, POST_QUERY_ATTRIBUTES );

Expand All @@ -120,6 +123,7 @@ export const queryCriteriaFromAttributes = ( attributes: Block[ 'attributes' ] )
tags,
tagExclusions,
categoryExclusions,
customTaxonomyExclusions,
customTaxonomies,
postType,
includedPostStatuses,
Expand Down
2 changes: 1 addition & 1 deletion src/blocks/homepage-articles/view.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,7 @@ function newspack_blocks_render_block_homepage_articles( $attributes ) {
array_merge(
array_map(
function( $attribute ) {
return false === $attribute ? '0' : str_replace( '#', '%23', $attribute );
return false === $attribute ? '0' : $attribute;
},
$attributes
),
Expand Down
49 changes: 41 additions & 8 deletions src/components/query-controls.js
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* WordPress dependencies
*/
import { __ } from '@wordpress/i18n';
import { __, sprintf } from '@wordpress/i18n';
import { Component } from '@wordpress/element';
import { Button, QueryControls as BasicQueryControls, ToggleControl } from '@wordpress/components';
import apiFetch from '@wordpress/api-fetch';
Expand Down Expand Up @@ -233,20 +233,22 @@ class QueryControls extends Component {
onTagExclusionsChange,
categoryExclusions,
onCategoryExclusionsChange,
customTaxonomyExclusions,
onCustomTaxonomyExclusionsChange,
enableSpecific,
} = this.props;
const { showAdvancedFilters } = this.state;

const registeredCustomTaxonomies = window.newspack_blocks_data?.custom_taxonomies;

const customTaxonomiesPrepareChange = ( taxSlug, value ) => {
let newValue = customTaxonomies.filter( tax => tax.slug !== taxSlug );
const customTaxonomiesPrepareChange = ( taxArr, taxHandler, taxSlug, value ) => {
let newValue = taxArr.filter( tax => tax.slug !== taxSlug );
newValue = [ ...newValue, { slug: taxSlug, terms: value } ];
onCustomTaxonomiesChange( newValue );
taxHandler( newValue );
};

const getTermsOfCustomTaxonomy = taxSlug => {
const tax = customTaxonomies.find( taxObj => taxObj.slug === taxSlug );
const getTermsOfCustomTaxonomy = ( taxArr, taxSlug ) => {
const tax = taxArr.find( taxObj => taxObj.slug === taxSlug );
return tax ? tax.terms : [];
};

Expand Down Expand Up @@ -312,9 +314,14 @@ class QueryControls extends Component {
registeredCustomTaxonomies.map( tax => (
<AutocompleteTokenField
key={ `${ customTaxonomies[ tax.slug ] }-selector` }
tokens={ getTermsOfCustomTaxonomy( tax.slug ) }
tokens={ getTermsOfCustomTaxonomy( customTaxonomies, tax.slug ) }
onChange={ value => {
customTaxonomiesPrepareChange( tax.slug, value );
customTaxonomiesPrepareChange(
customTaxonomies,
onCustomTaxonomiesChange,
tax.slug,
value
);
} }
fetchSuggestions={ search =>
this.fetchCustomTaxonomiesSuggestions( tax.slug, search )
Expand Down Expand Up @@ -355,6 +362,31 @@ class QueryControls extends Component {
label={ __( 'Excluded Categories', 'newspack-blocks' ) }
/>
) }
{ registeredCustomTaxonomies &&
onCustomTaxonomyExclusionsChange &&
registeredCustomTaxonomies.map( ( { label, slug } ) => (
<AutocompleteTokenField
fetchSavedInfo={ termIds => this.fetchSavedCustomTaxonomies( slug, termIds ) }
fetchSuggestions={ search =>
this.fetchCustomTaxonomiesSuggestions( slug, search )
}
key={ `${ slug }-exclusions-selector` }
label={ sprintf(
// translators: %s is the custom taxonomy label.
__( 'Excluded %s', 'newspack-blocks' ),
label
) }
onChange={ value =>
customTaxonomiesPrepareChange(
customTaxonomyExclusions,
onCustomTaxonomyExclusionsChange,
slug,
value
)
}
tokens={ getTermsOfCustomTaxonomy( customTaxonomyExclusions, slug ) }
/>
) ) }
</>
) }
</>
Expand All @@ -372,6 +404,7 @@ QueryControls.defaultProps = {
tags: [],
customTaxonomies: [],
tagExclusions: [],
customTaxonomyExclusions: [],
};

export default QueryControls;

0 comments on commit 947ed9a

Please sign in to comment.