Add woocommerce_widget_layered_nav_term_anchor_text filter

[moory-se]

Submission Review Guidelines:

• I have followed the WooCommerce Contributing Guidelines and the WordPress Coding Standards.
• I have checked to ensure there aren't other open Pull Requests for the same update/change.
• I have reviewed my code for security best practices.
• Following the above guidelines will result in quick merges and clear and detailed feedback when appropriate.

Changes proposed in this Pull Request:

Allow developers to change the anchor text of active filters. Often, one would add the taxonomy (Brand: Adidas).

How to test the changes in this Pull Request:

1. Add this code snippet to your test site. This will make it so you can still add legacy widgets that have a modern block equivalent.

use Automattic\WooCommerce\Blocks\{ BlockTypesController, Package };

add_action(
	'widgets_init',
	function() {
		remove_filter(
			'widget_types_to_hide_from_legacy_widget_block',
			array(
				Package::container()->get( BlockTypesController::class ),
				'hide_legacy_widgets_with_block_equivalent'
			)
		);
	}
);

2. Switch to a theme that is not block enabled, like Storefront or Twenty Nineteen.
3. Go to Appearance > Widgets. Add a Filter by Attribute widget with a given attribute.
4. Add a Legacy Widget and select "Active Product Filters" from the dropdown.
5. Add this second code snippet to your test site:

add_filter(
	'woocommerce_widget_layered_nav_term_anchor_text',
	function ( $name ) {
		return $name . ' (changed)';
	},
	10
);

6. Go to the Shop page on the front end and filter on any attribute.
7. See that " (changed)" is added to items in the Active Product Filters widget.

Changelog entry

• Automatically create a changelog entry from the details below.

Significance

• Patch
• Minor
• Major

Type

• Fix - Fixes an existing bug
• Add - Adds functionality
• Update - Update existing functionality
• Dev - Development related task
• Tweak - A minor adjustment to the codebase
• Performance - Address performance issues
• Enhancement - Improvement to existing functionality

Message

Add a filter to allow modifying the attribute term name in the Active Product Filters widget.

Comment

[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

[coreymckrill]

Hi @moory-se , thanks for the PR! I left some code suggestions that will make sure our code linter is happy and also to make a minor security improvement.

[coreymckrill]

@moory-se Could you please update the PR description to include step-by-step instructions on how to test this? Here are some pointers on testing instructions: https://github.com/woocommerce/woocommerce/wiki/Writing-high-quality-testing-instructions

[moory-se]

Hi,

I don't think this can be tested really? I added some testing instructions, but they are not very helpful I think. You might think different though, which would be great :)

[coreymckrill]

@moory-se Ah, I figured out why I was having trouble testing this. There is a block version of this widget now (which the filter you're adding won't affect) and so the old legacy version of the widget gets hidden. So I think if your site is already using the legacy version of the widget, you don't get automatically switched to the block version, but you can't add new instances of the old legacy version.

Have you tried the block version of the Active Filters widget? It looks like it actually adds a label telling you which attribute a term is for, which might solve your use case.

[moory-se]

Hi,

The block version is not a viable option for us. We have ~850 filters that are conditionally shown on the site. Handling those numbers with the block version would be impractical.

This PR is for the widget version, which is not deprecated. The PR also has 0 breaking changes, adds lots of value with very little code. Hope to get this merged :)

[coreymckrill]

Gonna close and re-open this to jumpstart the stuck tests.

[coreymckrill]

@moory-se I figured out how to make the old legacy widgets available for testing, and I updated your testing instructions accordingly. Filter works fine in testing 👍

[coreymckrill]

@moory-se

The block version is not a viable option for us. We have ~850 filters that are conditionally shown on the site. Handling those numbers with the block version would be impractical.

Could you explain a bit more about why the block version can't handle ~850 attributes, but the old legacy version can? I think this would be good feedback for our blocks teams.

[moory-se]

@moory-se

The block version is not a viable option for us. We have ~850 filters that are conditionally shown on the site. Handling those numbers with the block version would be impractical.

Could you explain a bit more about why the block version can't handle ~850 attributes, but the old legacy version can? I think this would be good feedback for our blocks teams.

Doing it "manually" - in the UI - is a nightmare. It takes ~50 seconds to load the page with all the blocks. I have not digged very deep to debug this (we simply installed Classic Widgets and get on with our lives), so I'm not really sure why. I think it's partially due to the way blocks are stored, and partially because of the rendering process is not optimized for these volumes. I would guess the latter is the major part.

To fix this, we actually add them by code. The the_widget() function is very simple to call - you pass in every "instance data" as an array. The blocks counterpart - do_blocks() - expects some HTML-ish with the data as JSON-ish. It's error prone and cumbersome to work with.

Also, adding custom fields (such as a tooltip) to any widget is very simple with the classic widgets.

We've actually developed a custom system (outside woocommerce/wordpress) to manage all the filters/layered navigation, and the data/configuration is exported to woocommerce for rendering. I think this is the only way to handle many filters in woocommerce, as opposed to many other platforms where they are configured on attribute ("use as filter") and/or category ("attributes to use for filtering on this category") level.

[coreymckrill]

Thanks! I'll pass this along.