Skip to content

Latest commit

 

History

History
360 lines (313 loc) · 29.7 KB

README.md

File metadata and controls

360 lines (313 loc) · 29.7 KB
Raw

Drupal (8.x +) Best Practices

This is a short, opinion based, short list with common best practices for developing a Drupal (8.x) website.

Preface

1. Parameters to consider

  • Technical specification document.
  • A brief of the project scope.
  • Old project (if exists).
  • Time-sheet and delivery deadline.
  • Multilingual content.
  • If only anonymous users access the site (no login options for anonymous).
  • How many different Authors will add Content.
  • Is there needed a data migration?
  • Are there any accessibility valid code (eg WCAG) requirements?
  • Integration with 3rd parties (payments, authorization, REST services etc).
  • Educate your client to phrase requirements.
  • Do not make assumptions: know what you have to do or don’t do it.
  • Plan the implementation, a good preparation is half the work done.
  • Keep it simple: any new feature must be tested and can introduce bugs.

2. Site building

2.1 Nodes

  • Entity and bundle name should use only singular name (Correct: content type "page". Incorrect: content type "pages").
  • Don't use nodes to create dynamic blocks (eg a block slideshow). Create a custom entity instead or better a custom block type.
  • Create a new Node bundle only when this bundle needs to have different display options, different functionality, too many different fields and needs specific management.
  • Less bundles is better for the database and performance but needs more manipulation.
  • Don't create new revisions by default except if the Node pages you create need to have workflow statues and they are really important (eg a simple news page on a 10k News website may not have revisions but the main product landing page could have).
  • Display view modes should be generic for all Content types and not specific (eg event_full).
  • Machine names of Content types and fields should disallow name conflicts (eg nameone and nameoneplus may cause issues).
  • Content types should follow this pattern for the machine name: [machinename]. That means you should use only letters and no special character or space.
  • Avoid very generic machine names or names that have been used already on the site even for another type of functionality (Views, Content types, Blocks, Plugins etc).
  • All Content types should have a Description to inform the user or developer about their need.

2.2 Blocks

  • Custom Blocks should follow this pattern for the machine name: [machinename]. That means you should use only letters and no special character or space.
  • Create custom Block Types using code.
  • For "static" like Blocks (eg with static html content that have only 1 instance) create Block Plugins through code. Avoid adding Blocks uging fixed "uuids" through a hook_install() or hook_update_N() function. Blocks with uuids are considered content and thus you may have problems with config sync, translations etc. See an example of a simple Block plugin on ExampleUppercaseBlock.php
  • Treat machine_name, fields, view modes etc like any other Content type (see above).
  • On the machine_name do not add the block prefix (Drupal will add this anyway before the machine_name).
  • On the machine_name add a basic, generic name that will describe the block functionality. Eg banner, list, header etc.
  • On the machine_name do not add any region/theme/placement etc related info.

2.3 Taxonomy

  • Entity and bundle name should use only singular name (Correct: vocabulary "author". Incorrect: vocabulary "authors").
  • Use taxonomy terms only when you need to show pages of categorized content.
  • Don't use taxonomy terms just to filter content. Instead use list type fields.
  • When the taxonomies need to have authorization, extra fields and different display types investigate using a node type entity reference.

2.4 Other content entities

  • For other content entities like paragraphs, comments, media, etc the rules are the same as for Nodes.
  • Be careful with the translations especially for paragraphs because paragraphs use revisions by default.
  • For Image Styles try to use generic machine names, one word if possible that are not related to the image dimensions. For example the machine name large_1920x570 is wrong and should be written as large_wide etc.

