drupal/external_entity

Consume external entities from various sources.

Maintainers

Details

git.drupalcode.org/project/external_entity.git

Homepage

Source

Installs: 3

Dependents: 0

Suggesters: 0

Security: 0

Type:drupal-module

1.0.x-dev 2025-05-15 17:50 UTC

Requires

GPL-2.0+ c693d13854a2ad9b39d718c40b341c7913f323e1

This package is not auto-updated.

Last update: 2025-05-26 11:42:37 UTC

README

Introduction

The External Entity (Consumer) module allows Drupal sites to consume and display content from external sources—most commonly another Drupal site running the External Entity Server. It lets site builders map external data to local Drupal entity types and render it using familiar tools like Views, view modes, and field formatters.

Unlike traditional data integrations that duplicate or migrate content, this module enables real-time, read-only rendering of remote content as if it lived locally—without decoupling or complex custom code.

For a full description of the module, visit the project page:
https://www.drupal.org/project/external_entity

To submit bug reports and feature suggestions, or track changes:
https://www.drupal.org/project/issues/external_entity

Requirements

This module requires no modules outside of Drupal core.

Recommended modules

Installation

Install as you would normally install a contributed Drupal module. For further information, see:
https://www.drupal.org/docs/extending-drupal/installing-drupal-modules

Configuration

Once installed, follow these steps to configure External Entity (Consumer):

  1. Add a connection
    Navigate to: /admin/config/services/external-entity/connection
    Set up a connection to your External Entity Server. Provide the remote domain and specify the authentication method, if required.

  2. Define External Entity Types
    Navigate to: /admin/structure/external-entity/type
    Map remote entities to local entity types (e.g., map a remote News content type to a local News content type).
    Configure the field mappings under Manage Display to determine how fields from the external source are rendered locally.

  3. Access and Use External Entities
    External content can be used in two ways:

    • Entity Reference: Use the External Entity reference field to attach and display external content using view modes.
    • Views Integration: Create External Entity Views to list and filter remote content using Drupal’s Views UI. Choose a view mode for rendering.

Note: This module assumes that the external site has been properly configured with the External Entity Server module and is sharing one or more resources.

Maintainers

Sponsored by: