Facets Custom Label

Release

Status : Published

Projects : Modules

Maintenance status : Actively maintained

Development status : Under active development

Supported Branches : 2.0., 8.x-1.

Stable releases for this project are covered by the security advisory policy.

2.0.0-rc2 released 02 October 2022

Works with Drupal: ^8 || ^9 || ^10

Install:

composer require 'drupal/facets_custom_label:^2.0@RC'

RC releases are not covered by Drupal security advisories.

8.x-1.4 released 02 October 2022

Works with Drupal: ^8 || ^9 || ^10

Install:

composer require 'drupal/facets_custom_label:^1.4'

Covered by Drupal's security advisory policy

Description

Facets Custom Label module is a facet processor which lets you rename / relabel facets items.

Features

• Relabels facets by:
  • their raw value: machine name or content IDs,
  • their display value: content titles, term names.

2.0 new features

• Label replacements are now interpreted as HTML, so you may now include markup.

Basic usage

1. Enable the module.
2. Enable the facet processor Facets custom label processor.
3. On each line, insert a replacement value as the following:
   

   <origin>|<value>|<new label>

   • origin determines the type of value to convert:
     • use r to convert raw value,
     • use d to convert the display value.
   • value determines the value to convert.
   • new label determines the final display name.
4. (optional) If you need translated labels, enable the Configuration Translation module and translate the facet configuration.

Please note this processor will convert facet names in a single pass. For each result, it will attempt to convert using the raw mapping first, then the display mapping if not matching. Values which are not converted are left unchanged.

Examples

r|article|Awesome articles
r|event|Events
r|another_content_type|Others

r|156|Label of term 156
r|1337|Label of term 1337
d|Dog|New label of dog

Caveats

You should not use auto incremented numeric entity IDs (like term or node IDs) if you plan to have a deployment scenario where those IDs will not match between the instances. You better have to use their name / title or another technical field.

Requirements

• Drupal 8+, no planned port on Drupal 7.
• Facets: known to work with 1.0.0-beta2.
• Configuration translation: if you need translated labels.

Similar modules