Skip to content

Prefer file description field for document link text if set and available #878

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
finnlewis merged 8 commits into from
Nov 4, 2025
Merged

Prefer file description field for document link text if set and available #878

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6b7e1bc
Prefer file description field for document link text if set and avail…
tonypaulbarker Oct 27, 2025
ceaa11b
Update variable initialisation for file link
tonypaulbarker Oct 27, 2025
2b8bfe6
Code improvements
tonypaulbarker Oct 28, 2025
2251010
Fix test violations
tonypaulbarker Oct 28, 2025
592e295
Try to get the file field
tonypaulbarker Oct 28, 2025
bb19ae7
Ensure description variable is defined
tonypaulbarker Nov 1, 2025
5afa043
Get the right document field field_media_document
tonypaulbarker Nov 1, 2025
9a71401
Remove white space for php 8.4
tonypaulbarker Nov 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 34 additions & 4 deletions localgov_base.theme
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -429,10 +429,40 @@ function localgov_base_preprocess_file_link(&$variables): void {
$document_title = $variables['link']['#title'];

if ($media) {
$media_name = $media->get('name')->getString();
// If the media name is set and different to the
// $variables['link']['#title'], we will use that instead.
$document_title = ($media_name && $media_name !== $document_title) ? $media_name : $document_title;
// Assume some defaults for document media type.
$view_mode = 'default';
$media_file_field_name = ($media->bundle() === 'document') ? 'field_media_document' : NULL;

// Initialise description variables.
$use_description = FALSE;
$description = '';

if ($media_file_field_name) {
$entity_display_repository = \Drupal::service('entity_display.repository');
$entity_display = $entity_display_repository->getViewDisplay($media->getEntityTypeId(), $media->bundle(), $view_mode);
$field_display = $entity_display->getComponent($media_file_field_name);

if ($field_display && isset($field_display['settings']['use_description_as_link_text'])) {
$use_description = $field_display['settings']['use_description_as_link_text'];
}
}

// Get the description from the file field if available.
if ($use_description && $file->_referringItem) {
$description = $file->_referringItem->description ?? '';
}

// Use description as link text if enabled and description exists.
if ($use_description && !empty($description)) {
$document_title = $description;
}
else {
// Otherwise, see about using the media name.
$media_name = $media->get('name')->getString();
// If the media name is set and different to the
// $variables['link']['#title'], we will use that instead.
$document_title = ($media_name && $media_name !== $document_title) ? $media_name : $document_title;
}
}

$variables['link']['#title'] = [
Expand Down