SlideShare a Scribd company logo

Drupal 8, Where Did the Code Go? From Info Hook to Plugin

Acquia, profile picture
Acquia

The document discusses the transition from code hooks to plugins in Drupal 8, emphasizing Plugin architecture, which encapsulates functionality in classes implementing specific interfaces. It details the discovery, configuration, and management of plugins, compared to previous versions, and highlights the significance of annotations and YAML files for defining elements like blocks and filters. The talk also features examples of converting traditional info hooks to plugins and demonstrates specific implementations for local tasks and image toolkits.

Technology
Related topics:
Web Design and Development
1 of 48
Download to read offline
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
Drupal 8, where did the code go? From info hook to plugin Peter Wolanin July 14, 2016
Background and “What’s a plugin?”! Example of a core info hook conversion! Simple but common plugin example:
 adding new tabs (a.k.a. local tasks)! Configurable plugins (ConfigEntity based)! ‣ Adding a custom block! ‣ Adding a custom text filter! Considerations for defining your own plugins Here’s What’s In the Talk 2
Drupal 5, 6, 7, 8 core contributor! Drupal Security Team! Acquia Engineering! Helped create some Drupal 8 plugins including SearchPlugin, MenuLinks, LocalTasks, LocalActions, ContextualLinks! DrupalCamp NJ organizer Who Am I? 3 https://www.drupal.org/u/pwolanin Photo by amazeelabs, by-nc-sa
I’ll assume you know something about:! The DIC/container/service container! ‣ The container is an object that contains instances of stateless “services” (the current request, the current user, URL generator, etc)! The new routing system - names instead of paths.! ‣ a route name is just a machine name connected to a path and callbacks to provide, title, content, access etc. - like a D7 menu router! Namespaced classes (PHP 5.3+) like 
 DrupalsearchPluginBlockSearchBlock Drupal 8 Background 4
