Drupal 8 Plugin API - Manoj K

1. DRUPAL 8 PLUGIN API
How to make your module extendable using plugins?

2. Manoj K
• Drupal Dev, Enthusiast, and Contributor
• Sr. Drupal Consultant @ Valuebound
• Speaker | Blogger | Mentor
• d.o/manojapare
• Github/manoj-apare
• @manojapare

3. INTRODUCTION
• Plugins
• Plugin API

4. PLUGINS vs. INFO HOOKS

5. WHEN TO USE?
• Plugin
• Service

6. PLUGIN SYSTEM: 3 BASE ELEMENTS
1.Plugin Types
2.Plugin Discovery
3.Plugin Factory

7. PLUGIN DISCOVERY TYPES
1. StaticDiscovery:
$this->discovery = new StaticDiscovery();
// Add a plugin with a custom value.
$this->discovery->setDefinition('test_block', [
'class' => 'Drupalplugin_testPluginplugin_testmock_blockMockTestBlock',
'metadata' => [
'custom' => TRUE,
],
]);

8. PLUGIN DISCOVERY TYPES
2. HookDiscovery:/
foreach ($this->moduleHandler->getImplementations($this->hook) as $module) {
$result = $this->moduleHandler->invoke($module, $this->hook);
foreach ($result as $plugin_id => $definition) {
$definition['provider'] = $module;
$definitions[$plugin_id] = $definition;
}
}

9. PLUGIN DISCOVERY TYPES
3. AnnotatedClassDiscovery:
@FieldType(
id = "datetime",
label = @Translation("Date"),
description = @Translation("Create and store date values."),
default_widget = "datetime_default",
default_formatter = "datetime_default",
list_class = "DrupaldatetimePluginFieldFieldTypeDateTimeFieldItemList",
constraints = {"DateTimeFormat" = {}}
)

10. PLUGIN DISCOVERY TYPES
4. YamlDiscovery:
$yaml_discovery = new YamlDiscovery(
'links.action',
$this->moduleHandler->getModuleDirectories()
);

11. CREATE PLUGIN MANAGER
Drupal Console commands:
• generate:plugin:type:annotation (gpta)
• generate:plugin:type:yaml (gpty)

12. CREATE PLUGIN MANAGER (Continued)
• DefaultPluginManager
• As a service:
services:
plugin.manager.archiver:
class: DrupalCoreArchiverArchiverManager
parent: default_plugin_manager

13. CREATE NEW PLUGIN
Drupal Console commands:
• debug:plugin (dpl)
• generate:plugin:skeleton (gps)

14. USING PLUGIN MANAGER
1.Invoke plugin class:
$type = Drupal::service('plugin.manager.archiver');
1.Get a list of available plugins:
$plugin_definitions = $type->getDefinitions();
1.Get a specific plugin:
$plugin_definition = $type->getDefinition('plugin_id');
1.Create an instance of a plugin:
$plugin = $type->createInstance('plugin_id', ['of' => 'configuration values']);

15. References
• https://www.drupal.org/docs/8/api/plugin-api
• http://drupalconsole.com/commands