JSONAPI_FILTER_AMONG_ENABLED

Same name and namespace in other branches
  1. 9 core/modules/jsonapi/jsonapi.module \JSONAPI_FILTER_AMONG_ENABLED
  2. 8.9.x core/modules/jsonapi/jsonapi.module \JSONAPI_FILTER_AMONG_ENABLED
  3. 10 core/modules/jsonapi/jsonapi.module \JSONAPI_FILTER_AMONG_ENABLED

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

Array key for denoting access to filter among all enabled entities of a given type, regardless of their owner.

This is used when an entity type has a "status" entity key and there's a query condition for the value of that equaling 1.

For the User entity type, which does not have a "status" entity key, the "status" field is used.

Deprecated

in drupal:11.3.0 and is removed from drupal:13.0.0. Use \Drupal\jsonapi\JsonApiFilter::AMONG_ENABLED instead.

See also

https://www.drupal.org/node/3495601

hook_jsonapi_entity_filter_access()

hook_jsonapi_ENTITY_TYPE_filter_access()

File

core/modules/jsonapi/jsonapi.module, line 60

Code

const JSONAPI_FILTER_AMONG_ENABLED = 'filter_among_enabled';

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.