You are here

Home » API reference » Drupal 9 » jsonapi.module

constant JSONAPI_FILTER_AMONG_OWN in Drupal 9

Same name and namespace in other branches
  1. 8 core/modules/jsonapi/jsonapi.module \JSONAPI_FILTER_AMONG_OWN
  2. 10 core/modules/jsonapi/jsonapi.module \JSONAPI_FILTER_AMONG_OWN

Array key for denoting type-based owned-only filtering access.

Array key for denoting access to filter among all entities of a given type, regardless of whether they are published or enabled, so long as they are owned by the user for whom access is being checked.

When filtering among User entities, this is used when access is being checked for an authenticated user and there's a query condition limiting the result set to just that user's entity object.

When filtering among entities of another type, this is used when all of the following conditions are met:

  • Access is being checked for an authenticated user.
  • The entity type has an "owner" entity key.
  • There's a filter/query condition for the value equal to the user's ID.

See also

hook_jsonapi_entity_filter_access()

hook_jsonapi_ENTITY_TYPE_filter_access()

File

core/modules/jsonapi/jsonapi.module, line 78
Module implementation file.

Code

const JSONAPI_FILTER_AMONG_OWN = 'filter_among_own';