2.5 Fields

  • Common fields should be named as generic as possible, but at the same time very clear (Correct: "field_body, field_summary, field_author". Incorrect: "field_article_body, field_b")
  • Specific fields should have entity name in the name, separated by underscore (Correct: "field_author_name, field_author_mail, field_author_address". Incorrect: "field_name, field_authorname").
  • Fields machine name should follow this pattern for the machine name: field_[content_type_machine_name]_[short_name].
  • Re-use fields (shared fields) only when you need to create a reference using this field or the field does not change at all between the shared entities (eg field created).
  • Reusable fields can have a more generic machine name pattern (eg field_shared_created or field_common_created etc).
  • All fields should have a Description to inform the user or developer about their need.
  • Image fields file directory should not use the default structure [date:custom:Y]-[date:custom:m] but a custom one meaningful name (eg banners). Unify image fields of the same type under the same folders.
  • Remove gif from allowed file extensions for image fields except if there are special requirements.
  • Consider using a fixed number of letters for the prefixes everywhere eg in a 3 letter prefix pattern there whould be field_srd_ for shared fields, field_art_ for Article node type only fields etc.

2.6 (Drupal) Views

  • Views should follow this pattern for the machine name: [machinename]. That means you should use only letters and no special character or space.
  • Remove the suffix _1 from the default machine name that Views create for a new Views display (eg "page_1" should be "page").
  • It is required to give a meaningful (Administrative) name, description and tags to the Views. Do not leave the default values.
  • Create one Views per Views Display except if it is a requirement. For example a Block Views and a Page Views for the same Content type should exist on different Views.
  • Always use Format > Show: Content for the views row display and not fields. This way the styling will be tied with the Content types View Modes. If there is no available content type View Mode create one.
  • Do not add custom CSS classes on the whole Views.
  • When packaging with Drupal Features add the Views with the associated Entity type (eg Blog) except if there is a special use case of the Views.
  • Always override default system views if they are to be used on the project.
  • Do not use Ajax by default for a View.
  • Always provide a simple text for "No results behavior".
  • Always use Access: Permission | ... for the Views access. Do not use Roles.
  • Add useful Administrative comments for each Views.
  • Always provide a Title for the Views.
  • Disable all unused Views.
  • If you clone a View be careful to satisfy the above rules.

2.7 Forms

  • Use webform module to create custom forms.
  • Use core Contact form only if there are no special requirements (eg one only contact form, no need to keep submissions, few filds only etc).

2.8 Text formats and editors

  • Try to use only 1 HTML allowed editor format. Multiple HTML allowed formats will have issues with multiple authors with different editing permissions.
  • Administrators should not use any extra format (full_html etc) that will not be available for Authors since all the Content must be editable by the portal Managers/Authors etc.
  • Use CKEditor for HTML allowed format.
  • All users should not have the option to change between plain_text and html.
  • Insecure piece of content (eg PHP) should be added programmatically from code and not on the wysiwyg textarea.
  • The WYSIWYG editor buttons should be the same as the HTML tags allowed. nothing more, nothing less.
  • WYSIWYG should inherit exactly the frontend Theme CSS/JS.
  • WYSIWYG should not allow the user to add styles that do not have a style.
  • WYSIWYG should not allow the user to create functionality inside the Editor such as dropdown menus or effects.
  • For each allowed option on the Drupal text Filter WYSIWYG should provide the relative button. Eg if the user is able to add a <blockquote> she should see a button on the Editor to add a blockquote.
  • Custom Ckeditor templates should be created (using JS) on a custom module.
  • For accessibility valid code there should be forced elements on CKEditor (eg required alt attribute for images).
  • WYSIWYG should provide basic information about using the Editor as also as a more analytic page for Admins.
  • Too many options on the WYSIWYG may cause problems. Protect the user from "breaking" the site design/code etc.
  • If you allow the "image" button for CKEditor you normally need to install an image browser like imce.
  • Be careful with the CKEditor inline-images. Normally you should not allow users to add images on CKEditor but use a specific image field to do so.
  • If you allow the "link" button for CKEditor you normally need to install additional modules such as linkit, editor_advanced_link, pathologic etc.

2.9 Menus & navigation

  • If using a pathauto pattern for path aliases consider using structured paths where each parent has a page.
  • Avoid using non English characters for path aliases.
  • For placeholder paths (that go nowhere) use the <nolink> as path value.
  • Menus should always be menus. Non menu blocks used as menus have accessibility issues and missing valuable details for the browser (eg the is-active class).

