Download to read offline
![SOMEIMPORTANTDEPRECATEDHOOKS–hook_menu
hook_menu() -> Drupal 8 APIs should start with
defining the routes for the items.
<?php
# Drupal 7 menu item
$items['admin/content/book'] = array(
'title' => 'Books',
'description' => "Manage your site's book outlines.",
'page callback' => 'book_admin_overview',
'access arguments' => array('administer book outlines'),
'type' => MENU_LOCAL_TASK,
'file' => 'book.admin.inc',
);
?>](https://image.slidesharecdn.com/drupal8hooks-160726091009/85/Drupal-8-Hooks-4-320.jpg)
![SOMEIMPORTANTDEPRECATEDHOOKS–hook_menu
hook_init() -> Drupal 8 has adopted symfony as a
part of its core. It uses Symfony kernel and events
to do the same now.
<?php
function mymodule_init() {
if (!empty($_GET['redirect-me'])) {
drupal_goto('http://example.com/');
}
}
?>](https://image.slidesharecdn.com/drupal8hooks-160726091009/85/Drupal-8-Hooks-6-320.jpg)
![SOMEIMPORTANTDEPRECATEDHOOKS–hook_menu
mymodule.services.yml
services:
mymodule_event_subscriber:
class: DrupalmymoduleEventSubscriberMymoduleSubscriber
tags:
- {name: event_subscriber}
Src/ EventSubscriber/ MymoduleSubscriber.php
<?php
namespace DrupalmymoduleEventSubscriber;
use SymfonyComponentHttpFoundationRedirectResponse;
use SymfonyComponentHttpKernelKernelEvents;
use SymfonyComponentHttpKernelEventGetResponseEvent;
use SymfonyComponentEventDispatcherEventSubscriberInterface;
class MymoduleSubscriber implements EventSubscriberInterface {
public function checkForRedirection(GetResponseEvent $event) {
if ($event->getRequest()->query->get('redirect-me')) {
$event->setResponse(new RedirectResponse('http://example.com/'));
}
}
/**
* {@inheritdoc}
*/
static function getSubscribedEvents() {
$events[KernelEvents::REQUEST][] = array('checkForRedirection');
return $events;
}
}
?>](https://image.slidesharecdn.com/drupal8hooks-160726091009/85/Drupal-8-Hooks-7-320.jpg)
![SOMEIMPORTANTDEPRECATEDHOOKS–hook_menu
If your module just needs to add css and/or
javascript, hook_page_attachments should be
used in.
function MYMODULE_page_attachments(array &$attachments) {
$attachments ['#attached']['library'][] =
'modulename/libraryname';
}](https://image.slidesharecdn.com/drupal8hooks-160726091009/85/Drupal-8-Hooks-8-320.jpg)
![EXAMPLE–MAILAPI
/**
* Implements hook_mail().
*/
function d8mail_mail($key, &$message, $params) {
$options = array(
'langcode' => $message['langcode'],
);
switch ($key) {
case 'node_insert':
$message['from'] = Drupal::config('system.site')->get('mail');
$message['subject'] = t('Node created: @title', array('@title' => $params['node_title']), $options);
$message['body'][] = SafeMarkup::checkPlain($params['message']);
break;
}
}](https://image.slidesharecdn.com/drupal8hooks-160726091009/85/Drupal-8-Hooks-11-320.jpg)
![EXAMPLE–MAILAPI/**
* Implements hook_entity_insert().
*/
function d8mail_entity_insert(DrupalCoreEntityEntityInterface $entity) {
if ($entity->getEntityTypeId() !== 'node' || ($entity->getEntityTypeId() === 'node' && $entity->bundle() !== 'article')) {
return;
}
$mailManager = Drupal::service('plugin.manager.mail');
$module = 'd8mail';
$key = 'node_insert';
$to = Drupal::currentUser()->getEmail();
$params['message'] = $entity->get('body')->value;
$params['node_title'] = $entity->label();
$langcode = Drupal::currentUser()->getPreferredLangcode();
$send = true;
$result = $mailManager->mail($module, $key, $to, $langcode, $params, NULL, $send);
if ($result['result'] !== true) {
$message = t('There was a problem sending your email notification to @email for creating node @id.', array('@email' => $to, '@id' => $entity->id()));
drupal_set_message($message, 'error');
Drupal::logger('d8mail')->error($message);
return;
}
$message = t('An email notification has been sent to @email for creating node @id.', array('@email' => $to, '@id' => $entity->id()));
drupal_set_message($message);
Drupal::logger('d8mail')->notice($message);
}](https://image.slidesharecdn.com/drupal8hooks-160726091009/85/Drupal-8-Hooks-12-320.jpg)
![EXAMPLE–MAILAPI/**
* Implements hook_mail_alter().
*/
function d8mail_mail_alter(&$message) {
switch ($message['key']) {
case 'node_insert':
$message['headers']['Content-Type'] = 'text/html; charset=UTF-8; format=flowed; delsp=yes';
break;
}
}](https://image.slidesharecdn.com/drupal8hooks-160726091009/85/Drupal-8-Hooks-13-320.jpg)
![EXAMPLE–VIEWSAPI<?php
use DrupalviewsPluginviewsqueryQueryPluginBase;
use DrupalviewsViewExecutable;
function my_examples_views_query_substitutions(ViewExecutable $view){
$account = Drupal::currentUser();
return array(
'***CURRENT_TIME***' => REQUEST_TIME,
);
//echo "<pre>";print_r($view->getQuery());echo "</pre>";exit();
}
function my_examples_views_query_alter(ViewExecutable $view,QueryPluginBase $query) {
if ($view->id() == 'first_view') {
// Traverse through the 'where' part of the query.
foreach ($query->where as &$condition_group) {
foreach ($condition_group['conditions'] as &$condition) {
// If this is the part of the query filtering on title, chang the
// condition to filter on node ID.
if ($condition['field'] == 'node_field_data.title') {
$condition = array(
'field' => 'node_field_data.title',
'value' => 'Test 2',
'operator' => '=',
);
}
}
}
}
}](https://image.slidesharecdn.com/drupal8hooks-160726091009/85/Drupal-8-Hooks-14-320.jpg)
![EXAMPLE–ENTITYAPI<?php
use DrupalCoreEntityDisplayEntityViewDisplayInterface;
use DrupalCoreEntityEntityInterface;
use DrupalCoreFormFormStateInterface;
use DrupalnodeEntityNodeType;
use DrupalnodeNodeTypeInterface;
/**
* Implements hook_form_BASE_FORM_ID_alter().
*/
function reusable_forms_form_node_type_form_alter(&$form, FormStateInterface $form_state) {
$form['reusable_forms'] = array(
'#type' => 'details',
'#title' => t('Reusable forms'),
'#group' => 'additional_settings',
);
$node_type = $form_state->getFormObject()->getEntity();
$form['reusable_forms']['reusable_forms_enabled'] = array(
'#type' => 'checkbox',
'#title' => t('Enable reusable forms'),
'#description' => t('Check this box if you would like a reusable form on this node type.'),
'#default_value' => $node_type->getThirdPartySetting('reusable_forms', 'enabled', 0),
);](https://image.slidesharecdn.com/drupal8hooks-160726091009/85/Drupal-8-Hooks-26-320.jpg)
![EXAMPLE–ENTITYAPI$form_plugins = Drupal::service('plugin.manager.reusable_forms')->getDefinitions();
$options = [];
foreach ($form_plugins as $name => $plugin) {
$options[$name] = $plugin['name'];
}
$form['reusable_forms']['reusable_forms_plugin'] = array(
'#type' => 'radios',
'#title' => t('Available forms'),
'#default_value' => $node_type->getThirdPartySetting('reusable_forms', 'plugin', 'basic_form'),
'#options' => $options,
'#description' => t('The available forms you can choose from for this node type.'),
'#states' => array(
'visible' => array(
':input[name="reusable_forms_enabled"]' => array('checked' => TRUE),
),
),
);
$form['#entity_builders'][] = 'reusable_forms_form_node_type_form_builder';
}](https://image.slidesharecdn.com/drupal8hooks-160726091009/85/Drupal-8-Hooks-27-320.jpg)
![EXAMPLE–ENTITYAPI/**
* Implements hook_entity_extra_field_info().
*/
function reusable_forms_entity_extra_field_info() {
$extra = array();
$bundles = NodeType::loadMultiple();
$bundles = array_filter($bundles, function($bundle){
return $bundle->getThirdPartySetting('reusable_forms', 'enabled') === 1;
});
foreach ($bundles as $bundle) {
$extra['node'][$bundle->Id()]['display']['reusable_form'] = array(
'label' => t('Reusable form'),
'description' => t('Reusable form'),
'weight' => 100,
'visible' => TRUE,
);
}
return $extra;
}
/**
* Implements hook_ENTITY_TYPE_view().
*/
function reusable_forms_node_view(array &$build, EntityInterface $entity, EntityViewDisplayInterface $display, $view_mode, $langcode) {](https://image.slidesharecdn.com/drupal8hooks-160726091009/85/Drupal-8-Hooks-29-320.jpg)
Drupal 8 Hooks
- 1.
- 2. Hooks are functions thatare called for each module when system events happen, e.g. page load or user login Hooks
- 3. Drupal7VsDRUPal8 Number of hooksin Drupal 7 : 352 Number of hooks in Drupal 8 : 338 Deprecated hooks : 83 New hooks in Drupal 8 : 56 Renamed hooks : at least 4
- 4. SOMEIMPORTANTDEPRECATEDHOOKS–hook_menu hook_menu() -> Drupal8 APIs should start with defining the routes for the items. <?php # Drupal 7 menu item $items['admin/content/book'] = array( 'title' => 'Books', 'description' => "Manage your site's book outlines.", 'page callback' => 'book_admin_overview', 'access arguments' => array('administer book outlines'), 'type' => MENU_LOCAL_TASK, 'file' => 'book.admin.inc', ); ?>
- 5. SOMEIMPORTANTDEPRECATEDHOOKS–Hook_menu # Drupal 8book.routing.yml snippet book.admin: path: '/admin/content/book' defaults: _controller: ‘DrupalbookControllerBookController::adminOverview' _title: 'Books' requirements: _permission: 'administer book outlines‘ # Drupal 8 book.links.task.yml snippet book.admin: route_name: book.admin title: 'Books' base_route: system.admin_content
- 6. SOMEIMPORTANTDEPRECATEDHOOKS–hook_menu hook_init() -> Drupal8 has adopted symfony as a part of its core. It uses Symfony kernel and events to do the same now. <?php function mymodule_init() { if (!empty($_GET['redirect-me'])) { drupal_goto('http://example.com/'); } } ?>
- 7. SOMEIMPORTANTDEPRECATEDHOOKS–hook_menu mymodule.services.yml services: mymodule_event_subscriber: class: DrupalmymoduleEventSubscriberMymoduleSubscriber tags: - {name:event_subscriber} Src/ EventSubscriber/ MymoduleSubscriber.php <?php namespace DrupalmymoduleEventSubscriber; use SymfonyComponentHttpFoundationRedirectResponse; use SymfonyComponentHttpKernelKernelEvents; use SymfonyComponentHttpKernelEventGetResponseEvent; use SymfonyComponentEventDispatcherEventSubscriberInterface; class MymoduleSubscriber implements EventSubscriberInterface { public function checkForRedirection(GetResponseEvent $event) { if ($event->getRequest()->query->get('redirect-me')) { $event->setResponse(new RedirectResponse('http://example.com/')); } } /** * {@inheritdoc} */ static function getSubscribedEvents() { $events[KernelEvents::REQUEST][] = array('checkForRedirection'); return $events; } } ?>
- 8. SOMEIMPORTANTDEPRECATEDHOOKS–hook_menu If your modulejust needs to add css and/or javascript, hook_page_attachments should be used in. function MYMODULE_page_attachments(array &$attachments) { $attachments ['#attached']['library'][] = 'modulename/libraryname'; }
- 9. SOMEIMPORTANTDEPRECATEDHOOKS–hook_block hook_block_configure , hook_block_info, hook_block_view-> A "plugin" is just a new way of creating reusable elements in Drupal. Blocks are now created with plugins. modules/yourmodule/src/Plugin/Block/YourBlo ckName.php
- 10. SOMEIMPORTANTDEPRECATEDHOOKS–hook_block <?php /** * Provides a'Hello' Block * * @Block( * id = "hello_block", * admin_label = @Translation("Hello block"), * ) */ namespace Drupalhello_worldPluginBlock; use DrupalCoreBlockBlockBase; class HelloBlock extends BlockBase { /** * {@inheritdoc} */ public function build() { return array( '#markup' => $this->t('Hello, World!'), ); } } ?>
- 11. EXAMPLE–MAILAPI /** * Implements hook_mail(). */ functiond8mail_mail($key, &$message, $params) { $options = array( 'langcode' => $message['langcode'], ); switch ($key) { case 'node_insert': $message['from'] = Drupal::config('system.site')->get('mail'); $message['subject'] = t('Node created: @title', array('@title' => $params['node_title']), $options); $message['body'][] = SafeMarkup::checkPlain($params['message']); break; } }
- 12. EXAMPLE–MAILAPI/** * Implements hook_entity_insert(). */ functiond8mail_entity_insert(DrupalCoreEntityEntityInterface $entity) { if ($entity->getEntityTypeId() !== 'node' || ($entity->getEntityTypeId() === 'node' && $entity->bundle() !== 'article')) { return; } $mailManager = Drupal::service('plugin.manager.mail'); $module = 'd8mail'; $key = 'node_insert'; $to = Drupal::currentUser()->getEmail(); $params['message'] = $entity->get('body')->value; $params['node_title'] = $entity->label(); $langcode = Drupal::currentUser()->getPreferredLangcode(); $send = true; $result = $mailManager->mail($module, $key, $to, $langcode, $params, NULL, $send); if ($result['result'] !== true) { $message = t('There was a problem sending your email notification to @email for creating node @id.', array('@email' => $to, '@id' => $entity->id())); drupal_set_message($message, 'error'); Drupal::logger('d8mail')->error($message); return; } $message = t('An email notification has been sent to @email for creating node @id.', array('@email' => $to, '@id' => $entity->id())); drupal_set_message($message); Drupal::logger('d8mail')->notice($message); }
- 13. EXAMPLE–MAILAPI/** * Implements hook_mail_alter(). */ functiond8mail_mail_alter(&$message) { switch ($message['key']) { case 'node_insert': $message['headers']['Content-Type'] = 'text/html; charset=UTF-8; format=flowed; delsp=yes'; break; } }
- 14. EXAMPLE–VIEWSAPI<?php use DrupalviewsPluginviewsqueryQueryPluginBase; use DrupalviewsViewExecutable; functionmy_examples_views_query_substitutions(ViewExecutable $view){ $account = Drupal::currentUser(); return array( '***CURRENT_TIME***' => REQUEST_TIME, ); //echo "<pre>";print_r($view->getQuery());echo "</pre>";exit(); } function my_examples_views_query_alter(ViewExecutable $view,QueryPluginBase $query) { if ($view->id() == 'first_view') { // Traverse through the 'where' part of the query. foreach ($query->where as &$condition_group) { foreach ($condition_group['conditions'] as &$condition) { // If this is the part of the query filtering on title, chang the // condition to filter on node ID. if ($condition['field'] == 'node_field_data.title') { $condition = array( 'field' => 'node_field_data.title', 'value' => 'Test 2', 'operator' => '=', ); } } } } }
- 15. We can buildEntity types, which can make Bundles, to which we can add Fields and then create Entities. Entities
- 16. EntityAPI What’s an entity? Anentity type is a base class A bundle is an extended class A field is a class member, property, variable or field instance (depending on your naming preference) An entity is an object or instance of a base or extended class Drupal 7 Entity Types? Nodes (content) Comments Files Taxonomy terms Taxonomy vocabularies Users
- 17.
- 18.
- 19.
- 20. Drupal8hasconfigurationManagement!!! Configuration Stored in YAMLfiles, not database Canonical workflow: Change on dev, Deploy to prod Content Stored in database Canonical workflow: Changes on prod constantly. Drupal is not just a Content Management System: It’s Content & Configuration Management System
- 21.
- 22. Twofamiliesofentitytypes Content 1) Revisionable 2) Usescontent translation api 3) Fieldable 4) All data is the field and follows the field data model 5) Integrated with REST 6) ID is autogenerated, stable, non-recyclable Config 1) Non Revisionable 2) Uses config translation api 3) Not Fieldable 4) Data is PHP scalars/arrays and follows a type-defined schema. 5) Not integrated with REST 6) ID is a machine name that can be edited & recycled.
- 23. What’snotanentity? 1) Singular config(settings) 2) Keyvalue (state, tempstore) 3) Non-kv state (batch, config_snapshot, flood, queue, semaphore, sequences) 4) Session (sessions) 5) History/statistics (comment_entity_statistics, history, node_counter, tracker…) 6) Log (Watchdog) 7) Other (ban_ip, book, content_translation, file_usage, forum, node_access, url_alias)
- 24. EntityLIFECYCLE //Create, Save, Load,Delete $entity = entity_create($type,$values); $entity->DOSTUFF(); $entity->save(); $entity = entity_create($type,$id); $entity->DOSTUFF(); $entity->save(); $entity->delete(); // also $entities = entity_load_multiple_by_properties($type,$values);
- 25. EntityLIFECYCLEHooks hook_entity_create() hook_TYPE_create() ook_entity_presave() hook_TYPE_presave() hook_entity_insert()hook_TYPE_insert() hook_entity_load() hook_TYPE_load() hook_entity_update() hook_TYPE_update() hook_entity_predelete() hook_TYPE_predelete() hook_entity_delete() hook_TYPE_delete() Other entity hooks deals with access, view, revision, translation, bundle,… https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Entity!entity.api.ph p/group/entity_api/8
- 26. EXAMPLE–ENTITYAPI<?php use DrupalCoreEntityDisplayEntityViewDisplayInterface; use DrupalCoreEntityEntityInterface; useDrupalCoreFormFormStateInterface; use DrupalnodeEntityNodeType; use DrupalnodeNodeTypeInterface; /** * Implements hook_form_BASE_FORM_ID_alter(). */ function reusable_forms_form_node_type_form_alter(&$form, FormStateInterface $form_state) { $form['reusable_forms'] = array( '#type' => 'details', '#title' => t('Reusable forms'), '#group' => 'additional_settings', ); $node_type = $form_state->getFormObject()->getEntity(); $form['reusable_forms']['reusable_forms_enabled'] = array( '#type' => 'checkbox', '#title' => t('Enable reusable forms'), '#description' => t('Check this box if you would like a reusable form on this node type.'), '#default_value' => $node_type->getThirdPartySetting('reusable_forms', 'enabled', 0), );
- 27. EXAMPLE–ENTITYAPI$form_plugins = Drupal::service('plugin.manager.reusable_forms')->getDefinitions(); $options= []; foreach ($form_plugins as $name => $plugin) { $options[$name] = $plugin['name']; } $form['reusable_forms']['reusable_forms_plugin'] = array( '#type' => 'radios', '#title' => t('Available forms'), '#default_value' => $node_type->getThirdPartySetting('reusable_forms', 'plugin', 'basic_form'), '#options' => $options, '#description' => t('The available forms you can choose from for this node type.'), '#states' => array( 'visible' => array( ':input[name="reusable_forms_enabled"]' => array('checked' => TRUE), ), ), ); $form['#entity_builders'][] = 'reusable_forms_form_node_type_form_builder'; }
- 28. EXAMPLE–ENTITYAPI/** * Entity formbuilder for the node type form to map some values to third party * settings */ function reusable_forms_form_node_type_form_builder($entity_type, NodeTypeInterface $type, &$form, FormStateInterface $form_state) { if ($form_state->getValue('reusable_forms_enabled') === 1) { $type->setThirdPartySetting('reusable_forms', 'enabled', 1); $type->setThirdPartySetting('reusable_forms', 'plugin', $form_state->getValue('reusable_forms_plugin')); return; } $type->unsetThirdPartySetting('reusable_forms', 'enabled'); $type->unsetThirdPartySetting('reusable_forms', 'plugin'); }
- 29. EXAMPLE–ENTITYAPI/** * Implements hook_entity_extra_field_info(). */ functionreusable_forms_entity_extra_field_info() { $extra = array(); $bundles = NodeType::loadMultiple(); $bundles = array_filter($bundles, function($bundle){ return $bundle->getThirdPartySetting('reusable_forms', 'enabled') === 1; }); foreach ($bundles as $bundle) { $extra['node'][$bundle->Id()]['display']['reusable_form'] = array( 'label' => t('Reusable form'), 'description' => t('Reusable form'), 'weight' => 100, 'visible' => TRUE, ); } return $extra; } /** * Implements hook_ENTITY_TYPE_view(). */ function reusable_forms_node_view(array &$build, EntityInterface $entity, EntityViewDisplayInterface $display, $view_mode, $langcode) {
- 30.
- 31.