Encapsulate some re-useable functionality inside a class that implements one or more specific interfaces! Plugins combine what in Drupal 7 was an info hook and a number of implementation hooks and possibly configuration: e.g. hook_search_info() and hook_search_execute(), etc., or hook_block_info() and hook_block_view(), _configure(), _save()! Evolved from ctools and views plugins, but have quite different mechanisms to discover them Plugins 5
Every plugin type has a manager - registered as a service (available from the container) and used to find and instantiate the desired plugin instance(s)! Each plugin has an ID, which may be in its definition, or generated as a derivative! For a given plugin ID one single class will be used for all plugin instances using that plugin ID! A plugin instance is specified by the combination of plugin ID and its configuration values, potentially coming from a ConfigEntity Plugin Manager and IDs 6
“The Drop is always moving” http://flickr.com/photos/alkalinezoo/32265389/ drupal.org/node/65922
7.x: hook_image_toolkits() 8 /**! * Implements hook_image_toolkits().! */! function system_image_toolkits() {! include_once DRUPAL_ROOT . '/' . drupal_get_path('module', 'system') . '/' . 'image.gd.inc';! return array(! 'gd' => array(! 'title' => t('GD2 image manipulation toolkit'),! 'available' => function_exists('image_gd_check_settings') &&! image_gd_check_settings(),! ),! );! }!
8.x: GD Image Toolkit Plugin 9 /**! * Defines the GD2 toolkit for image manipulation within Drupal.! *! * @ImageToolkit(! * id = "gd",! * title = @Translation("GD2 image manipulation toolkit")! * )! */! class GDToolkit extends ImageToolkitBase {! //... more methods ..//! ! public static function isAvailable() {! // GD2 support is available.! return function_exists('imagegd2');! }! ! //... more methods ..//! }
8.x: ImageToolkitManager 10 class ImageToolkitManager extends DefaultPluginManager {! // ... various methods ... //! ! /**! * Gets a list of available toolkits.! */! public function getAvailableToolkits() {! // Use plugin system to get list of available toolkits.! $toolkits = $this->getDefinitions();! ! $output = array();! foreach ($toolkits as $id => $definition) {! if (call_user_func($definition['class'] . '::isAvailable')) {! $output[$id] = $definition;! }! }! return $output;! }! }
7.x: image_desaturate() Function 11 /**! * Converts an image to grayscale.! *! * @param $image! * An image object returned by image_load().! *! * @return! * TRUE on success, FALSE on failure.! *! * @see image_load()! * @see image_gd_desaturate()! */! function image_desaturate(stdClass $image) {! return image_toolkit_invoke('desaturate', $image);! }! !
8.x: Image::desaturate() via Plugin 12 /**! * Defines an image object to represent an image file.! *! * @see DrupalCoreImageToolkitImageToolkitInterface! * @see DrupalimageImageEffectInterface! */! class Image implements ImageInterface {! //... more methods ..//! ! public function apply($operation, array $arguments = array()) {! return $this->getToolkit()->apply($operation, $arguments);! }! ! public function desaturate() {! return $this->apply('desaturate', array());! }! ! //... more methods ..//! }!
7.x: Operation by Function Prefix 13 /**! * Convert an image resource to grayscale.! *! * Note that transparent GIFs loose transparency when desaturated.! *! * @param $image! * An image object. The $image->resource value will be modified.! * @return! * TRUE or FALSE, based on success.! *! * @see image_desaturate()! */! function image_gd_desaturate(stdClass $image) {! // PHP using non-bundled GD does not have imagefilter.! if (!function_exists('imagefilter')) {! watchdog('image', 'The image could not be desaturated.');! return FALSE;! }! return imagefilter($image->resource, IMG_FILTER_GRAYSCALE);! }! !
8.x: Operations Are Also Plugins/**! * Defines GD2 Desaturate operation.! *! * @ImageToolkitOperation(! * id = "gd_desaturate",! * toolkit = "gd",! * operation = "desaturate",! * label = @Translation("Desaturate"),! * )! */! class Desaturate extends GDImageToolkitOperationBase {! ! protected function execute(array $arguments) {! // PHP using non-bundled GD does not have imagefilter.! if (!function_exists('imagefilter')) {! $this->logger->notice("The image could not be desaturated");! return FALSE;! }! return imagefilter($this->getToolkit()->getResource(),! IMG_FILTER_GRAYSCALE);! }! } 14
What About Hooks? http://flickr.com/photos/avelino_maestas/2532426169/
Most plugin managers invoke an _alter hook so the modules can add to or alter the plugins’ definitions! For example, hook_block_alter()allows you to alter the block plugin definitions! Info hooks that simply return a data array, without associated code and logic, were not candidates to become plugins (but may have become YAML)! Others like hook_cron() or hook_entity_access() are still present Hooks Still Have Their Place 16
The discovery of plugins is basically the same as invoking an info hook (and, in fact, it can even be implemented that way)! Discovery gives you an array of plugin definitions, each of which is just an array of keys and values! The discovery process fills in defaults, such a ‘provider’ which is the name of the module providing the plugin! Discovery can make derivatives (many from one) like FieldUiLocalTask - one tab per bundle Plugin Discovery 17
YAML based:! MenuLink, LocalTask, LocalAction, ContextualLink! Annotation, some config, but no config entity:! ImageToolkit, Archiver! Annotation and config entity (many) including:! Block, ViewsDisplay, ImageEffect, SearchPlugin! Not a pure Plugin but uses Annotation discovery:! Entity (Node, User, etc.) Plugin Discovery & Config in Core 18
Let’s Start Learning The Drupal 8.x Plugin Toolkit http://flickr.com/photos/booleansplit/2376359338/
As in Drupal 7, code is provided by modules - so you need a module. You need a .info.yml file - like a .info file for Drupal 7! You no longer need even an empty .module file! The only remaining code in .module files are a few hook implementations: most code lives in classes Pre-requisite: a Drupal 8 Module 20 name: 'My test module'! type: module! description: ‘Acquia webinar demo.'! core: 8.x modules/mymodule/mymodule.info.yml
For most uses, just add a YAML file listing your tabs: mymodule/mymodule.links.tasks.yml Adding Two Tabs: 21 mymodule.list_tab:! route_name: mymodule.list! title: 'List'! base_route: mymodule.list! ! mymodule.settings_tab:! route_name: mymodule.settings! title: 'Settings'! base_route: mymodule.list Plugin ID Local tasks reference a base route which groups them
Unlike Drupal 7 you don’t need to jump though the hoops of a default local task, or making the paths align in a certain hierarchy Adding Two Tabs: 22
Of course, those routes need to be defined or pre- existing: mymodule/mymodule.routing.yml LocalTask Plugins Need Routes: 23 mymodule.list:! path: '/admin/config/mymodule/list'! defaults:! _controller: 'DrupalmymoduleControllerMyController::dolist'! _title: 'Mymodule list'! requirements:! _access: 'TRUE'! ! mymodule.settings:! path: '/admin/config/also-mymodule/settings'! defaults:! _controller: 'DrupalmymoduleControllerMyController::settings'! _title: 'Mymodule settings'! requirements:! _access: 'TRUE'
The plugin configuration options and defaults are on the LocalTaskManager class LocalTask Plugin Keys: 24 class LocalTaskManager extends DefaultPluginManager implements LocalTaskManagerInterface {! protected $defaults = array(! // (required) The name of the route this task links to.! 'route_name' => '',! // Parameters for route variables when generating a link.! 'route_parameters' => array(),! // The static title for the local task.! 'title' => '',! // The route name where the root tab appears.! 'base_route' => '',! // The plugin ID of the parent tab (or NULL for the top-level tab).! 'parent_id' => NULL,! // The weight of the tab.! 'weight' => NULL,! // The default link options.! 'options' => array(),! // Default class for local task implementations.! 'class' => 'DrupalCoreMenuLocalTaskDefault',! // The plugin id. Set by the plugin system based on the top-level YAML key.! 'id' => '',! );! }!
The New Block http://flickr.com/photos/kubina/973244593/
Each custom block is defined in code as a class! When the admin places the block into a region in a theme, a configuration object is created to track that setting! The config object is a ConfigEntity - it’s an abstraction on top of CMI (storing your Drupal configuration in YAML files) - it makes it convenient to list, load, etc. using entity functions. ! Drupal can easily list the active block instances! Note - you don’t need to worry about the config! Blocks as Plugins 26
Blocks implement the! DrupalCoreBlockBlockPluginInterface! If you extend the abstract
 DrupalCoreBlockBlockBase class then all you need to implement is the build() method! build() is basically the same as hook_block_view() in Drupal 7! For example, I added to my module
 DrupalmymodulePluginBlockMyBlock Blocks Implementation 27
When I add the Block to my module:
 DrupalmymodulePluginBlockMyBlock! This is at the corresponding file path (under the Drupal root directory):
 modules/mymodule/src/Plugin/Block/ MyBlock.php! Note that the class name and the path match up under src/! This mapping of class name to path is how the class can be automatically found and loaded Side Note - PSR-4 28
29 /**! * Provides a block with 'Mymodule' links.! *! * @Block(! * id = "mymodule_my_block",! * admin_label = @Translation("Mymodule block")! * )! */! class MyBlock extends BlockBase {! public function build() {! return [! 'first_link' => [! '#type' => 'link',! '#title' => $this->t('Mymodule List'),! '#url' => Url::fromRoute('mymodule.list'),! ],! 'second_link' => [! '#type' => 'link',! '#title' => $this->t('Mymodule Settings'),! '#url' => Url::fromRoute('mymodule.settings'),! ],! ];! }! }
30 Blocks Admin! Page Has a New Function: 
 Place block
31 Blocks Admin! Page Has a New Function: 
 Place block
32 Save the Block to Create a New Plugin Instance
33
Block Hook to Plugin Comparison 34 Drupal 7.x Drupal 8.x hook_block_info() BlockManagerInterface::
 getDefinitions() hook_block_view($delta) BlockPluginInterface::
 build() ? BlockPluginInterface::
 access(AccountInterface $account) hook_block_configure($delta) BlockPluginInterface::
 blockForm($form, $form_state) ? BlockPluginInterface::
 blockValidate($form, $form_state) hook_block_save($delta, $edit) BlockPluginInterface::
 blockSubmit($form, $form_state)
Each Plugin type must be in the expected class namespace for your module - for blocks: namespace DrupalmymodulePluginBlock;! Most core plugins have a custom annotation class - you have to use the right one for your plugin! The annotation class provides both a documentation of the possible keys in the plugin definition and default values! There is also a generic Plugin annotation class Block Discovery and Annotations 35
36 /**! * Defines a Block annotation object.! *! * @Annotation! */! class Block extends Plugin {! /**! * The plugin ID.! *! * @var string! */! public $id;! ! /**! * The administrative label of the block.! *! * @var DrupalCoreAnnotationTranslation! *! * @ingroup plugin_translatable! */! public $admin_label;! ! //... more properties ..//! }
Filtering Text http://flickr.com/photos/pinksherbet/253412963/
7.x Info Hook 38 /**! * Implements hook_filter_info().! *! * @ingroup project_issue_filter! */! function project_issue_filter_info() {! $filters['filter_project_issue_link'] = array(! 'title' => t('Project issue to link filter'),! 'description' => t('Converts references to project issues ! (in the form of [#12345]) into links.'),! 'process callback' => '_project_issue_filter',! 'tips callback' => '_project_issue_filter_tips',! 'cache' => TRUE,! );! return $filters;! }
39 /**! * Provides a filter to format a node ID as a link.! *! * @Filter(! * id = "mymodule_node_link",! * module = "mymodule",! * title = @Translation("Format a node ID as a link")! * )! */! class NodeLinkFilter extends FilterBase {! public function process($text, $langcode) {! $regex = ‘(?:(?<!w)[(#d+(?:-[d.]+)?)](?!w))|…’;! $callback = function($matches) { ... } ! $text = preg_replace_callback("/$regex/", $callback, $text);! return new FilterProcessResult($text);! }! ! // ... more code ...//! ! public function tips($long = FALSE) {! return $this->t('Node ID numbers (ex. [#12345]) turn into links automatically.');! }! } 8.x Plugin With Annotation
40
41
42
43
44
You want to upgrade your module to Drupal 8 and it defined an info hook or had a ctools plugin type ! Use annotation based discovery by default! It keeps the meta-data together with the class and is suited for typical plugin types where the actual class (code) is different for each plugins! YAML discovery is good for a case like local tasks where the vast majority use a common class, but a few will implement a different one (for example, to provide a dynamic title) Creating Your Own Plugins 45
Demo code used for this presentation:
 drupal.org/sandbox/pwolanin/2087657 ! Converting 7.x modules to 8.x 
 drupal.org/update/modules/7/8! Plugin API in Drupal 8
 drupal.org/developing/api/8/plugins! Why Plugins? drupal.org/node/1637614! Unraveling the Drupal 8 Plugin System drupalize.me/blog/201409/unravelling-drupal-8- plugin-system Plugin and General 8.x Resources 46
Widespread use of interfaces makes it easier to replace almost any implementation! Tabs are grouped regardless of path hierarchy! Route name rather than system path is unique! Multiple routes can serve the same path (HTML vs. JSON or GET vs. POST)! YAML as a standard for config and data files! Multiple instances of the same block! Each block instances has a config entity Drupal 8 Features I Mentioned 47
Plugins are a way to combine the discovery of available functionality with the actual implementation of the functionality! In Drupal 7, the combination of an info hook and multiple other hook functions (potentially in different files) served the same purpose! When defining your own plugins, use Annotation- based discovery unless you have a very clear reason for a different type To Sum It Up Licensed: http://creativecommons.org/licenses/by-nc-sa/2.0/ This presentation is © 2016, Acquia, Inc.

More Related Content

PPT
jQuery and_drupal
BlackCatWeb
 
PDF
Catalyst patterns-yapc-eu-2016
John Napiorkowski
 
PPT
[Srijan Wednesday Webinar] Rails 5: What's in It for Me?
Srijan Technologies
 
PDF
Geodaten & Drupal 7
Michael Milz
 
PPTX
Planbox Backbone MVC
Acquisio
 
PDF
[Srijan Wednesday Webinars] Ruling Drupal 8 with #d8rules
Srijan Technologies
 
PDF
Staying Sane with Drupal (A Develper's Survival Guide)
Oscar Merida
 
PPT
Drupal Javascript for developers
Dream Production AG
 
jQuery and_drupal
BlackCatWeb
 
Catalyst patterns-yapc-eu-2016
John Napiorkowski
 
[Srijan Wednesday Webinar] Rails 5: What's in It for Me?
Srijan Technologies
 
Geodaten & Drupal 7
Michael Milz
 
Planbox Backbone MVC
Acquisio
 
[Srijan Wednesday Webinars] Ruling Drupal 8 with #d8rules
Srijan Technologies
 
Staying Sane with Drupal (A Develper's Survival Guide)
Oscar Merida
 
Drupal Javascript for developers
Dream Production AG
 

What's hot (20)

PDF
#31.스프링프레임워크 & 마이바티스 (Spring Framework, MyBatis)_스프링프레임워크 강좌, 재직자환급교육,실업자국비지원...
탑크리에듀(구로디지털단지역3번출구 2분거리)
 
PDF
Symfony tips and tricks
Javier Eguiluz
 
PPT
Phase2 OpenPublish Presentation SF SemWeb Meetup, April 28, 2009
Krista Thomas
 
PDF
Using VueJS in front of Drupal 8
Brian Ward
 
PPTX
Vue business first
Vitalii Ratyshnyi
 
PDF
Drupal 8: Fields reborn
Pablo López Escobés
 
PPTX
Spring Boot
Jiayun Zhou
 
PDF
TurboGears2 Pluggable Applications
Alessandro Molina
 
PDF
No Coding Necessary: Building User Macros and Dynamic Reports Inside Confluen...
Atlassian
 
DOC
No Coding Necessary: Building Confluence User Macros Cheat Sheet - Atlassian ...
Atlassian
 
PPT
Render API - Pavel Makhrinsky
DrupalCampDN
 
PDF
SBT Crash Course
Michal Bigos
 
PPTX
Eddystone Beacons - Physical Web - Giving a URL to All Objects
Jeff Prestes
 
PDF
AspNetWhitePaper
tutorialsruby
 
PDF
Using RequireJS with CakePHP
Stephen Young
 
DOC
How to migrate Cakephp 1.x to 2.x
Andolasoft Inc
 
PPT
Creating the interfaces of the future with the APIs of today
gerbille
 
PDF
2021laravelconftwslides11
LiviaLiaoFontech
 
PPTX
Getting started with sbt
ikenna4u
 
PDF
Getting Into Drupal 8 Configuration
Philip Norton
 
#31.스프링프레임워크 & 마이바티스 (Spring Framework, MyBatis)_스프링프레임워크 강좌, 재직자환급교육,실업자국비지원...
탑크리에듀(구로디지털단지역3번출구 2분거리)
 
Symfony tips and tricks
Javier Eguiluz
 
Phase2 OpenPublish Presentation SF SemWeb Meetup, April 28, 2009
Krista Thomas
 
Using VueJS in front of Drupal 8
Brian Ward
 
Vue business first
Vitalii Ratyshnyi
 
Drupal 8: Fields reborn
Pablo López Escobés
 
Spring Boot
Jiayun Zhou
 
TurboGears2 Pluggable Applications
Alessandro Molina
 
No Coding Necessary: Building User Macros and Dynamic Reports Inside Confluen...
Atlassian
 
No Coding Necessary: Building Confluence User Macros Cheat Sheet - Atlassian ...
Atlassian
 
Render API - Pavel Makhrinsky
DrupalCampDN
 
SBT Crash Course
Michal Bigos
 
Eddystone Beacons - Physical Web - Giving a URL to All Objects
Jeff Prestes
 
AspNetWhitePaper
tutorialsruby
 
Using RequireJS with CakePHP
Stephen Young
 
How to migrate Cakephp 1.x to 2.x
Andolasoft Inc
 
Creating the interfaces of the future with the APIs of today
gerbille
 
2021laravelconftwslides11
LiviaLiaoFontech
 
Getting started with sbt
ikenna4u
 
Getting Into Drupal 8 Configuration
Philip Norton
 
Ad

Viewers also liked (20)

PDF
Hooks and Events in Drupal 8
Nida Ismail Shah
 
PPTX
Drupal 8 Development at the Speed of Lightning (& BLT)
Acquia
 
PDF
Drupal 8 Render Cache
Erik Stielstra
 
PPT
Why the Government of Bermuda Chose to Build Their New Citizen-centric Digita...
Acquia
 
PPTX
Going Beyond The Click: The Importance of Web Personalization
Acquia
 
PDF
Preventing Drupal Headaches: Establishing Flexible File Paths From The Start
Acquia
 
PDF
Tomorrow’s Personalization Today: Increase User Engagement with Content in Co...
Acquia
 
PPTX
Successes and Challenges When Managing Large Scale Drupal Projects
Acquia
 
PDF
Speedrun: Build a Website with Panels, Media, and More in 45 Minutes
Acquia
 
PPTX
3 Tips for a Successful Ektron to Drupal Conversion
Acquia
 
PDF
Drupal 8: The Foundation for Digital Experience and Digital Business
Acquia
 
PPTX
Going Global 101: How to Manage Your Websites Worldwide Using Drupal
Acquia
 
PDF
Introducing Workspace Preview System: Solve Your Content Preview Problems
Acquia
 
PDF
How Wilson Sporting Goods Is Changing the Game with Experiential Commerce
Acquia
 
PDF
From Stone Age-worthy Sites to Cohesive Content: How Trinity University is Us...
Acquia
 
PDF
Entities 101: Understanding Data Structures in Drupal
Acquia
 
PDF
Open Y: One Digital Platform for all YMCAs
Acquia
 
PPTX
Decoupled Drupal Showcase: Using Drupal to Power Digital Signage
Acquia
 
PDF
A Future-Focused Digital Platform with Drupal 8
Acquia
 
PPTX
Drupal 7 vs. Drupal 8: A Contrast of Multilingual Support
Acquia
 
Hooks and Events in Drupal 8
Nida Ismail Shah
 
Drupal 8 Development at the Speed of Lightning (& BLT)
Acquia
 
Drupal 8 Render Cache
Erik Stielstra
 
Why the Government of Bermuda Chose to Build Their New Citizen-centric Digita...
Acquia
 
Going Beyond The Click: The Importance of Web Personalization
Acquia
 
Preventing Drupal Headaches: Establishing Flexible File Paths From The Start
Acquia
 
Tomorrow’s Personalization Today: Increase User Engagement with Content in Co...
Acquia
 
Successes and Challenges When Managing Large Scale Drupal Projects
Acquia
 
Speedrun: Build a Website with Panels, Media, and More in 45 Minutes
Acquia
 
3 Tips for a Successful Ektron to Drupal Conversion
Acquia
 
Drupal 8: The Foundation for Digital Experience and Digital Business
Acquia
 
Going Global 101: How to Manage Your Websites Worldwide Using Drupal
Acquia
 
Introducing Workspace Preview System: Solve Your Content Preview Problems
Acquia
 
How Wilson Sporting Goods Is Changing the Game with Experiential Commerce
Acquia
 
From Stone Age-worthy Sites to Cohesive Content: How Trinity University is Us...
Acquia
 
Entities 101: Understanding Data Structures in Drupal
Acquia
 
Open Y: One Digital Platform for all YMCAs
Acquia
 
Decoupled Drupal Showcase: Using Drupal to Power Digital Signage
Acquia
 
A Future-Focused Digital Platform with Drupal 8
Acquia
 
Drupal 7 vs. Drupal 8: A Contrast of Multilingual Support
Acquia
 
Ad

Similar to Drupal 8, Where Did the Code Go? From Info Hook to Plugin (20)

PDF
Drupal 8 Deep Dive: Plugin System
Acquia
 
PPTX
Dcp'15
Piyuesh Kumar
 
PPTX
Валентин Мацвейко та Владислав Мойсеєнко — D8: Migrate Yourself: code->module...
LEDC 2016
 
PPTX
Migrate yourself. code -> module -> mind
Valentine Matsveiko
 
PPTX
D8 training
Vinay Abhang
 
PDF
D7 as D8
Pablo López Escobés
 
PPTX
Drupal 8 Hooks
Sathya Sheela Sankaralingam
 
PDF
Drupal 8 - Core and API Changes
Shabir Ahmad
 
PDF
Drupal 8 what to wait from
Andrii Podanenko
 
PDF
Web automation with #d8rules (European Drupal Days 2015)
Eugenio Minardi
 
PPTX
Top 8 Improvements in Drupal 8
Angela Byron
 
PDF
The state of hooking into Drupal - DrupalCon Dublin
Nida Ismail Shah
 
PDF
Drupal 7 migrating to drupal 8
DrupalGeeks
 
PDF
Drupal 7-api-2010-11-10
Shamsher Alam
 
PDF
Drupal 8 - Corso frontend development
sparkfabrik
 
PDF
Drupal 8 deeper dive
Amazee Labs
 
PDF
Gestione della configurazione in Drupal 8
Eugenio Minardi
 
PDF
Configuration Management in Drupal 8: A preview (DrupalDays Milano 2014)
Nuvole
 
PDF
Migrate to Drupal 8
Claudiu Cristea
 
PDF
Migrate 140123161042-phpapp02
Gaurav Varshney
 
Drupal 8 Deep Dive: Plugin System
Acquia
 
Dcp'15
Piyuesh Kumar
 
Валентин Мацвейко та Владислав Мойсеєнко — D8: Migrate Yourself: code->module...
LEDC 2016
 
Migrate yourself. code -> module -> mind
Valentine Matsveiko
 
D8 training
Vinay Abhang
 
D7 as D8
Pablo López Escobés
 
Drupal 8 Hooks
Sathya Sheela Sankaralingam
 
Drupal 8 - Core and API Changes
Shabir Ahmad
 
Drupal 8 what to wait from
Andrii Podanenko
 
Web automation with #d8rules (European Drupal Days 2015)
Eugenio Minardi
 
Top 8 Improvements in Drupal 8
Angela Byron
 
The state of hooking into Drupal - DrupalCon Dublin
Nida Ismail Shah
 
Drupal 7 migrating to drupal 8
DrupalGeeks
 
Drupal 7-api-2010-11-10
Shamsher Alam
 
Drupal 8 - Corso frontend development
sparkfabrik
 
Drupal 8 deeper dive
Amazee Labs
 
Gestione della configurazione in Drupal 8
Eugenio Minardi
 
Configuration Management in Drupal 8: A preview (DrupalDays Milano 2014)
Nuvole
 
Migrate to Drupal 8
Claudiu Cristea
 
Migrate 140123161042-phpapp02
Gaurav Varshney
 

More from Acquia (20)

PDF
Acquia_Adcetera Webinar_Marketing Automation.pdf
Acquia
 
PDF
Acquia Webinar Deck - 9_13 .pdf
Acquia
 
PDF
Taking Your Multi-Site Management at Scale to the Next Level
Acquia
 
PDF
CDP for Retail Webinar with Appnovation - Q2 2022.pdf
Acquia
 
PDF
May Partner Bootcamp 2022
Acquia
 
PDF
April Partner Bootcamp 2022
Acquia
 
PDF
How to Unify Brand Experience: A Hootsuite Story
Acquia
 
PDF
Using Personas to Guide DAM Results: How Life Time Pumped Up Their UX and CX
Acquia
 
PDF
Improve Code Quality and Time to Market: 100% Cloud-Based Development Workflow
Acquia
 
PDF
September Partner Bootcamp
Acquia
 
PDF
August partner bootcamp
Acquia
 
PDF
July 2021 Partner Bootcamp
Acquia
 
PDF
May Partner Bootcamp
Acquia
 
PDF
DRUPAL 7 END OF LIFE IS NEAR - MIGRATE TO DRUPAL 9 FAST AND EASY
Acquia
 
PDF
Work While You Sleep: The CMO’s Guide to a 24/7/365 Lead Machine
Acquia
 
PDF
Acquia webinar: Leveraging Drupal to Bury Your Sales Team In B2B Leads
Acquia
 
PDF
April partner bootcamp deck cookieless future
Acquia
 
PDF
How to enhance cx through personalised, automated solutions
Acquia
 
PDF
DRUPAL MIGRATIONS AND DRUPAL 9 INNOVATION: HOW PAC-12 DELIVERED DIGITALLY FOR...
Acquia
 
PDF
Customer Experience (CX): 3 Key Factors Shaping CX Redesign in 2021
Acquia
 
Acquia_Adcetera Webinar_Marketing Automation.pdf
Acquia
 
Acquia Webinar Deck - 9_13 .pdf
Acquia
 
Taking Your Multi-Site Management at Scale to the Next Level
Acquia
 
CDP for Retail Webinar with Appnovation - Q2 2022.pdf
Acquia
 
May Partner Bootcamp 2022
Acquia
 
April Partner Bootcamp 2022
Acquia
 
How to Unify Brand Experience: A Hootsuite Story
Acquia
 
Using Personas to Guide DAM Results: How Life Time Pumped Up Their UX and CX
Acquia
 
Improve Code Quality and Time to Market: 100% Cloud-Based Development Workflow
Acquia
 
September Partner Bootcamp
Acquia
 
August partner bootcamp
Acquia
 
July 2021 Partner Bootcamp
Acquia
 
May Partner Bootcamp
Acquia
 
DRUPAL 7 END OF LIFE IS NEAR - MIGRATE TO DRUPAL 9 FAST AND EASY
Acquia
 
Work While You Sleep: The CMO’s Guide to a 24/7/365 Lead Machine
Acquia
 
Acquia webinar: Leveraging Drupal to Bury Your Sales Team In B2B Leads
Acquia
 
April partner bootcamp deck cookieless future
Acquia
 
How to enhance cx through personalised, automated solutions
Acquia
 
DRUPAL MIGRATIONS AND DRUPAL 9 INNOVATION: HOW PAC-12 DELIVERED DIGITALLY FOR...
Acquia
 
Customer Experience (CX): 3 Key Factors Shaping CX Redesign in 2021
Acquia
 

Recently uploaded (20)

PDF
Electronic commerce courselecture one. Pdf
OmerMohamed64
 
PDF
Per capita expenditure prediction using model stacking based on satellite ima...
IAESIJAI
 
PPTX
PA Analog/Digital System: The Backbone of Modern Surveillance and Communication
AVTRON Technologies LLC
 
PDF
Dropbox Q2 2025 Financial Results & Investor Presentation
Dropbox
 
PDF
How UI/UX Design Impacts User Retention in Mobile Apps.pdf
SynapseIndia
 
PDF
TokAI - TikTok AI Agent : The First AI Application That Analyzes 10,000+ Vira...
SOFTTECHHUB
 
DOCX
The AUB Centre for AI in Media Proposal.docx
GAONE9
 
PDF
CIFDAQ's Market Insight: SEC Turns Pro Crypto
CIFDAQ
 
PDF
Spectral efficient network and resource selection model in 5G networks
IAESIJAI
 
PPTX
20250228 LYD VKU AI Blended-Learning.pptx
DatVoNgoc
 
PDF
cuic standard and advanced reporting.pdf
SimoneTitaniumTomase
 
PDF
Diabetes mellitus diagnosis method based random forest with bat algorithm
IAESIJAI
 
PPTX
VMware vSphere Foundation How to Sell Presentation-Ver1.4-2-14-2024.pptx
blackmambaettijean
 
PPTX
MYSQL Presentation for SQL database connectivity
Swati270511
 
PDF
The Rise and Fall of 3GPP – Time for a Sabbatical?
3G4G
 
PPTX
Digital-Transformation-Roadmap-for-Companies.pptx
David Malick Dieng
 
PPTX
Detection-First SIEM: Rule Types, Dashboards, and Threat-Informed Strategy
ReZa AdineH
 
PDF
Building Integrated photovoltaic BIPV_UPV.pdf
SandeepSingh286037
 
PDF
Chapter 3 Spatial Domain Image Processing.pdf
Getnet Tigabie Askale -(GM)
 
PDF
Review of recent advances in non-invasive hemoglobin estimation
IAESIJAI
 
Electronic commerce courselecture one. Pdf
OmerMohamed64
 
Per capita expenditure prediction using model stacking based on satellite ima...
IAESIJAI
 
PA Analog/Digital System: The Backbone of Modern Surveillance and Communication
AVTRON Technologies LLC
 
Dropbox Q2 2025 Financial Results & Investor Presentation
Dropbox
 
How UI/UX Design Impacts User Retention in Mobile Apps.pdf
SynapseIndia
 
TokAI - TikTok AI Agent : The First AI Application That Analyzes 10,000+ Vira...
SOFTTECHHUB
 
The AUB Centre for AI in Media Proposal.docx
GAONE9
 
CIFDAQ's Market Insight: SEC Turns Pro Crypto
CIFDAQ
 
Spectral efficient network and resource selection model in 5G networks
IAESIJAI
 
20250228 LYD VKU AI Blended-Learning.pptx
DatVoNgoc
 
cuic standard and advanced reporting.pdf
SimoneTitaniumTomase
 
Diabetes mellitus diagnosis method based random forest with bat algorithm
IAESIJAI
 
VMware vSphere Foundation How to Sell Presentation-Ver1.4-2-14-2024.pptx
blackmambaettijean
 
MYSQL Presentation for SQL database connectivity
Swati270511
 
The Rise and Fall of 3GPP – Time for a Sabbatical?
3G4G
 
Digital-Transformation-Roadmap-for-Companies.pptx
David Malick Dieng
 
Detection-First SIEM: Rule Types, Dashboards, and Threat-Informed Strategy
ReZa AdineH
 
Building Integrated photovoltaic BIPV_UPV.pdf
SandeepSingh286037
 
Chapter 3 Spatial Domain Image Processing.pdf
Getnet Tigabie Askale -(GM)
 
Review of recent advances in non-invasive hemoglobin estimation
IAESIJAI
 

Drupal 8, Where Did the Code Go? From Info Hook to Plugin

  • 1. Drupal 8, where did the code go? From info hook to plugin Peter Wolanin July 14, 2016
  • 2. Background and “What’s a plugin?”! Example of a core info hook conversion! Simple but common plugin example:
 adding new tabs (a.k.a. local tasks)! Configurable plugins (ConfigEntity based)! ‣ Adding a custom block! ‣ Adding a custom text filter! Considerations for defining your own plugins Here’s What’s In the Talk 2
  • 3. Drupal 5, 6, 7, 8 core contributor! Drupal Security Team! Acquia Engineering! Helped create some Drupal 8 plugins including SearchPlugin, MenuLinks, LocalTasks, LocalActions, ContextualLinks! DrupalCamp NJ organizer Who Am I? 3 https://www.drupal.org/u/pwolanin Photo by amazeelabs, by-nc-sa
  • 4. I’ll assume you know something about:! The DIC/container/service container! ‣ The container is an object that contains instances of stateless “services” (the current request, the current user, URL generator, etc)! The new routing system - names instead of paths.! ‣ a route name is just a machine name connected to a path and callbacks to provide, title, content, access etc. - like a D7 menu router! Namespaced classes (PHP 5.3+) like 
 DrupalsearchPluginBlockSearchBlock Drupal 8 Background 4
  • 5. Encapsulate some re-useable functionality inside a class that implements one or more specific interfaces! Plugins combine what in Drupal 7 was an info hook and a number of implementation hooks and possibly configuration: e.g. hook_search_info() and hook_search_execute(), etc., or hook_block_info() and hook_block_view(), _configure(), _save()! Evolved from ctools and views plugins, but have quite different mechanisms to discover them Plugins 5
  • 6. Every plugin type has a manager - registered as a service (available from the container) and used to find and instantiate the desired plugin instance(s)! Each plugin has an ID, which may be in its definition, or generated as a derivative! For a given plugin ID one single class will be used for all plugin instances using that plugin ID! A plugin instance is specified by the combination of plugin ID and its configuration values, potentially coming from a ConfigEntity Plugin Manager and IDs 6
  • 7. “The Drop is always moving” http://flickr.com/photos/alkalinezoo/32265389/ drupal.org/node/65922
  • 8. 7.x: hook_image_toolkits() 8 /**! * Implements hook_image_toolkits().! */! function system_image_toolkits() {! include_once DRUPAL_ROOT . '/' . drupal_get_path('module', 'system') . '/' . 'image.gd.inc';! return array(! 'gd' => array(! 'title' => t('GD2 image manipulation toolkit'),! 'available' => function_exists('image_gd_check_settings') &&! image_gd_check_settings(),! ),! );! }!
  • 9. 8.x: GD Image Toolkit Plugin 9 /**! * Defines the GD2 toolkit for image manipulation within Drupal.! *! * @ImageToolkit(! * id = "gd",! * title = @Translation("GD2 image manipulation toolkit")! * )! */! class GDToolkit extends ImageToolkitBase {! //... more methods ..//! ! public static function isAvailable() {! // GD2 support is available.! return function_exists('imagegd2');! }! ! //... more methods ..//! }
  • 10. 8.x: ImageToolkitManager 10 class ImageToolkitManager extends DefaultPluginManager {! // ... various methods ... //! ! /**! * Gets a list of available toolkits.! */! public function getAvailableToolkits() {! // Use plugin system to get list of available toolkits.! $toolkits = $this->getDefinitions();! ! $output = array();! foreach ($toolkits as $id => $definition) {! if (call_user_func($definition['class'] . '::isAvailable')) {! $output[$id] = $definition;! }! }! return $output;! }! }
  • 11. 7.x: image_desaturate() Function 11 /**! * Converts an image to grayscale.! *! * @param $image! * An image object returned by image_load().! *! * @return! * TRUE on success, FALSE on failure.! *! * @see image_load()! * @see image_gd_desaturate()! */! function image_desaturate(stdClass $image) {! return image_toolkit_invoke('desaturate', $image);! }! !
  • 12. 8.x: Image::desaturate() via Plugin 12 /**! * Defines an image object to represent an image file.! *! * @see DrupalCoreImageToolkitImageToolkitInterface! * @see DrupalimageImageEffectInterface! */! class Image implements ImageInterface {! //... more methods ..//! ! public function apply($operation, array $arguments = array()) {! return $this->getToolkit()->apply($operation, $arguments);! }! ! public function desaturate() {! return $this->apply('desaturate', array());! }! ! //... more methods ..//! }!
  • 13. 7.x: Operation by Function Prefix 13 /**! * Convert an image resource to grayscale.! *! * Note that transparent GIFs loose transparency when desaturated.! *! * @param $image! * An image object. The $image->resource value will be modified.! * @return! * TRUE or FALSE, based on success.! *! * @see image_desaturate()! */! function image_gd_desaturate(stdClass $image) {! // PHP using non-bundled GD does not have imagefilter.! if (!function_exists('imagefilter')) {! watchdog('image', 'The image could not be desaturated.');! return FALSE;! }! return imagefilter($image->resource, IMG_FILTER_GRAYSCALE);! }! !
  • 14. 8.x: Operations Are Also Plugins/**! * Defines GD2 Desaturate operation.! *! * @ImageToolkitOperation(! * id = "gd_desaturate",! * toolkit = "gd",! * operation = "desaturate",! * label = @Translation("Desaturate"),! * )! */! class Desaturate extends GDImageToolkitOperationBase {! ! protected function execute(array $arguments) {! // PHP using non-bundled GD does not have imagefilter.! if (!function_exists('imagefilter')) {! $this->logger->notice("The image could not be desaturated");! return FALSE;! }! return imagefilter($this->getToolkit()->getResource(),! IMG_FILTER_GRAYSCALE);! }! } 14
  • 16. Most plugin managers invoke an _alter hook so the modules can add to or alter the plugins’ definitions! For example, hook_block_alter()allows you to alter the block plugin definitions! Info hooks that simply return a data array, without associated code and logic, were not candidates to become plugins (but may have become YAML)! Others like hook_cron() or hook_entity_access() are still present Hooks Still Have Their Place 16
  • 17. The discovery of plugins is basically the same as invoking an info hook (and, in fact, it can even be implemented that way)! Discovery gives you an array of plugin definitions, each of which is just an array of keys and values! The discovery process fills in defaults, such a ‘provider’ which is the name of the module providing the plugin! Discovery can make derivatives (many from one) like FieldUiLocalTask - one tab per bundle Plugin Discovery 17
  • 18. YAML based:! MenuLink, LocalTask, LocalAction, ContextualLink! Annotation, some config, but no config entity:! ImageToolkit, Archiver! Annotation and config entity (many) including:! Block, ViewsDisplay, ImageEffect, SearchPlugin! Not a pure Plugin but uses Annotation discovery:! Entity (Node, User, etc.) Plugin Discovery & Config in Core 18
  • 19. Let’s Start Learning The Drupal 8.x Plugin Toolkit http://flickr.com/photos/booleansplit/2376359338/
  • 20. As in Drupal 7, code is provided by modules - so you need a module. You need a .info.yml file - like a .info file for Drupal 7! You no longer need even an empty .module file! The only remaining code in .module files are a few hook implementations: most code lives in classes Pre-requisite: a Drupal 8 Module 20 name: 'My test module'! type: module! description: ‘Acquia webinar demo.'! core: 8.x modules/mymodule/mymodule.info.yml
  • 21. For most uses, just add a YAML file listing your tabs: mymodule/mymodule.links.tasks.yml Adding Two Tabs: 21 mymodule.list_tab:! route_name: mymodule.list! title: 'List'! base_route: mymodule.list! ! mymodule.settings_tab:! route_name: mymodule.settings! title: 'Settings'! base_route: mymodule.list Plugin ID Local tasks reference a base route which groups them
  • 22. Unlike Drupal 7 you don’t need to jump though the hoops of a default local task, or making the paths align in a certain hierarchy Adding Two Tabs: 22
  • 23. Of course, those routes need to be defined or pre- existing: mymodule/mymodule.routing.yml LocalTask Plugins Need Routes: 23 mymodule.list:! path: '/admin/config/mymodule/list'! defaults:! _controller: 'DrupalmymoduleControllerMyController::dolist'! _title: 'Mymodule list'! requirements:! _access: 'TRUE'! ! mymodule.settings:! path: '/admin/config/also-mymodule/settings'! defaults:! _controller: 'DrupalmymoduleControllerMyController::settings'! _title: 'Mymodule settings'! requirements:! _access: 'TRUE'
  • 24. The plugin configuration options and defaults are on the LocalTaskManager class LocalTask Plugin Keys: 24 class LocalTaskManager extends DefaultPluginManager implements LocalTaskManagerInterface {! protected $defaults = array(! // (required) The name of the route this task links to.! 'route_name' => '',! // Parameters for route variables when generating a link.! 'route_parameters' => array(),! // The static title for the local task.! 'title' => '',! // The route name where the root tab appears.! 'base_route' => '',! // The plugin ID of the parent tab (or NULL for the top-level tab).! 'parent_id' => NULL,! // The weight of the tab.! 'weight' => NULL,! // The default link options.! 'options' => array(),! // Default class for local task implementations.! 'class' => 'DrupalCoreMenuLocalTaskDefault',! // The plugin id. Set by the plugin system based on the top-level YAML key.! 'id' => '',! );! }!
  • 26. Each custom block is defined in code as a class! When the admin places the block into a region in a theme, a configuration object is created to track that setting! The config object is a ConfigEntity - it’s an abstraction on top of CMI (storing your Drupal configuration in YAML files) - it makes it convenient to list, load, etc. using entity functions. ! Drupal can easily list the active block instances! Note - you don’t need to worry about the config! Blocks as Plugins 26
  • 27. Blocks implement the! DrupalCoreBlockBlockPluginInterface! If you extend the abstract
 DrupalCoreBlockBlockBase class then all you need to implement is the build() method! build() is basically the same as hook_block_view() in Drupal 7! For example, I added to my module
 DrupalmymodulePluginBlockMyBlock Blocks Implementation 27
  • 28. When I add the Block to my module:
 DrupalmymodulePluginBlockMyBlock! This is at the corresponding file path (under the Drupal root directory):
 modules/mymodule/src/Plugin/Block/ MyBlock.php! Note that the class name and the path match up under src/! This mapping of class name to path is how the class can be automatically found and loaded Side Note - PSR-4 28
  • 29. 29 /**! * Provides a block with 'Mymodule' links.! *! * @Block(! * id = "mymodule_my_block",! * admin_label = @Translation("Mymodule block")! * )! */! class MyBlock extends BlockBase {! public function build() {! return [! 'first_link' => [! '#type' => 'link',! '#title' => $this->t('Mymodule List'),! '#url' => Url::fromRoute('mymodule.list'),! ],! 'second_link' => [! '#type' => 'link',! '#title' => $this->t('Mymodule Settings'),! '#url' => Url::fromRoute('mymodule.settings'),! ],! ];! }! }
  • 32. 32 Save the Block to Create a New Plugin Instance
  • 33. 33
  • 34. Block Hook to Plugin Comparison 34 Drupal 7.x Drupal 8.x hook_block_info() BlockManagerInterface::
 getDefinitions() hook_block_view($delta) BlockPluginInterface::
 build() ? BlockPluginInterface::
 access(AccountInterface $account) hook_block_configure($delta) BlockPluginInterface::
 blockForm($form, $form_state) ? BlockPluginInterface::
 blockValidate($form, $form_state) hook_block_save($delta, $edit) BlockPluginInterface::
 blockSubmit($form, $form_state)
  • 35. Each Plugin type must be in the expected class namespace for your module - for blocks: namespace DrupalmymodulePluginBlock;! Most core plugins have a custom annotation class - you have to use the right one for your plugin! The annotation class provides both a documentation of the possible keys in the plugin definition and default values! There is also a generic Plugin annotation class Block Discovery and Annotations 35
  • 36. 36 /**! * Defines a Block annotation object.! *! * @Annotation! */! class Block extends Plugin {! /**! * The plugin ID.! *! * @var string! */! public $id;! ! /**! * The administrative label of the block.! *! * @var DrupalCoreAnnotationTranslation! *! * @ingroup plugin_translatable! */! public $admin_label;! ! //... more properties ..//! }
  • 38. 7.x Info Hook 38 /**! * Implements hook_filter_info().! *! * @ingroup project_issue_filter! */! function project_issue_filter_info() {! $filters['filter_project_issue_link'] = array(! 'title' => t('Project issue to link filter'),! 'description' => t('Converts references to project issues ! (in the form of [#12345]) into links.'),! 'process callback' => '_project_issue_filter',! 'tips callback' => '_project_issue_filter_tips',! 'cache' => TRUE,! );! return $filters;! }
  • 39. 39 /**! * Provides a filter to format a node ID as a link.! *! * @Filter(! * id = "mymodule_node_link",! * module = "mymodule",! * title = @Translation("Format a node ID as a link")! * )! */! class NodeLinkFilter extends FilterBase {! public function process($text, $langcode) {! $regex = ‘(?:(?<!w)[(#d+(?:-[d.]+)?)](?!w))|…’;! $callback = function($matches) { ... } ! $text = preg_replace_callback("/$regex/", $callback, $text);! return new FilterProcessResult($text);! }! ! // ... more code ...//! ! public function tips($long = FALSE) {! return $this->t('Node ID numbers (ex. [#12345]) turn into links automatically.');! }! } 8.x Plugin With Annotation
  • 40. 40
  • 41. 41
  • 42. 42
  • 43. 43
  • 44. 44
  • 45. You want to upgrade your module to Drupal 8 and it defined an info hook or had a ctools plugin type ! Use annotation based discovery by default! It keeps the meta-data together with the class and is suited for typical plugin types where the actual class (code) is different for each plugins! YAML discovery is good for a case like local tasks where the vast majority use a common class, but a few will implement a different one (for example, to provide a dynamic title) Creating Your Own Plugins 45
  • 46. Demo code used for this presentation:
 drupal.org/sandbox/pwolanin/2087657 ! Converting 7.x modules to 8.x 
 drupal.org/update/modules/7/8! Plugin API in Drupal 8
 drupal.org/developing/api/8/plugins! Why Plugins? drupal.org/node/1637614! Unraveling the Drupal 8 Plugin System drupalize.me/blog/201409/unravelling-drupal-8- plugin-system Plugin and General 8.x Resources 46
  • 47. Widespread use of interfaces makes it easier to replace almost any implementation! Tabs are grouped regardless of path hierarchy! Route name rather than system path is unique! Multiple routes can serve the same path (HTML vs. JSON or GET vs. POST)! YAML as a standard for config and data files! Multiple instances of the same block! Each block instances has a config entity Drupal 8 Features I Mentioned 47
  • 48. Plugins are a way to combine the discovery of available functionality with the actual implementation of the functionality! In Drupal 7, the combination of an info hook and multiple other hook functions (potentially in different files) served the same purpose! When defining your own plugins, use Annotation- based discovery unless you have a very clear reason for a different type To Sum It Up Licensed: http://creativecommons.org/licenses/by-nc-sa/2.0/ This presentation is © 2016, Acquia, Inc.