Add product archive header template and re-hook

[tommyferry]

Moves the product taxonomy archive header into its own template file, creates a related output function, and then re-hooks the new template back into the archive-product.php file in the same place, via the new woocommerce_shop_loop_header hook.

This is so that this template part can be removed/unhooked via the remove_action function, which is a cleaner approach than template overrides or additional style changes. Moreover, this is consistent with the rest of the archive-product.php template, which is already being rendered via actions.

All Submissions:

• Have you followed the WooCommerce Contributing guideline?
• Does your code follow the WordPress' coding standards?
• Have you checked to ensure there aren't other open Pull Requests for the same update/change?

Changes proposed in this Pull Request:

Closes #33672

How to test the changes in this Pull Request:

1. View the shop archive or a product category archive with this patch applied.
   Result: Archive header should appear as normal.
2. Add the following to the test theme functions.php file (or via another route):
   remove_action( 'woocommerce_shop_loop_header', 'woocommerce_product_taxonomy_archive_header', 40 );
   Result: Archive header should be removed from the markup.

Other information:

• Have you added an explanation of what your changes do and why you'd like us to include them?
• Have you written new tests for your changes, as applicable?
• Have you successfully run tests with your changes locally?
• Have you created a changelog file for each project being changed, ie pnpm changelog add --filter=<project>?

FOR PR REVIEWER ONLY:

• I have reviewed that everything is sanitized/escaped appropriately for any SQL or XSS injection possibilities. I made sure Linting is not ignored or disabled.

[github-actions]

Hi ,

Apart from reviewing the code changes, please make sure to review the testing instructions as well.

You can follow this guide to find out what good testing instructions should look like:
https://github.com/woocommerce/woocommerce/wiki/Writing-high-quality-testing-instructions

[Konamiman]

Hi @tommyferry, sorry for the big delay, this pull request fell through the cracks and I missed it. I have reviewed and tested it and it looks fine, but before merging it it should get a changelog file, I tried to add it myself but the trunk branch of your repository is protected, so could you please either unprotect trunk or add the changelog file yourself? Yo can do that by running pnpm --filter=woocommerce changelog add from tithin the plugins/woocommerce directory. Thank you!

[tommyferry]

Hi @Konamiman, thanks for reviewing and pushing this forward. I've followed your suggestion and added the changelog file as well as unprotecting the trunk branch in case you'd like to make any further adjustments. Let me know if there's anything else you need from me on this!

[Konamiman]

@tommyferry Now I see that there are several CI checks that are failing. This might be because the pull request is quite old, could you please do a merge or a rebase from the current trunk?

[tommyferry]

Hi @Konamiman, thanks for patience and guidance

I've now merged the current woocommerce trunk into this branch, which should hopefully enable the CI checks to succeed so this can be merged.

[Konamiman]

Hi @tommyferry, sorry but it looks like a new rebase will be needed. I'll be monitoring this more closely this time to try and merge this asap to prevent further CI problems.

[tommyferry]

No worries @Konamiman, I've just rebased so hopefully this should now be correctly passing all tests. Let me know if there's anything else needed on this - it all looks correct to me (and a fairly minor addition) but happy to make further changes as needed. Thanks!

[tommyferry]

@Konamiman - I noticed the recent updates were failing due to a missing template version bump. I've added those now

[Konamiman]

@tommyferry Looks like there are still missing template version bumps:

Error: Templates have changed but template versions were not bumped:

### Template changes:
* **File:** /plugins/woocommerce/templates/archive-product.php
  * WARNING: This template may require a version bump!
* **File:** /plugins/woocommerce/templates/loop/header.php
  * WARNING: This template may require a version bump!

[tommyferry]

Hey @Konamiman, I've just noticed that too - it's very strange as I bumped one of those and the other is a new file... Perhaps I'm missing something here though, should the version be bumped to the version of WC?

[Konamiman]

Hi @tommyferry, indeed the version number expected here is the WooCommerce version where the bump happened, which would be 8.6.0 in this case. So could you please make the change?

[tommyferry]

Ahh that makes sense, thanks so much @Konamiman - all updated now. Fingers crossed for the workflows to pass this time :)

[Konamiman]

Hi @tommyferry. I've checked with my team as I wasn't sure why tests were still failing, and turns out that there's a problem with the code, specifically here:

if ( ! function_exists( 'woocommerce_product_taxonomy_archive_header' ) ) {
	function woocommerce_product_taxonomy_archive_header() {
		if ( is_product_taxonomy() ) {
			wc_get_template( 'loop/header.php' );
		}
	}
}

The problem is the if ( is_product_taxonomy() ) line, which wasn't present in the code that the function is replacing. However I understand that the line is needed, since the woocommerce_before_main_content hook is used also in the single product page.

I think that the cleanest solution, also consistent with the rest of the code in archive-product.php, would be adding a new action that would run immediately after the do_action( 'woocommerce_before_main_content' ); line. The name of the action could be woocommerce_shop_loop_header, again for consistency with the other actions in the file. Please keep in mind that we require all new hooks to include a documentation comment block (example).

[tommyferry]

Hey @Konamiman, thanks for your help in diagnosing the problem - I've implemented the suggested change now and pushed the update.

I did wonder whether it would be possible to achieve the same thing with an additional is_shop() check but I expect that there would be some other templates or situations that would still be missed so I think this is the best option as well.

[JimmyAppelt]

@Konamiman @tommyferry hi here :) seems the template version and function addition version at this time should be 8.8.0 instead of 8.6.0, since it ships with 8.8.0.beta-1