I'm trying to create a custom JSON:API resource that returns the entities that have been flagged by a user. (The Flag module does not offer a way to get this out of the box.)

I used Views to build a query to show all terms flagged by the user:

SELECT taxonomy_term_field_data.tid AS tid, flagging_taxonomy_term_field_data.id AS flagging_taxonomy_term_field_data_id
{taxonomy_term_field_data} taxonomy_term_field_data
INNER JOIN {flagging} flagging_taxonomy_term_field_data ON taxonomy_term_field_data.tid = flagging_taxonomy_term_field_data.entity_id AND (flagging_taxonomy_term_field_data.flag_id = 'MY_FLAG' AND flagging_taxonomy_term_field_data.uid = 'MY_UID')

Then, I installed the JSON:API Resources module and configured a custom resource.

However, JSON:API uses EntityQuery, not regular SQL queries.

So based on my very limited knowledge of SQL, I wrote a basic query to get all the terms:

    $query = $this->getEntityQuery('taxonomy_term')
      ->condition($entity_type->getKey('bundle'), 'MY_VOCABULARY');

Now I want to restrict this to the terms that have been flagged by the user. How do I implement the INNER JOIN in the Views query in EntityQuery?

2 Answers 2


You can try hook_query_TAG_alter

Sample code

$query = $this->getEntityQuery('taxonomy_term')
  ->condition($entity_type->getKey('bundle'), 'MY_VOCABULARY')->addTag('join_flaging');

 * Implements hook_query_TAG_alter().
function MYMODULE_query_join_flagging_alter(Drupal\Core\Database\Query\AlterableInterface $query) {
  $query->addJoin("INNER","flagging","flg","taxonomy_term_field_data.tid = flg.entity_id AND (flg.flag_id='MY_FLAG' AND flg.uid='MY_UID')");
  • Thanks for this answer! I'm awarding the bounty to you because your solution works without having to patch core. Feb 2, 2021 at 14:56

As the flagging_taxonomy_term is an entity, see https://git.drupalcode.org/project/flag/-/blob/8.x-4.x/src/Entity/Flagging.php, according to this change-record, JOINS are supported, for you like:

$query = Drupal::entityQuery('taxonomy_term')
  // $UPDATE: ->condition($entity_type->getKey('bundle'), 'MY_VOCABULARY') use vid as bundle:
  ->condition('vid', 'MY_VOCABULARY')
  ->condition('flagging.entity.flag_id', 'YOUR_FLAG')
  ->condition('flagging.entity.uid', 1);
  • Unfortunately, this code results in an error: Error: Call to a member function getColumns() on bool in Drupal\Core\Entity\Query\Sql\Tables->addField() (line 253 of core/lib/Drupal/Core/Entity/Query/Sql/Tables.php). Jan 29, 2021 at 12:08
  • 1
    Give this patch a try -> drupal.org/project/drupal/issues/2893747#comment-13886822
    – rémy
    Jan 29, 2021 at 21:44
  • With the patch, a new error: Drupal\\Core\\Entity\\Query\\QueryException: Invalid specifier 'flagging' in /app/web/core/lib/Drupal/Core/Entity/Query/Sql/Tables.php:315 Since Flag doesn't support revisions, I tried this patch but I got the same error. Jan 30, 2021 at 2:19
  • 1
    @PatrickKenny it might just be flagging that's not quite right - try looking at the Field List admin report, try to locate the field which represents the relationship from the vocab to the flag, and replace flagging with that machine name
    – Clive
    Feb 1, 2021 at 20:39
  • @Clive Unfortunately, changing flagging to the field name didn't work, either. Feb 2, 2021 at 14:56

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service and acknowledge you have read our privacy policy.

Not the answer you're looking for? Browse other questions tagged or ask your own question.