This repository was archived by the owner on Feb 23, 2024. It is now read-only.
Product Collection: Add support for filtering products by featured status #11522
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Added `featured` attribute to `ProductCollectionQuery` type to enable filtering by featured status. - Implemented `FeaturedProductsControl` to provide a toggle option in the inspector controls. - Integrated `FeaturedProductsControl` into `ProductCollectionInspectorControls`. - Added `get_featured_query` function in `ProductCollection` class to generate query for fetching featured products. - Updated existing functions and queries in `ProductCollection` class to support featured products filtering.
Contributor
|
The release ZIP for this PR is accessible via: Script Dependencies ReportThere is no changed script dependency between this branch and trunk. This comment was automatically generated by the TypeScript Errors Report
🎉 🎉 This PR does not introduce new TS errors. |
imanish003
force-pushed
the
add/11358-product-collection-featured-products-filter
branch
from
3abfa1f to
9fc5471
Compare
Contributor
|
Size Change: +88 B (0%) Total Size: 1.54 MB
ℹ️ View Unchanged
|
This commit makes the handling of the 'featured' parameter consistent in the ProductCollection class. Previously, the 'featured' parameter was being type-casted to boolean, which was not necessary and could lead to incorrect results. Now, the 'featured' parameter is used directly without type-casting, and the check for 'featured' products in the get_featured_query method has been updated accordingly. This ensures that the 'featured' parameter is handled consistently and correctly throughout the class.
imanish003
added
focus: blocks
woocommercebot
requested review from
a team and
gigitux
and removed request for
a team
This commit adds null coalescing operator to handle the case when 'featured' index is not set in the $query array. This prevents potential PHP notices or errors that may arise when trying to access an undefined index.
kmanijak
suggested changes
Nov 6, 2023
Contributor
kmanijak
left a comment
kmanijak
left a comment
There was a problem hiding this comment.
It works really nice! Thanks for taking care of it!
I think the initial featured value should be added to the patterns as well. They will work fine without that but I think it's important to add them explicitly. What do you think?
Contributor
Author
|
Hi @kmanijak 👋
TBH I'm somewhat neutral on the matter. It seems reasonable to rely on the internal default values for attributes when not explicitly defined. We need to ensure that all the existing patterns still work as expected if new attribute is not defined. However, I'm open to following your suggestion. Should I go ahead & update all the patterns? 🤝 |
kmanijak
approved these changes
Nov 8, 2023
Contributor
kmanijak
left a comment
kmanijak
left a comment
There was a problem hiding this comment.
TBH I'm somewhat neutral on the matter. It seems reasonable to rely on the internal default values for attributes when not explicitly defined. We need to ensure that all the existing patterns still work as expected if new attribute is not defined. However, I'm open to following your suggestion. Should I go ahead & update all the patterns? 🤝
I don't have any other argument for that except for being explicit. Maybe that's not that important 🤔 I'm approving and leaving decision up to you 🙌
imanish003
force-pushed
the
add/11358-product-collection-featured-products-filter
branch
from
f395b63 to
d5fc783
Compare
Contributor
Author
Got it, I will keep the patterns as they are unless we want to override the default behavior using an attribute. This would also apply to synced patterns created by users and third-party developers. 🙂 |
imanish003
deleted the
add/11358-product-collection-featured-products-filter
branch
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
This PR introduces a new filter that allows users to filter products by their featured status. Specifically, the following changes have been made:
featuredattribute to theProductCollectionQuerytype, enabling filtering by featured status.FeaturedProductsControlto provide a toggle option in the inspector controls.ProductCollection.phpto support featured products filtering.Fixes #11358
Why
These changes allow merchants to easily display only featured products in their product collections, enhancing flexibility.
Testing Instructions
Please consider any edge cases this change may have, and also other areas of the product this may impact.
Case 1: Normal
Case 2: Resetting the value of the Featured filter
Case 3: Ensuring older blocks aren't broken (To be tested by developers only)
add/11358-product-collection-featured-products-filter.Screenshots or screencast
WooCommerce Visibility
Required:
Checklist
Required:
[type]label or a[skip-changelog]label.Conditional:
[skip-changelog]label is not present).Changelog