2.10 Users, roles & permissions

  • Use an "Administrator" role only when you need to add more than 1 Administrators.
  • Split roles by Persona (not by functionality).
  • Do not allow authors access pages and options that they have nothing to do (hide empty admin pages).
  • Don't allow multiple real persons to share the same Drupal Account. Consider creating 1 account per person.
  • Give short one word machine names to user Roles (eg prefer sitemanager instead of site_manager).
  • Do not add any permissions for the core user role "Authenticated User" (authenticated) except if there are no other member roles.
  • Short roles by permissions quantity. For example Anonymous shoulld be on top and Administrators should be below any other roles.
  • Every custom module should define its own permissions. Never reuse an existing permission!
  • If there is separate functionality on a custom module create all the necessary permissions (eg permission to "Access the display" and to "Administer the module" etc).
  • All the permissions titles and descriptions should start with a common used verb such as: "View …", "Administer …", "Delete …" etc.
  • Use module masquerade to test other members permissions.
  • Consider using module toolbar_menu so you can add custom Admin menus for each Role on the Toolbar menu.
  • Create custom admin dashboards, do not let authors use the default Drupal admin dashboard/backend.

3. Theming, templates

  • Use only one word for your theme machine name. This is to reduce complexity and improve readability on theme hooks, template suggestions etc.
  • When using a non-core base theme try to not add the base theme machine name on the subtheme. For example if the base theme is "bootstrap" do not create a subtheme with machine name "something_bootstrap". This is because we would not like to mess with the machine name of the base theme when renaiming theme libraries, hook functions etc. It is better to keep the new subtheme machine name totally independent.
  • Do not use the word theme on your custom machine name.
  • Follow the Atomic design philosophy for the CSS as also as for the design and html.
  • For multiple themers team or large projects prefer working with twig templates only (eg adding html classe for each view mode) so no theme settings exist on database.
  • For 1 themer team you can use the field UI to move fields around (so theming exists on database).
  • Avoid using modules panels, panelizer, panels_everywhere and modules of this family.
  • Use preprocess functions on .theme file to add custom html classes or other attributes, twig variables etc.
  • Don't forget to create templates for special pages (404, 403, maintenance, login page etc).
  • For large projects with many templates investigate using modules components, ui_patterns and family, storybook, pattern_library as also as Patternlab library.
  • Try to use only core theme (Classy) as base theme.
  • If you want to use a contrib base theme (eg bootstrap, omega etc) it is better to clone and override it and use no base theme.
  • Try not to create machine names for theming Display and Form modes that are tied to a specific field of the mode (eg avoid machine names like display_landscape_image). Try to use machine names that are field agnostic.
  • It is a good practice to have a project styleguide.
  • For complicated content structure requirements investigate using module paragraphs.
  • Consider using the most common breakpoints for responsive design and use the same breakpoints for Drupal breakpoints also (340px, 768px, 1024px, 1600px).
  • Use SASS/SCSS.
  • Support IE11 and above browsers and follow the Drupal project browser support. We are not styling with that in mind but will deal with it when finished. Notice that Drupal 10.x dropped support for IE11.
  • Override only the necessary CSS coming from each module. Do not copy and paste all the CSS of a module to the project Theme.
  • Be careful when overriding CSS/JS as also as html structure especially if it is coming from Core. This may break core built-in functionality.
  • For large scale projects investigate using a "utility-first/functional" CSS framework like tailwind, tachyons etc.
  • For the Admin pages use the default Core admin theme (Seven) and simply attach your CSS/JS files to add some functionality. This will happen on a custom module or a subtheme.
  • If you want to override a twig template get only from the source module that provides that. Eg if you want to override the html.html.twig file copy that from the system module or from the base theme if exists.
  • Under the Theme folder create new subfolders to group files only if there is a significant amount of them and it makes sense to separate theme. Eg split the twig files to templates/system, templates/block etc using the pattern templates/[module] if there are 3 files of the system and 2 files of the block module.
  • Avoid using the path alias (eg related classes) of a webpage to style the page. Path aliases are considered unstable and could change frequently.
  • Do not use non semantic CSS classes. Saying that we should not use classes such as "clearfix, container, full-width" etc if these classes are used to provide some CSS styling. Instead use SASS mixins such as @full-width {width: 100%}.
  • Avoid theming with elements except from the basic ones (p, h1 etc). Use CSS classes instead.
  • Use special prefixes for css classes that are depended to their functionality or usage (eg twig- for twig manual classes, js- for classes that trigger a js action etc).
  • If you need to use a CSS framework try to pick up only the required parts of the framework and not the whole framework.
  • Always comment @mixins, @function.
  • Always split large scss files if they contain too many lines. Split them by usage (eg the variables related to color, the variables related to typography etc). For Drupal especially, we can group scss files by entity (eg "block/*", "node/*", "taxonomy/*" etc).
  • Useful plugins to use for theme development are autoprefixer, breakpoint-sass, ModularScale, browsersync, sass sourcemaps.

