interface ObjectWithPluginCollectionInterface

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Plugin/ObjectWithPluginCollectionInterface.php \Drupal\Core\Plugin\ObjectWithPluginCollectionInterface
  2. 10 core/lib/Drupal/Core/Plugin/ObjectWithPluginCollectionInterface.php \Drupal\Core\Plugin\ObjectWithPluginCollectionInterface
  3. 11.x core/lib/Drupal/Core/Plugin/ObjectWithPluginCollectionInterface.php \Drupal\Core\Plugin\ObjectWithPluginCollectionInterface

Provides an interface for an object using a plugin collection.

Hierarchy

Expanded class hierarchy of ObjectWithPluginCollectionInterface

All classes that implement ObjectWithPluginCollectionInterface

See also

\Drupal\Component\Plugin\LazyPluginCollection

Entities that need this interface should implement \Drupal\Core\Entity\EntityWithPluginCollectionInterface, which extends this.

Related topics

Plugin API
Using the Plugin API
1 file declares its use of ObjectWithPluginCollectionInterface
EntityWithPluginCollectionInterface.php in core/lib/Drupal/Core/Entity/EntityWithPluginCollectionInterface.php

File

core/lib/Drupal/Core/Plugin/ObjectWithPluginCollectionInterface.php, line 15

Namespace

Drupal\Core\Plugin
View source 
interface ObjectWithPluginCollectionInterface {
    
    /**
     * Gets the plugin collections used by this object.
     *
     * @return \Drupal\Component\Plugin\LazyPluginCollection[]
     *   An array of plugin collections, keyed by the property name they use to
     *   store their configuration.
     */
    public function getPluginCollections();

}

Members

Title Modifiers Object type Summary
ObjectWithPluginCollectionInterface::getPluginCollections public function Gets the plugin collections used by this object.

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