Fixes #5634 Allow search results to use canonical URL

[tadean]

Description

This PR allows the stock Drupal search to use the canonical URL for nodes.

It also hardens canonical URL token evaluation in az_core_canonical_url() by checking that field_az_link exists and is populated before reading it, and falling back to the node URL when it is not available.

Release notes

The built-in Drupal search form will now use a node's canonical URL where available.

Related issues

#5634

How to test

• enable az_demo
• run cron
• visit /admin/config/search/pages
• run cron again, until the index is 100%
• visit /search/node
• search for jet stream
• verify that the demo content with a canonical url points to the canonical location, and that others point to the node as normal
• create additional content if desired, with or without a canonical url
• run cron again
• verify that search results use the canonical url correctly
• verify results still work for node types/content without a populated field_az_link value (fallback URL is used)

Types of changes

Arizona Quickstart (install profile, custom modules, custom theme)

• Patch release changes
  • Bug fix
  • Accessibility, performance, or security improvement
  • Critical institutional link or brand change
  • Adding experimental module
  • Update experimental module
• Minor release changes
  • New feature
  • Breaking or visual change to existing behavior
  • Upgrade experimental module to stable
  • Enable existing module by default or database update
  • Non-critical brand change
  • New internal API or API improvement with backwards compatibility
  • Risky or disruptive cleanup to comply with coding standards
  • High-risk or disruptive change (requires upgrade path, risks regression, etc.)
• Other or unknown
  • Other or unknown

Drupal core

• Patch release changes
  • Security update
  • Patch level release (non-security bug-fix release)
  • Patch removal that's no longer necessary
• Minor release changes
  • Major or minor level update
• Other or unknown
  • Other or unknown

Drupal contrib projects

• Patch release changes
  • Security update
  • Patch or minor level update
  • Add new module
  • Patch removal that's no longer necessary
• Minor release changes
  • Major level update
• Other or unknown
  • Other or unknown

Checklist

• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes.
• All new and existing tests passed.
• My change requires release notes.

[Copilot]

Pull request overview

This PR updates stock Drupal node search results so they can link to a node’s configured canonical URL, addressing issue #5634 for content that should point visitors to an external or curated canonical destination.

Changes:

• Adds hook_preprocess_search_result() in az_core.
• Replaces the search result URL with the [node:az-canonical-url] token value when available.
• Converts canonical URI values into rendered URL strings for the search result template.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[tadean]

This should be fixed in az_core_canonical_url(), where that token is evaluated, not here.

[joeparsons]

@copilot See @tadean's findings in #5658 (comment)

[Copilot]

Updated in 58cd6c3. I moved the defensive handling into az_core_canonical_url() by checking hasField('field_az_link') and ensuring the field is not empty before reading its URI, so the token callback safely falls back to the node URL when the field is unavailable.

[tadean]

Copilot previously said the following:

This preprocess runs for every node search result, but the [node:az-canonical-url] token callback reads field_az_link directly. Search results for node bundles that do not have that field can trigger an unknown-field exception instead of falling back to the normal search URL. Limit the override to nodes that actually have a populated canonical link field, since the default search URL is already correct otherwise.

This does not appear to occur because az_core_canonical_url() (which provides the value of this token) uses the magic metthod call if (!empty($node->field_az_link[0]->uri)) {

The php empty() language construct calls the __isset method if the object defines it. Given the functionality of ContentEntityBase::__isset() it seems like this should not occur for undefined fields.

[Copilot]

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.