ContainerFactory.php

Same filename and directory in other branches
  1. 9 core/lib/Drupal/Core/Plugin/Factory/ContainerFactory.php
  2. 8.9.x core/lib/Drupal/Core/Plugin/Factory/ContainerFactory.php
  3. 10 core/lib/Drupal/Core/Plugin/Factory/ContainerFactory.php

Namespace

Drupal\Core\Plugin\Factory

File

core/lib/Drupal/Core/Plugin/Factory/ContainerFactory.php

View source
<?php

namespace Drupal\Core\Plugin\Factory;

use Drupal\Component\Plugin\Factory\DefaultFactory;

/**
 * Plugin factory which passes a container to a create method.
 */
class ContainerFactory extends DefaultFactory {
    
    /**
     * {@inheritdoc}
     */
    public function createInstance($plugin_id, array $configuration = []) {
        $plugin_definition = $this->discovery
            ->getDefinition($plugin_id);
        $plugin_class = static::getPluginClass($plugin_id, $plugin_definition, $this->interface);
        // If the plugin provides a factory method, pass the container to it.
        if (is_subclass_of($plugin_class, 'Drupal\\Core\\Plugin\\ContainerFactoryPluginInterface')) {
            return $plugin_class::create(\Drupal::getContainer(), $configuration, $plugin_id, $plugin_definition);
        }
        // Otherwise, create the plugin directly.
        return new $plugin_class($configuration, $plugin_id, $plugin_definition);
    }

}

Classes

Title Deprecated Summary
ContainerFactory Plugin factory which passes a container to a create method.

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