agaric-presentations/when-not-a-module-for-that

Fork 0

benjamin melançon ffabe0363a Update core version requirement displays

2020-04-30 14:58:40 -04:00

13 KiB

Raw Blame History

+++ title = "When There's Not a Module For That" outputs = ["Reveal"] +++

When There's Not a Module For That

Presented by

Benjamin Melançon & Mauricio Dinarte

AKA

mlncn & dinarcon

Together,

We are

⅓

of

ask@agaric.coop

{{% note %}} mid-air camp {{% /note %}}

When building a Drupal site, “there’s a module for that” can be the sweetest words you can hear.

What do you do

When there's not a module for that

{{% note %}} You make your own. It's easy. {{% /note %}}

{{% note %}} Say you're creating a site where people can relive great literature that may have been inspired by a famine.

You've already created an excellent content type under Structure » Content. {{% /note %}}

frankenstein.info.yml

name: Frankenstein
type: module
description: "Rename save button for Frankenstein's content."
core: 8.x

frankenstein.module

<?php
function frankenstein_form_node_frankenstein_form_alter(&$form, \Drupal\Core\Form\FormStateInterface $form_state) {
  $form['actions']['submit']['#value'] = t('Re-animate!');
}

Where to put these files

Enable your module:

drush -y en frankenstein

That slide was the most important you're going to be shown.

Enable your module

{{% note %}} Tadaaa! Now you know how to make a module! {{% /note %}}

{{% note %}} So you're all sitting* there thinking ... sure, that's easy if you know the exact words and symbols to put in that file. And you're absolutely right.

And we're going to tell you how you can figure out all of that. {{% /note %}}

frankenstein.info.yml

name: Frankenstein
type: module
description: "Rename save button for Frankenstein's content."
core: 8.x
core_version_requirement: ^8 || ^9

frankenstein.module

<?php
function frankenstein_form_node_frankenstein_form_alter(&$form, \Drupal\Core\Form\FormStateInterface $form_state) {
  $form['actions']['submit']['#value'] = t('Re-animate!');
}

{{% note %}} We added the core_version_requirement line to make the module recognizeable to Drupal 9 as well as Drupal 8. {{% /note %}}

A few basic approaches give a lot of power.

Screwdriver with extensive collection of driver tips.

{{% note %}} The examples with the what will tell you a lot about the how.

A few specific examples will give you a lot of tools.

But first, two secrets.

One's good news, second is bad news. {{% /note %}}

1. Now you know where to paste

{{% note %}} And knowing where to paste unleashes the power of Stack Overflow / Stack Exchange sites.

(yes, the same family of sites that has helped a couple million developers figure out how to quit vim.)

Knowing where to put this code unleashes the power of Stack Overflow.

You now know enough to be dangerous. {{% /note %}}

2. That simple form alter has hidden gotchas

As written, it only applies to the create (node/add) form— not the edit form.
There's a dozen variations of the humble form alter hook, and all are valid.

{{% note %}} With our dirty secrets acknowledged, on with the show. {{% /note %}}

The Show

Act One: How Not To Make a Module
Act Two: How Not To Have to Make a Whole Module
Act Three: How To Make a Module
Act Four: How To Figure Out How To Make a Module
Encore

{{% note %}} With our dirty secrets acknowledged, on with the show. {{% /note %}}

How to make a module

We'll cover

Hooks
- Form alter
- Node insert
Plugins
- Block
- Formatter
Services
- Route subscriber
- Event subscriber

the three main ways to mess with Drupal 8 and 9: hooks, plugins, and services, with a couple examples in each.

both examples of what technically to do and how to do general things

For example:

Doing something with a form? You want hook_form_alter() or one of its variants. {{% /note %}}

How to figure out how to make a module

Learning to learn

Drupal documentation
Drupal contributed modules
Drupal core and its modules
Drupal forums and issues
Drupal.StackExchange.com
The rest of the Internet
Debugger
Code search / grep

{{% note %}} Where to start if i don't cover it in this session {{% /note %}}

When not to make a module?

{{% note %}} You can do anything with a module! Why wouldn't you make one every day? {{% /note %}}

…when there's an easier way

{{% note %}} find a contrib module that does it

Should it be in a template? If it's very specific to the display on your site, you should probably do it in the theme layer. But if it's at all data and you might ever want to switch themes, or want to allow site builders or site managers to disable or change settings, get that in a module. {{% /note %}}

{{% note %}} I definitely recommend changing core compatibility to something reasonable, 8.x And Status to "All projects", not just Full, non-sandbox projects, if you're ready to write a module. A sandbox may be a great start. Then put in your key words and search. {{% /note %}}

There's a module that almost does exactly what you want

Contribute a patch!
Port it to Drupal 8/9!

