This repository has been archived by the owner on Feb 23, 2024. It is now read-only.
Add Product Search Results Template #6219
Merged
Conversation
This file contains 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
Add Search Result Product Template
…products-block into add/6218-search-result-product-template
rubikuserbot
requested review from
a team and
Aljullu
and removed request for
a team
|
Size Change: 0 B Total Size: 862 kB ℹ️ View Unchanged
|
gigitux
changed the title
Aljullu
reviewed
Apr 11, 2022
| * | ||
| * @internal | ||
| */ | ||
| class SearchResultsProductTemplate { |
There was a problem hiding this comment.
Just curious, any reason why this is named SearchResultsProductTemplate? ProductSearchResultsTemplate would seem more natural to me.
There was a problem hiding this comment.
Not really. I'm not sure about the search-results-product.html filename too. I just used this for being consistent, but thinking about it, my assumption doesn't make a lot of sense 😅
| namespace Automattic\WooCommerce\Blocks\Templates; | ||
|
|
||
| /** | ||
| * ProductSearchTemplate class. |
There was a problem hiding this comment.
I guess this comment should use the name of the class?
| */ | ||
| class SearchResultsProductTemplate { | ||
|
|
||
| const SLUG = 'search-results-product'; |
There was a problem hiding this comment.
If possible, I would change the slug as well:
Suggested change
| const SLUG = 'search-results-product'; | |
| const SLUG = 'product-search-results'; |
|
|
||
| const SLUG = 'search-results-product'; | ||
| const TITLE = 'Product Search Results'; | ||
| const DESCRIPTION = 'Template used to display search results for products'; |
There was a problem hiding this comment.
Nit: missing dot in the description.
Suggested change
| const DESCRIPTION = 'Template used to display search results for products'; | |
| const DESCRIPTION = 'Template used to display search results for products.'; |
There was a problem hiding this comment.
Sidenote: it would be nice to add descriptions to all other WC templates, not in this PR, but maybe a follow-up good first issue?
There was a problem hiding this comment.
Good point, created a new issue #6233
| } | ||
|
|
||
| /** | ||
| * When the search is for products and it used a block theme the Product Search Template is rendered. |
There was a problem hiding this comment.
Small rewording suggestion:
Suggested change
| * When the search is for products and it used a block theme the Product Search Template is rendered. | |
| * When the search is for products and a block theme is active, render the Product Search Template. |
…products-block into add/6218-search-result-product-template
…woocommerce/woocommerce-gutenberg-products-block into add/6218-search-result-product-template
gigitux
force-pushed
the
add/6218-search-result-product-template
branch
from
a3b2f14
to
a063c5a
Compare
|
Thanks for the review. I added your suggestions! |
Aljullu
reviewed
Apr 13, 2022
|
|
||
| it( 'should contain the "WooCommerce Product Grid Block" classic template', async () => { | ||
| await goToTemplateEditor( { | ||
| postId: 'woocommerce/woocommerce//search-results-product', |
There was a problem hiding this comment.
Should we update the slug here too just for consistency?
…products-block into add/6218-search-result-product-template
gigitux
force-pushed
the
add/6218-search-result-product-template
branch
from
0a8f9fd
to
f1d51de
Compare
gigitux
force-pushed
the
add/6218-search-result-product-template
branch
from
f1d51de
to
392861b
Compare
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.
This PR adds a new template called
Product Search Results. This template will be rendered only on the block themes when the user lands on?s={keyword}&post_type=product.Fixes #6218
Screenshots
Product Search Results in the template list
Editor view when the user edits the Product Search Result template
Frontend side when the user lands on
?s=shirt&post_type=producturl. The template Product Search Results is renderedTesting
Automated Tests
Manual Testing
How to test the changes in this Pull Request:
Check out this branch
Twenty Twenty-Two).?s={product_to_search}&post_type=productto your website URL. For examplehttp://dev.local/?s=shirt&post_type=product. You should see a grid with the products that match the keyword (or a not found message if any product matches the keyword). Keep this page open.?s={product_to_search}&post_type=producteverything works well. IMPORTANT: Remember that for the classic themes the templates are not loaded. So the implementation of this page depends on the theme.Extendibility for the themes
With these steps, we will check that the themes can extend the new template:
Twenty Twenty-Two).Twenty Twenty-Twothe path is/themes/twentytwentytwo/.templatesand create a filesearch-results-product.htmlwith this content.?s={product_to_search}&post_type=productto your website URL. For examplehttp://dev.local/?s=shirt&post_type=product. You should see a grid with the products that match the keyword (or a not found message if any product matches the keyword) and a paragraph with the textColumn One, Paragraph One.Storefront). Check that if you visit?s={product_to_search}&post_type=producteverything works well. IMPORTANT: Remember that for the classic themes the templates are not loaded. So the implementation of this page depends on the theme.User Facing Testing
These are steps for user testing (where "user" is someone interacting with this change that is not editing any code).
Twenty Twenty-Two).?s={product_to_search}&post_type=productto your website URL. For examplehttp://dev.local/?s=shirt&post_type=product. You should see a grid with the products that match the keyword (or a not found message if any product matches the keyword). Keep this page open.Storefront). Check that if you visit?s={product_to_search}&post_type=producteverything works well. IMPORTANT: Remember that for the classic themes the templates are not loaded. So the implementation of this page depends on the theme.Changelog