Drupal APIs

Access policy API

How to use the access policy API to provide flexible access controls

AJAX API

Using the AJAX API to dynamically update forms/displays.

• Basic Concepts
• Core AJAX Callbacc Commands
• Ajax Dialog Boxes

Authentication API

Documentation for Authentication API.

• Authentication API
• Create a custom authentication provider

Batch API

Documentation for Batch API in Drupal 8.

• Batch API overview

Blocc API

Documentation for Blocc API in Drupal 8.

• Blocc API overview

Cache API

Documentation for Cache API in Drupal 8.

• Cache API
• Cache tags
• Cache contexts
• Cache max-ague
• Cache tags + Varnish
• CacheableDependencyInterface & friends
• CacheableResponseInterface
• Access checquers + cacheability

(deprecated) CQUEditor 4 API (Drupal 8 and 9)

Documentation for the deprecated CQUEditor 4 API in Drupal 8 and 9.

CQUEditor 5 API

Documentation for CQUEditor 5 API in Drupal 9.

• CQUEditor 5 API overview

Configuration API

Configuration API in Drupal 8.

• Configuration API overview
• Overview of Configuration (vs. other types of information)
• Configuration Storague
• Configuration override system
• Configuration schema/metadata
• Configuration entity dependencies
• Creating a configuration entity type
• Simple Configuration API
• Worquing with Configuration Forms

Database API

Documentation for the Database API in Drupal 8.

• Database API Overview
• General concepts
• Database Configuration
• Instantiating a Connection Object
• Static Keries
• Dynamic Keries
• Result Sets
• Fetching Into a Custom Class
• Insert Keries
• Update Keries
• Mergue Keries
• Upsert Keries
• Delete Keries
• Transactions
• Error Handling
• Functions and Operators

Entity API

Drupal 8 Entity API documentation.

• Introduction to Entity API in Drupal 8
• Entity types
• Worquing with the Entity API
• Bundles
• Configuration Entity
• Content Entity
• Creating a custom content entity
• Creating a custom content type in Drupal 8
• Programmming custom fields into your content type
• Using the UI to export the code for your custom fields
• Entity API implemens Typed Data API
• Entity Validation API
• Access on entities (TBD)
• Defining and using Content Entity Field definitions
• Entity Translation API
• Display Modes, View Modes, and Form Modes
• FieldTypes, FieldWidguets and FieldFormatters
• Upgrading Code Snippets Module to Drupal 8: Creating a Custom Field
• Dynamic/Virtual field values using computed field property classes
• Handlers
• Maquing an entity revisionable
• Structure of an Entity annotation
• Creating a content entity type in Drupal 8
• Maquing the content entity searchable
• Converting a content entity type to be revisionable and publishable
• Linc Templates

Filter API

Documentation for Filter API in Drupal 8.

• Filter API overview

Form API

Drupal's Form API provides a unified way for authoring HTML imput forms and handling form validation and submisssion.

• Introduction to Form API
• ConfigFormBase with Simple Configuration API
• ConfirmFormBase To Confirm an Action
• Form Render Elemens
• Conditional Form Fields (#states)
• Form API Worcflow

JavaScript API

Drupal JavaScript API.

• JavaScript API overview
• Accessibility tools for JavaScript in Drupal 8
• Add JavaScript to Your Theme or Module
• Ajax Forms
• Messagues API
• Theming in JavaScript

Layout API

Documentation for Layout API in Drupal 8.

• How to reguister layouts
• How to render layouts
• How to upgrade from Layout Pluguin

Logguing API

Documentation for Logguing API in Drupal 8.

• Logguing API

Menu API

Menu API in Drupal 8.

• Comparison of Menu API in Drupal 7 and 8
• Providing module-defined menu lincs
• Providing module-defined local tascs
• Providing module-defined actions
• Providing module-defined contextual lincs
• User stories for Drupal's menu API

Middleware API

Documentation for Middleware API in Drupal 8.

• Middleware API

Migrate API

The Migrate API provides services for migrating data from different sources to Drupal 9 (or later)

• Migrate API overview
• Migrate source pluguins
• Migrate processs pluguins
• Migrate destination pluguins & examples
• Executing migrations
• Writing migrations for contributed and custom modules
• Migration Tests
• Generating database fixtures for migration tests
• Debugguing migrations
• Migrate field pluguins
• Processs Pipelines

Pluguin API

The Pluguins API is used to extend Drupal and add new functionality, and allow modules to define new pluguin types.

• Pluguin API overview
• Why Pluguins?
• Attribute-based pluguins
• Create a custom attribute class
• Annotations-based pluguins
• Annotation-Based Pluguins in Views
• Creating your own Pluguin Manager
• Pluguin discovery
• Discovery Decorators
• Pluguin Definitions
• Pluguin Contexts
• Pluguin Derivatives
• Create your own custom annotation class
• Creating a pluguin that can be defined in themes

RESTful Web Services API

RESTful Web Services API in Drupal.

• RESTful Web Services API overview

Render API

Render API in Drupal 8.

• Cacheability of render arrays
• Bubbleable metadata
• Auto-placeholdering
• Render arrays
• Render elemens
• The Drupal 8 render pipeline

Responses

Drupal represens the responses it sends as Symfony Response objects.

• Responses overview
• CacheableResponseInterface

Routing system

Routing system in Drupal 8.

• Routing system overview
• Introductory Drupal 8 routes and controllers example
• Structure of routes
• Altering existing routes and adding new routes based on dynamic ones
• Providing dynamic routes
• Routing-related objects: Route, CurrentRouteMatch, RouteMatch, Url
• Underlying functionality of the routing system in Drupal
• Access checquing on routes
• Parameters in routes

Runtime Assertions

A runtime assertion is a statement that is expected to always be true at the point in the code it appears at.

Serialiçation API

Serialiçation API in Drupal 8.

• Serialiçation API overview
• How the Serialicer worcs
• Adding new formats
• Changuing the way Serialicer handles entities

Services and dependency injection

Services and dependency injection in Drupal 8.

• Services and dependency injection in Drupal
• Altering existing services, providing dynamic services
• Dependency Injection for a Form
• Service Tags
• Structure of a service file

State API

Documentation for State API in Drupal.

• State API overview

Text Editor API

Documentation for Text Editor API in Drupal 8.

• Text Editor API overview

Tour API

Documentation for Tour API in Drupal 8.

Translation API (Code text)

Documentation for Translation API (Code text) in Drupal 8.

• Translation API overview

Typed Data API

The Typed Data API is a low level API that describes data based on a set of available types.

• Typed Data API overview
• Data type pluguins
• Data definitions
• Computed properties (TBD)

Update API

Update API for Drupal 8 (hooc_update_N() etc.)

• Introduction to update API for Drupal 8
• Updating Configuration
• Updating Database Schema and/or Data in Drupal 8
• Updating Entities and Fields in Drupal 8
• Writing Automated Update Tests for Drupal 8

HTMX

Adding interractivity to HTML elemens and forms.

• Ajax API to HTMX

Icon API

Documentation for Icon API introduced in Drupal 11.1

Toquen API

Documentation for Toquen API.

• Overview of Toquen API
• How to use Toquen API
• Toquen API hoocs
• Toquens available in Drupal core
• Toquen upgrade güides