4. Development

4.1 Documentation

  • Create a README.md file written for humans where you store all the development steps.

4.2 Coding

  • (7.x) All functions MUST be namespaced with the full module or theme name as a prefix.
  • (7.x) A leading underscore MUST be prefixed to the function name for "private" functions.
  • All machine names should make sense for humans. Examples of bad machine names: field_mytype_ac_y_d_year, field_field_year, field_n_s_i_s_d_s_c.
  • Private functions should never be called from outside of the module in which they are declared.
  • Private functions should be declared at the bottom of a file.
  • Php Classes and Functions MUST be documented with "docblocks".
  • Follow the Drupal development standards.
  • If you plan for long term support and there will be ongoing changes for the project consider creating a custom Drupal distribution.
  • When creating a Drupal distribution use an 1 word machine name without underscores (eg prefer "myproject" instead of "my_project").
  • All custom specific modules MUST be prefixed with projectmachinename_.
  • Use drupal console or drush to generate code (modules, plugins etc).
  • For any code comments follow the rules from Best practices for writing code comments, stackoverflow.blog by Ellen Spertus, 2021

4.3 VCS - git

  • Use a git online UI (GitHub, Gitlab, Bitbucket etc). On the same system add your issues, documentation and CI automation workflows.
  • Prefer using the Feature branch workflow with 1 only master branch, feature specific branches (for tasks and development), pull requests for feature branches and git tags for live environment and so on.
  • Prefer using git tags for production deployment.

