You are here

Home » API reference » Entity Usage 8.2

README.txt in Entity Usage 8.2

Same filename and directory in other branches
  1. 8.4 README.txt
  2. 8 README.txt
  3. 8.3 README.txt
Entity Usage
============

This module provides a tool to track entity relationships in Drupal.

Currently the following tracking methods are supported:

- Entities related trough entity_reference fields
- Entities related trough link fields
- Standard HTML links inside text fields (when pointing to an entity URL).
- Entities embedded into text fields using the Entity Embed module
- Entities embedded into text fields using the LinkIt module
- Entities related through block_field fields (provided by the Block Field
  module)
- Entities related through entity_reference_revision fields
- Entities related through dynamic_entity_reference fields
- Entities related through Layout Builder. Supported methods: Core's inline
(non-reusable) content blocks, and entities selected through the contributed
Entity Browser Block module.

How it works
============

A relationship between two entities is considered so when a source entity
points to a target entity through one of the methods described above.

You can configure what entity types should be tracked when source, and what
entity types should be tracked as target. By default all content entities
(except files and users) are tracked as source.

You can also configure what plugins (from the tracking methods indicated above)
should be active. By default all plugins are active.

When a source entity is created / updated / deleted, all active plugins are
called to register potential relationships.

Content entities can have a local task link (Tab) on its canonical page linking
to a "Usage" information page, where users can see where that entity is being
used. You can configure which entity types should have a local task displaying
usage information.

In order to configure these and other settings, navigate to "Configuration ->
Content Authoring -> Entity Usage Settings" (or go to the URL
/admin/config/entity-usage/settings).

You can also display usage information in Views, or retrieve them in custom
code. Please refer to the online handbook to learn more.

Batch update
============

The module provides a tool to erase and regenerate all tracked information about
usage of entities on your site.
Go to the URL /admin/config/entity-usage/batch-update in order to start the
batch operation.

Project page and Online handbook
================================

More information can be found on the project page:
  https://www.drupal.org/project/entity_usage
and on the online handbook:
  https://www.drupal.org/docs/8/modules/entity-usage

File

README.txt
View source 
  1. Entity Usage

  2. ============

  3. 

  4. This module provides a tool to track entity relationships in Drupal.

  5. 

  6. Currently the following tracking methods are supported:

  7. 

  8. - Entities related trough entity_reference fields

  9. - Entities related trough link fields

  10. - Standard HTML links inside text fields (when pointing to an entity URL).

  11. - Entities embedded into text fields using the Entity Embed module

  12. - Entities embedded into text fields using the LinkIt module

  13. - Entities related through block_field fields (provided by the Block Field

  14.   module)

  15. - Entities related through entity_reference_revision fields

  16. - Entities related through dynamic_entity_reference fields

  17. - Entities related through Layout Builder. Supported methods: Core's inline

  18. (non-reusable) content blocks, and entities selected through the contributed

  19. Entity Browser Block module.

  20. 

  21. How it works

  22. ============

  23. 

  24. A relationship between two entities is considered so when a source entity

  25. points to a target entity through one of the methods described above.

  26. 

  27. You can configure what entity types should be tracked when source, and what

  28. entity types should be tracked as target. By default all content entities

  29. (except files and users) are tracked as source.

  30. 

  31. You can also configure what plugins (from the tracking methods indicated above)

  32. should be active. By default all plugins are active.

  33. 

  34. When a source entity is created / updated / deleted, all active plugins are

  35. called to register potential relationships.

  36. 

  37. Content entities can have a local task link (Tab) on its canonical page linking

  38. to a "Usage" information page, where users can see where that entity is being

  39. used. You can configure which entity types should have a local task displaying

  40. usage information.

  41. 

  42. In order to configure these and other settings, navigate to "Configuration ->

  43. Content Authoring -> Entity Usage Settings" (or go to the URL

  44. /admin/config/entity-usage/settings).

  45. 

  46. You can also display usage information in Views, or retrieve them in custom

  47. code. Please refer to the online handbook to learn more.

  48. 

  49. Batch update

  50. ============

  51. 

  52. The module provides a tool to erase and regenerate all tracked information about

  53. usage of entities on your site.

  54. Go to the URL /admin/config/entity-usage/batch-update in order to start the

  55. batch operation.

  56. 

  57. Project page and Online handbook

  58. ================================

  59. 

  60. More information can be found on the project page:

  61.   https://www.drupal.org/project/entity_usage

  62. and on the online handbook:

  63.   https://www.drupal.org/docs/8/modules/entity-usage