Skip to content

#3595143 Add Typed Relation 'raw' formatter to expose rel_type and target_id #161

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

Open
kayakr wants to merge 2 commits into
base: 2.x
Choose a base branch
from
Open

#3595143 Add Typed Relation 'raw' formatter to expose rel_type and target_id #161

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fb68aa2
#3595143 Add Typed Relation 'raw' formatter to expose rel_type and ta…
Jun 10, 2026
27f8791
Fix code style
Jun 10, 2026
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
34 changes: 34 additions & 0 deletions src/Plugin/Field/FieldFormatter/TypedRelationFormatterRaw.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<?php

namespace Drupal\controlled_access_terms\Plugin\Field\FieldFormatter;

use Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceLabelFormatter;
use Drupal\Core\Field\FieldItemListInterface;

/**
* Formatter to output raw values, e.g. rel_type=target_id.
*
* @FieldFormatter(
* id = "typed_relation_raw",
* label = @Translation("Typed Relation Formatter (Raw)"),
* field_types = {
* "typed_relation"
* }
* )
*/
class TypedRelationFormatterRaw extends EntityReferenceLabelFormatter {

/**
* {@inheritdoc}
*/
public function viewElements(FieldItemListInterface $items, $langcode) {
$elements = parent::viewElements($items, $langcode);

foreach ($items as $delta => $item) {
$elements[$delta]['#plain_text'] = $item->rel_type . '=' . $item->target_id;
}
Comment on lines +27 to +29

@joecorall joecorall Jun 26, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

$elements = parent::viewElements($items, $langcode); does entity access checking on the referenced entities. So it's possible an element in $items doesn't exist in $elements and we leak its relator and term ID. Not a big deal, but maybe we should iterate over $elements? Maybe something like

Suggested change
foreach ($items as $delta => $item) {
$elements[$delta]['#plain_text'] = $item->rel_type . '=' . $item->target_id;
}
foreach ($elements as $delta => &$element) {
$item = $items[$delta];
$element['#plain_text'] = $item->rel_type . '=' . $item->target_id;
}


return $elements;
}

}