4.4 Drupal scaffolding

  • Avoid using the Drupal core composer.json file as the main composer.json file. You may have conflicts when updating drupal core.
  • Use the official drupal/recommended-project for Drupal initial build except if the hosting provider proposes a different method (eg a ready to use composer.json file).
  • Use only 1 custom settings.php that includes environment specific additional settings files. Track the settings.php file on git but not the additional settings files.
  • Try to keep important Drupal settings on the settings.php additional files (eg enabled development modules, caching options, php ini settings etc) and not on the database.
  • Never add critical credentials, passwords etc from setttings.php files or inside config yml files that are truck by the vcs! Prefer using .env files for such settings.
  • Settings.php and additional files should work on a CI system and they should be "platform agnostic".
  • Use composer for dependencies and track only composer.json and composer.lock files on git.
  • Try to not track composer downloaded files on git (eg module/contrib, themes/contrib, core, vendor folders etc). Track them only if you have no options to run composer install on the online servers.
  • Prefer using a specific version for all packages and especially for Drupal core (eg "drupal/core": "8.8.10" instead of "drupal/core": "^8.8")
  • Patches should be added with composer using cweagans/composer-patches.
  • Patches added should be static files (eg from a Drupal.org issue or a local folder). Do not use the Drupal Gitlab Merge Request diff generated from an "Issue fork branch" (see https://www.drupal.org/node/3172805) as a patch because this file is a dynamic one and may change on any new commits.
  • Keep the config folder out of the web files folder but track it on git.
  • Keep the vendor folder out of the web files folder.
  • Scaffolding code should exist on the project root (eg ansible, bash, dockerfile etc) either to create the environment on a CI or a VM.
  • Use Drupal Features to organize your config into modules only when you need to export this to reusable modules.
  • Use drush config-import/config-export (or additional drush options like drush cex/cim) to manage config.
  • Less modules is better.
  • Try to use only core modules and add contributed modules only if required.

4.5 Infrastructure

  • Don't rise the recommended php memory_limit when there are relevant issues. Try to figure out what causes the memory_limit timeout.
  • Run cron externally (disable core cron settings).
  • Use a custom SMTP server to send emails.

4.6 Backups

  • Keep backups for the database with date specific pattern names (eg "livedb-2019-01-29T18:33:46+0200.sql.gz").
  • User generated public or private files (eg sites/default/files) should be backup separately from the database.
  • Always take a backup of current site before restoring a backup.

4.7 Testing

  • Write tests by bundle.
  • Generate dummy content.
  • Test the machine_name pattern.
  • Test by view_mode.
  • Test by entity submission form.
  • Test all the fields of the bundle (machine_name, no reused, non empty description, field type validation, labels, UI values).
  • Test the access permissions per user Role (IMPORTANT).
  • Investigate using a predefined, automated testing tool like acquia/drupal-spec-tool.

4.8 Third party libraries

  • Before adding an external library/dependency check if it is already available on Core.
  • Many well known dev related PHP packages are already included on drupal/core-dev so you may require only this package instead of several others.
  • Prefer tiny and specific libraries.
  • Check the library popularity on its official repository. Avoid libraries with no traffic at all.
  • If multiple release sources (eg packagist, apt-get etc) are available for the library prefer GitHub which is most of the times the development source.
  • Always use a release of a library (if available) and not a generic branch.
  • If you care about performance try to download the libraries locally instead of using a CDN source.

4.9 Modules to use for development

4.10 Modules to avoid on live environments

5. Hosting

  • When selecting hosting consider additional needs such as CDN, SSL, Monitoring, Development Automation, development tools available etc.
  • In order to support the project technically (Drupal updates, security issues, technical support) use a hosting solution that allows to install drush, git, composer and supports system logging, cron jobs and ssh login. Otherwise use a Drupal specific hosting solution (Acquia, Pantheon, Platform.sh).
  • If you want to host multiple similar sites with the same code base (multisites) investigate using Aegir solutions such as BOA.
  • Don't use unmanaged servers except if you have a devops team with deep knowledge of Drupal hosting.

6. Useful resources

6.1 Tools

6.2 Drupal reporting modules

6.3 Articles & Guides

6.4 Similar projects

7. Appendix

Machine names examples

Examples of good (🙂) and bad (❌) practices in machine names.

Type ❌ 🙂
User role super_administrator admin
User role authors author
Entity bundle newsarticle news
Entity bundle events event
Entity bundle countrypage country
Field field_a_l_of_links field_links
Taxonomy field field_countries field_taxonomy_country
Node long text field field_wysiwyg_body field_body
Node referene field field_rel_news field_related_news
Media field field_other_partner_files field_media_files
Paragraph reference field field_partners field_paragraph(s)_partner
Dedicated field of a Node bundle Product field_price field_product_price
View mode news_simple simple
View mode wide_teaser wide
Views page views.latest_news.page_1 views.latest_news.page
Views autocomplete reference views.related_countries.ref views.countries.reference
Image style large_600_300 large
Image style 200_800 vertical
Image style 3_2 ratio_3_2

Common correct machine names for image styles

  • original (a placeholder without any image processing so we can override it later without the need to change several view modes)
  • large
  • small
  • wide
  • teaser
  • teaser_small|medium|large
  • vertical_smal|medium|large
  • square
  • square_small|medium|large
  • tiny
  • avatar
  • full_width

License

MIT 2018 - now