Add original language to entity url generator meta info

We are careful with adding too much meta information because of memory constraints. The issue you linked is fair enough, I'll see if it makes sense to add bundle information; but in this case I feel like it's too much of an esoteric use case. Feel free to argue why you need the language info; closing this for now.

Hello @gbyte. Fair enough - I understand the esoteric use case here and the balance required for a general use case.

For background, we want to remove any links that are no in the original language because we're using hreflang translation sets which have links to any translations. This causes a lot of duplication to entities included in the list, especially as we have 8 translations on the site we're working on.

As an alternative solution, would you consider a hook/event based solution which allows custom modules to implement alterations to the return value of EntityUrlGenerator::processEntity()?

We've resolved this by overriding the new EntityUrlGeneratorBase::constructPathData() method that was introduced in version 4.2.2

Here's our implementation in 'our_module' (name changed to protect the innocent!)

web/modules/custom/our_module/src/Plugin/simple_sitemap/UrlGenerator/OurModuleDomainEntityUrlGenerator.php:

/**
 * Generates URLs for entity bundles and bundle overrides.
 *
 * @UrlGenerator(
 *   id = "our_module_domain_entity",
 *   label = @Translation("Our module Domain entity URL generator"),
 *   description = @Translation("Generates URLs for entity bundles and bundle
 *   overrides."),
 * )
 */
class OurModuleDomainEntityUrlGenerator extends DomainEntityUrlGenerator {

  ...

  /**
   * {@inheritdoc}
   */
  protected function constructPathData(Url $url, array $settings = []): array {
    $path_data = parent::constructPathData($url, $settings);

    $path_data['meta']['entity_info']['original_language'] = $url->getOptions()['entity']->language()->getId();

    return $path_data;
  }

}

I'll close this for now as the patch and merge request from 28th October 2024 no longer applies forward to version 4.2.2 and it appears work is ongoing to allow greater flexibility to achieve attaching custom metadata in custom plugins. Please re-open if this is incorrect.

walkingdexter → closed merge request !111