{{% note %}} Even if your patch is not accepted nor is there any way given to build on the module, you can fork the module— maintain your own copy. {{% /note %}}

{{% note %}} This strategy is not without risks.

David was made a maintainer of Comment Notify, and now routinely fixes issues there all himself.

Still, that's generally better for everyone than to make your own module with duplicate functionality. {{% /note %}}

When to make a module

{{% note %}} You've identified to the best of your ability that there's definitely not something out there that does what you want to do.

I personally do not advocate introspection at this point: Why am i trying to do something that no one else is trying to do?

Credit: lego heart is credited to Llama-Muffin-Kelly on DeviantArt but only see it on Pinterest {{% /note %}}

Step 1: Write up what you plan to do

groups.drupal.org/contributed-module-ideas

{{% note %}} The module does not exist.

name: "Project Copyright"
type: module
description: "Generate a block with the copyright leyend."
core: 8.x
core_version_requirement: ^8 || ^9

<?php

namespace Drupal\copyright\Plugin\Block;

use Drupal\Core\Block\BlockBase;

/**
 * Provides a block with the copyright  legend.
 *
 * @Block(
 *   id = "copyright_block",
 *   admin_label = @Translation("Copyright"),
 * )
 */
class Copyright extends BlockBase {

  /**
   * @inheritDoc
   */
  public function build() {
    return [
      '#markup' => $this->t('Copyright © @year All rights reserved', ['@year' => date('Y')]),
    ];
  }

}

Resources

Most of these links go to a page on Drupal's API reference which is also a great place to go for an overview of what tools are available to you as you stretch and .

Key hooks

hook form_alter
hook_entity_extra_field_info + a 'field' site builders can use in entity view modes, such as to combine entity data and format it for display. Or you can replace those three hooks with one plugin by using the Extra field module

{{% note %}} A note on all these links: I've linked to the Drupal 9.0 version. These hooks all work in Drupal 8.x also. Drupal.org inadvertently for quite a while treated 8.2 as the end-all-and-be-all version of Drupal; this has been mitigated and is being fixed but Google is still likely to take you to 8.2 when searching for documentation on a hook. Just switch to the version you're using, or the latest version of Drupal if {{% /note %}}

The Rest of the Internet

Duck Duck Go (!g for Google results)
- ddg.co
agaric.coop/blog
Your own notes

A module that was generated with Drupal Console https://www.drupal.org/project/ckeditor_youtube/ - simple and used by many, and slowly got more complex

A module bringing in a PHP library and getting crazy (started with simple field formatter, can use this or another module to demo that) - https://drupal.org/project/inotherwords

Why contribute?

Right thing to do
I asked you to
People may contribute to it
Someone may take it over and upgrade it or improve it greatly

{{% note %}} Or someone may make a tiny improvement that makes everyone's lives better. {{% /note %}}

Nice touches

workflow_buttons.info.yml

 type: module
 description: 'Provide workflow buttons for content moderation instead of a select dropdown of states.'
 core_version_requirement: ^8 || ^9
 core: 8.x
+configure: workflow_buttons.settings
 
 dependencies:
   - drupal:system (>=8.4)

Your module composer.json:

{
    "name": "drupal/cyborgtranslate",
    "description": "Trigger Google translate and Drupal interface translation at the same time, allowing sections of your site's localization to be done by humans and the rest by machines.",
    "keywords": ["drupal", "translation", "multilingual", "localization", "google translate"],
    "type": "drupal-module",
    "license": "GPL-2.0+",
    "homepage": "https://www.drupal.org/project/cyborgtranslate",
    "minimum-stability": "dev",
    "support": {
        "issues": "https://www.drupal.org/project/issues/cyborgtranslate",
        "source": "https://gitlab.com/agaric/drupal/cyborgtranslate/tree/8.x-1.x"
    }
}

{{% note %}} Composer makes a lot of stuff seem more complicated, but it makes it easier to contribute.

Trust me... this will only be three screens of gibberish. {{% /note %}}

Your project root composer.json:

{
    "require": {
        "drupal/core": "^8.8.0",
        "drupal/cyborgtranslate": "dev-8.x-1.x as 1.x-dev",
        "drush/drush": "^9.0"
    },
    "repositories": {
        "drupal": {
            "type": "composer",
            "url": "https://packages.drupal.org/8"
        },
        "drupal/cyborgtranslate": {
            "type": "git",
            "url": "git@gitlab.com:agaric/drupal/cyborgtranslate.git"
        }
    }
}

MID.CAMP/6337 · ASK@AGARIC.COOP

{{% note %}} It's a big wild world out there. Bite off a piece you can chew.

Links for all of this and more on the session page. {{% /note %}}

13 KiB Raw Blame History