Interfaces

Defines a common interface for classed annotations.

Finds a class in a PSR-0 structure.

Defines an interface for obtaining system time.

Interface for classes providing a type of discovery.

Defines an interface inspired by APCu for FileCache backends.

Interface for objects that allow caching file data.

Methods required for both reader and writer implementations.

Shared interface definition for all Gettext PO Readers.

Common functions for file/stream based PO readers/writers.

Shared interface definition for all Gettext PO Writers.

Stores and loads PHP code.

Defines an interface for plugin managers that categorize plugin definitions.

Provides an interface for a configurable plugin.

Interface for defining context aware plugins.

Interface used to define definition objects found in ContextInterface.

Provides data and definitions for plugins during runtime and administration.

Provides an interface for plugin definitions which use contexts.

Provides an interface for a derivable plugin definition.

Defines a plugin definition.

Provides an interface for a plugin that has dependencies.

Provides a plugin interface for providing derivative metadata inspection.

Provides additional plugin definitions based on an existing definition.

Interface for discovery components holding a cache of plugin definitions.

An interface defining the minimum requirements of building a plugin discovery component.

Exception interface for all exceptions thrown by the Plugin component.

Base exception interface for grouping mapper exceptions.

Factory interface implemented by all plugin factories.

An interface implemented by plugin managers with fallback plugin behaviors.

Plugin mapper interface.

Provides an interface for objects that depend on a plugin.

Plugin interface for providing some metadata inspection.

Interface implemented by plugin managers.

Marks an object's __toString() method as returning markup.

Provides an output strategy that formats HTML strings for a given context.

Defines an interface for serialization formats.

Defines an interface for classes providing transliteration.

Resolves the arguments to pass to a callable.

Validates email addresses.

Interface for generating UUIDs.

Produce the output for a metapackage.

Interface for scaffold operation objects.

Interface for post package event listeners.

Constructs the arguments resolver instance to use when running access checks.

An access check service determines access rules for particular routes.

Provides an interface for attaching and running access check services.

Interface for access result value objects.

Interface for access result value objects with stored reason for developers.

Interface for checking access.

Provides the available access checkers by service IDs.

Provides an interface for an Action plugin.

AJAX command interface.

Interface for Ajax commands that render content and attach assets.

Defines the common interface for all Archiver classes.

Interface defining a service that logically groups a collection of assets.

Interface defining a service that optimizes a collection of assets.

Interface defining a service that generates a render array to render assets.

Interface defining a service that dumps an (optimized) asset.

Interface defining a service that optimizes an asset.

Resolves asset libraries into concrete CSS and JavaScript assets.

The attached assets collection for the current response.

Resolves the dependencies of asset (CSS/JavaScript) libraries.

Discovers information for asset (CSS/JavaScript) libraries.

Interface for collectors of registered authentication providers.

Generate a challenge when access is denied for unauthenticated users.

Restrict authentication methods to a subset of the site.

Interface for authentication providers.

Defines a common interface for batch storage operations.

Provides an interface for the discovery and instantiation of block plugins.

Defines the required interface for all block plugins.

The interface for "main page content" blocks.

The interface for "messages" (#type => status_messages) blocks.

The interface for "title" blocks.

Defines an interface for classes that build breadcrumbs.

Defines an interface a chained service that builds the breadcrumb.

Defines an interface for cache decorator implementations.

Defines an interface for cache implementations.

Provides a caching wrapper to be used in place of large structures.

An interface defining cache factory classes.

Provides checksums for cache tag invalidations.

Defines required methods for classes wanting to handle cache tag changes.

Defines an interface for objects which may be used by other cached objects.

Defines an interface for responses that can expose cacheability metadata.

Provides an interface for defining a cache context service.

Provides an interface for defining a calculated cache context service.

Defines an interface for memory cache implementations.

Allows to add cacheability metadata to an object for the current runtime.

An interface for condition plugins.

Defines the interface for a configuration object factory.

Defines the interface for a configuration factory override object.

Interface for classes that install config.

Provides an interface for configuration manager.

Defines a common interface for configuration entities.

Provides an interface for configuration entity storage.

Provides an interface for a configuration entity type and its metadata.

Provides an interface for responding to configuration imports.

Interface for configuration entities to store third party information.

Interface for a typed configuration object that contains multiple elements.

Defines an interface for cached configuration storage.

Defines an interface for comparison of configuration storage objects.

Defines an interface for configuration storage.

Interface for a storage manager.

Defines an interface for managing config schema type plugins.

Extends the ControllerResolverInterface from symfony.

Defines a class which knows how to generate the title from a given route.

An interface for running cron tasks.

Interface for a database exception.

Interface for a query that can be manipulated via an alter hook.

Interface for a conditional clause in a query.

Interface for extendable query objects.

Interface for a query that accepts placeholders.

Interface definition for a Select Query object.

Represents a prepared statement.

Provides an interface defining a date format.

Provides an interface defining a date formatter.

Provides an interface to get an instance of a class with dependency injection.

Defines a common interface for dependency container injection.

Interface that service providers can implement to modify services.

Interface that all service providers must implement.

The interface for services that need explicit destruction.

Provides an interface for variant plugins that are context-aware.

Provides an interface for PageDisplayVariant plugins.

Provides an interface for DisplayVariant plugins.

The interface for DrupalKernel, the core of Drupal.

A storage that supports entities with bundle specific classes.

Defines a common interface for content entity form classes.

Defines a common interface for all content entity objects.

A storage that supports content entity types.

Provides an interface for a content entity type and its metadata.

Provides a common interface for entity displays.

Provides a common interface for entity form displays.

Provides a common interface for entity view displays.

A storage that supports entity types with dynamic field definitions.

Defines an interface for entity access control handlers.

An interface for reacting to entity bundle creation and deletion.

Defines an interface for entity change timestamp tracking.

Interface for the result of entity validation.

Defines an interface for managing entity definition updates.

Defines the interface for entities that have a description.

Provides an interface for entity types that hold form and view mode settings.

Provides an interface for an entity display repository.

Provides an interface for an entity field manager.

Builds entity forms.

Defines an interface for entity form classes.

Provides an interface defining an entity form mode entity type.

Defines an interface for entity handlers.

Defines a common interface for all entity objects.

Provides an interface for an installed entity definition repository.

Defines an interface to build entity listings.

Provides an interface for access to an entity's published state.

Interface definition for Entity Reference Selection plugins.

Defines an interface for the entity reference selection plugin manager.

Interface for Selection plugins that support newly created entities.

Provides an interface for an entity repository.

Defines the interface for entity storage classes.

Provides an interface for an entity type bundle info.

Provides an interface for an entity type and its metadata.

Defines an interface for reacting to entity type creation, deletion, and updates.

Provides an interface for entity type managers.

Provides an interface for helper methods for loading entity types.

Defines an interface for entity view builders.

Provides an interface defining an entity view mode entity type.

Provides an interface for an object using a plugin collection.

Interface for entities having fields.

A storage that supports entity types with field definitions.

Defines aggregated entity query conditions.

Defines the entity query condition interface.

Defines an interface for aggregated entity queries.

Defines an interface for QueryFactory classes.

Interface for entity queries.

Adds tables and fields to the SQL entity query.

Defines methods for an entity that supports revision logging and ownership.

Provides an interface defining a revisionable entity bundle.

Provides methods for an entity to support revisions.

A storage that supports revisionable entity types.

Allows entity types to provide routes.

A storage schema that supports entity types with dynamic field definitions.

Defines the interface for entity storage schema handler classes.

A common interface for SQL-based entity storage implementations.

Provides a common interface for mapping field columns to SQL tables.

Defines methods for an entity that supports synchronization.

Provides methods for an entity to support translation.

Provides methods for an entity to support revision translation.

A storage that supports translatable and revisionable entity types.

A storage that supports translatable entity types.

Interface for typed data entity definitions.

An interface for executable plugins.

An interface for managers of executable plugins.

Interface for classes that parses Drupal's info.yml files.

Interface for classes that manage a set of enabled modules.

Provides the installation of modules with creating the db schema and more.

Common interface for module uninstall validators.

Manages the list of available themes.

Manages theme installation/uninstallation.

Provides an interface for a deleted fields repository.

Interface for entity reference lists of field items.

Defines an interface for configurable field definitions.

Defines an interface for entity field definitions.

Defines an interface for reacting to field creation, deletion, and updates.

Interface for entity field items.

Interface for fields, being lists of field items.

Defines an interface for entity field storage definitions.

Defines an interface for reacting to field storage definition creation, deletion, and updates.

Defines an interface for the field type plugin manager.

Interface definition for field formatter plugins.

Interface definition for plugin with settings.

Defines an interface for exposing "preconfigured" field definitions.

Defines an interface for required field storage definitions.

Interface for field item data definitions.

Base interface definition for "Field widget" plugins.

Interface definition for field widget plugins.

Defines an interface to chmod files.

Provides an interface for helpers that operate on files and stream wrappers.

Generates file URLs for a stream to an external or local file.

Interface for managing Apache .htaccess files.

Defines an interface for flood controllers.

Provides an interface for a Form that has a base form ID.

Defines the behavior a confirmation form.

Provides an interface for building AJAX form responses.

Provides an interface for form building and processing.

Provides an interface for the caching of a form and its form state.

Provides an interface for handling form errors.

Provides an interface for a Form.

Provides an interface for an object containing the current state of a form.

Provides an interface for processing form submissions.

Provides an interface for validating form submissions.

Stores information about the state of a subform.

Defines a single link relation type.

Defines an interface for image toolkits.

Defines an interface for image toolkit operations.

Defines an interface for image toolkit operation managers.

Provides an interface for image objects.

Defines the expirable key/value store factory interface.

Defines the key/value store factory interface.

Defines the interface for expiring data in a key/value store.

Defines the interface for key/value store implementations.

Defines an interface for languages.

Common interface for the language manager service.

Provides an interface for building layout icons.

Provides an interface for static Layout plugins.

Provides the interface for a plugin manager of layouts.

Defines a common interface for country managers.

Lock backend interface.

Defines an interface for parsing log messages and their placeholders.

Logger channel factory interface.

Logger channel interface.

Defines an interface for pluggable mail back-ends.

Provides an interface for sending mail.

Defines a contextual link plugin.

Provides an object which returns the available contextual links.

Defines an interface for edit forms of menu links.

Defines an interface for menu local actions.

Manages discovery and instantiation of menu local action plugins.

Defines an interface for menu local tasks.

Manages discovery and instantiation of menu local task plugins.

Defines an interface for the active menu trail service.

Defines an interface for classes providing a type of menu link.

Defines an interface for managing menu links and storing their definitions.

Defines an interface for loading, transforming and rendering menu link trees.

Defines an interface for menu selector form elements and menu link options.

Defines an interface for storing a menu tree containing menu link IDs.

Defines an interface for objects which overrides menu links defined in YAML.

Stores runtime messages sent out to individual users on the page.

Defines the interface for compound request policies.

Defines the interface for compound request policies.

Defines the interface for request policy implementations.

Defines the interface for response policy implementations.

This is a service for pager information.

Interface describing pager information contained within the request.

Interface for parameter converters.

Provides an interface for a parameter converter manager.

Interface for generating passwords.

Secure password hashing functions for user authentication.

Defines an interface for classes that process the inbound path.

Defines an interface for classes that process the outbound path.

Provides an interface for URL path matchers.

Provides an interface for url path validators.

Provides a way to clear static caches of all plugin managers.

Defines an interface for pulling plugin dependencies from the container.

An override of ContextAwarePluginInterface for documentation purposes.

Provides an interface for plugin managers that support context-aware plugins.

Interface to define definition objects in ContextInterface via TypedData.

Provides an interface for handling sets of contexts.

Context data and definitions for plugins supporting caching and return docs.

Defines an interface for providing plugin contexts.

Offers a global context repository.

Provides an interface for a plugin definition that has dependencies.

Provides additional plugin definitions based on an existing definition using service injection.

Provides an interface for plugin managers that allow filtering definitions.

Provides an interface for an object using a plugin collection.

Provides an interface for retrieving form objects for plugins.

Provides an interface for an embeddable plugin form.

Provides an interface for plugins which have forms.

Delayable queue interface.

If the Drupal 'queue' service implements this interface, the garbageCollection() method will be called during cron.

Interface for a queue.

Defines an interface for a QueueWorker plugin.

Provides an interface for a queue worker manager.

Reliable queue interface.

Defines an interface for responses that can expose #attached metadata.

Defines an interface for processing attachments of responses that have them.

Bare HTML page renderer.

Collects available render array element types.

Provides an interface for render element plugins.

Provides an interface for form element plugins.

Indicates all public methods are safe to use in render callbacks.

The interface for "main content" (@code _controller @endcode) renderers.

Defines an interface for turning a render array into a placeholder.

Provides an interface for defining a placeholder strategy service.

Allows an element to provide a fallback representation of itself for preview.

Defines an interface for caching rendered render arrays.

Defines an object which can be rendered by the Render API.

Defines an interface for turning a render array into a string.

Defines an interface for classes that process the outbound route.

Interface for a router class for Drupal with access check and upcasting.

An access check service determines access rules for particular routes.

Extends the router provider interface to provide caching support.

A route enhance service to determine route enhance rules.

A route filter service to filter down the collection of route instances.

Extends the symfony matcher dumper interface with an addRoutes method.

Extends the router provider interface to pre-load routes.

Provides an interface for redirect destinations.

Defines an interface for a resettable stack of route matches.

Rebuilds the route information and dumps it.

Provides an interface for classes representing the result of routing.

Provides constants used for retrieving matched routes.

Extends the router provider interface.

Defines an interface for a stack of route matches.

Defines an interface for generating a url from a route or system path.

Interface to declare trusted callbacks.

Defines an account interface which represents the current user.

Defines an interface for a service which has the current account stored.

Defines an interface for a service for safe account switching.

Defines the user permissions hash generator interface.

Defines an interface for session configuration generators.

Defines the session manager interface.

Provides an interface for session handlers where writing can be disabled.

Defines the interface for the maintenance mode service.

Defines the interface for the state system.

Defines a generic PHP stream wrapper interface.

Defines a Drupal stream wrapper extension.

Provides a StreamWrapper manager.

Interface for the translation.manager translation service.

Interface for objects capable of string translation.

Defines an interface for cleaning up test results and fixtures.

Defines an interface which contain theme initialization logic.

Provides a high level access to the active theme and methods to use it.

Defines an interface for classes which determine the active theme.

Interface for complex data definitions.

Interface for complex data; i.e. data containing named and typed properties.

Interface for data definitions.

Interface for typed data references.

Interface for typed data references.

Interface for data definitions of lists.

Interface for a list of typed data.

Interface for retrieving all possible and settable values.

Interface for primitive data.

Interface for translatable data.

Defines an interface for checking the status of an entity translation.

An interface for typed data objects that can be traversed.

Interface for binary data.

Interface for boolean data.

Interface for dates, optionally including a time.

Interface for durations.

Interface for floating-point numbers.

Interface for integer numbers.

Interface for strings.

Interface for URIs.

Interface for typed data objects.

Defines an interface for typed data manager.

Extends the contextual validator validate method by a new parameter.

Defines an interface for a class which can update a Drupal project.

Defines an interface for generating links from route names and parameters.

Provides a way to build external or non Drupal local domain URLs.

Defines an interface used in validation.

Provides an interface defining an aggregator feed entity.

Defines an interface for aggregator feed entity storage classes.

Provides an interface defining an aggregator item entity.

Defines an interface for aggregator item entity storage classes.

Provides an interface defining an aggregator items importer.

Defines an interface for aggregator fetcher implementations.

Defines an interface for aggregator parser implementations.

Defines an interface for aggregator processor implementations.

Provides an interface defining a BanIp manager.

Provides an interface defining a block entity.

Interface for AccessibleInterface objects that have an access dependency.

An interface to allow adding an access dependency.

Provides an interface defining a custom block entity.

Provides an interface defining a custom block type entity.

Provides an interface defining a book manager.

Defines a common interface for book outline storage classes.

Interface for Breakpoint plugins.

Defines an interface for breakpoint managers.

Defines an interface for CKEditor 4 to 5 upgrade plugins.

Defines an interface for configurable CKEditor 5 plugins.

Defines an interface for plugins that can support an elements subset.

Defines an interface for CKEditor5 plugins.

Provides the interface for a plugin manager of CKEditor 5 plugins.

Defines an interface for CKEditor plugins with buttons.

Defines an interface for configurable CKEditor plugins.

Defines an interface for contextually enabled CKEditor plugins.

Defines an interface for CKEditor plugins with associated CSS.

Defines an interface for (loading of) CKEditor plugins.

Provides an interface defining a comment entity.

Defines an interface for building comment links on a commented entity.

Comment manager contains common functions to manage comment fields.

Provides an interface for storing and retrieving comment statistics.

Defines an interface for comment entity storage classes.

Provides an interface defining a comment type entity.

Interface definition for Comment items.

Defines an interface for configuration mapper.

Provides a common interface for config mapper managers.

Defines an interface for configuration translation entity list builders.

Provides an interface for configuration translation form elements.

Provides an interface defining a contact form entity.

Provides an interface for assembly and dispatch of contact mail messages.

Provides an interface defining a contact message entity.

An interface for Content moderation state entity.

Defines operations that need to vary by entity type.

Interface for moderation_information service.

Interface for ContentModeration WorkflowType plugin.

Validates whether a certain state transition is allowed.

Interface providing support for content translation bundle settings.

Interface for providing content translation.

Provides an interface for common functionality for content translation.

Common interface for content translation metadata wrappers.

Provides field translation synchronization capabilities.

Interface definition for Datetime items.

Provides an interface defining a text editor entity.

Defines an interface for text editor XSS (Cross-site scripting) filters.

Defines an interface for configurable text editors.

Provides an interface defining a field entity.

Provides an interface defining a field storage entity.

Provides a common interface for entity displays that have layout.

Defines an interface for file access handlers that need to run on file formatters.

Defines getter and setter methods for file entity base fields.

Performs file system operations and updates database records accordingly.

Defines an interface for file entity storage classes.

File usage backend interface.

Defines getter methods for FileMediaFormatterBase.

Provides an interface for uploaded files.

Provides an interface defining a filter format entity.

Defines the interface for text processing filter plugins.

Handles CRUD operations to {forum_index} table.

Provides forum manager interface.

Defines an interface for a link manager with a configurable domain.

Interface implemented by link managers.

Provides an interface for a plugin for a section of the /admin/help page.

Defines an interface for help topic plugin classes.

Defines an interface for managing help topics and storing their definitions.

Provides an interface for a HelpSection plugin that also supports search.

Defines the interface for configurable image effects.

Defines the interface for image effects.

Provides an interface defining an image style entity.

Interface for storage controller for "image style" configuration entities.

An interface for identifying a related resource.

Interface for objects that can appear as top-level object data.

Provides a repository of all JSON:API resource types.

Defines the common interface for all version negotiators.

Defines the interface for a configuration factory language override object.

Provides an interface defining a language entity.

Common interface for language negotiation services.

Provides an interface defining language settings for content entities.

Interface for language negotiation classes.

Common interface for language negotiation services.

Interface for language switcher classes.

Defines an interface for an object that stores layout sections for defaults.

Provides an interface for entity displays that have layout.

Generates a sample entity.

Defines an interface for tracking inline block usage.

Provides methods for enabling and disabling Layout Builder.

Provides an interface for loading layouts from tempstore.

Defines an interface for an object that stores layout sections for overrides.

Allows section storage plugins to provide local tasks.

Defines the interface for an object that stores layout sections.

Defines an interface for Section Storage type plugins.

Provides the interface for a plugin manager of section storage types.

Provides an interface that allows an object to provide its own tempstore key.

Defines an interface for the link field item.

Defines the locale project storage interface.

An interface for a service providing plural formulae.

Defines the locale string interface.

Defines the locale string storage interface.

Provides an interface defining an entity for media items.

Defines an interface for a media source with entity constraints.

Defines an interface for a media source with source field constraints.

Defines the interface for media source plugins.

Provides an interface defining a media type entity.

Defines an interface for a collection of oEmbed provider information.

Defines an interface for an oEmbed resource fetcher service.

Defines the interface for the oEmbed URL resolver service.

Defines additional functionality for source plugins that use oEmbed.

Defines an interface for media library openers.

Defines an interface to get a media library opener from the container.

Defines an interface for custom menu links.

Defines an interface for menu_link_content entity storage classes.

Defines a common interface for classed annotations with multiple providers.

Defines an interface for migration auditors.

Defines an interface for destination and ID maps which track a highest ID.

Interface for plugins that react to pre- or post-import events.

Interface for plugins that react to pre- or post-rollback events.

Provides an interface for the migration lookup service.

Provides an interface for the migrate stub service.

Defines an interface for Migration Destination classes.

Defines an interface for migrate ID mappings.

An interface for migrate process plugins.

Defines an interface for migrate sources.

To implement by a destination plugin that should provide entity validation.

Interface for migrations.

Migration plugin manager interface.

An interface to check for a migrate plugin requirements.

Provides field discovery for Drupal 6 & 7 migrations.

Provides an interface for all field type plugins.

Interface for migrations with follow-up migrations.

Node specific entity access control methods.

Provides an interface for node access grant storage.

Provides an interface defining a node entity.

Defines an interface for node entity storage classes.

Provides an interface defining a node type entity.

Find an alias for a path and vice versa.

Provides an interface for path alias lookup operations.

Cache the alias whitelist.

Provides an interface defining a path_alias entity.

Access check for in-place editing entity fields.

Interface for selecting an in-place editor (an Editor plugin) for a field.

Interface for generating in-place editing metadata.

Defines an interface for in-place editors plugins.

Provides an interface defining an RDF mapping entity.

Provides an interface defining a responsive_image mapping entity.

Specifies the publicly available methods of a resource plugin.

Defines a common interface for resource responses.

Defines a configuration entity to store enabled REST resources.

Provides an interface for a configurable Search plugin.

Defines an optional interface for SearchPlugin objects using an index.

Defines a common interface for all SearchPlugin objects.

Provides search index management functions.

Provides an interface defining a search page entity.

Provides the interface for a repository Search Page entities.

Processes search text for indexing.

An interface for delegating an entity resolution to a chain of resolvers.

Interface for extracting UUID from entity reference data when denormalizing.

Defines the interface for normalizers producing cacheable normalizations.

Provides an interface defining a shortcut entity.

Provides an interface defining a shortcut set entity.

Defines an interface for shortcut_set entity storage classes.

Provides an interface defining Statistics Storage.

Provides an interface defining an action entity.

Provides an interface defining a menu entity.

Provides an interface defining a taxonomy term entity.

Defines an interface for taxonomy_term entity storage classes.

Provides an interface defining a taxonomy vocabulary entity.

Defines an interface for vocabulary entity storage classes.

Defines an interface for tour items.

Provides an interface defining a tour entity.

Defines an interface for tour items.

Fetches project information from remote locations.

Manages project update information.

Processor of project update information.

Defines a common interface for entities that have an owner.

Defines an interface to list available permissions.

Provides an interface defining a user role entity.

Defines an interface for role entity storage classes.

An interface for validating user authentication credentials.

Defines the user data service interface.

Defines an interface for user flood controllers.

Provides an interface defining a user entity.

Defines an interface for user entity storage classes.

Provides an interface to integrate an entity type with views.

Provides an interface for a plugin that has dependencies that can be removed.

Provides an interface for all views handlers.

Provides an interface for all views plugins.

Defines an interface for displays that provide menu links.

Provides an interface for Views display plugins.

Defines an interface for displays that can collect routes.

Defines a display which returns a Response object.

Interface for exposed filter form plugins.

Base field handler that has no options and renders an unformatted field.

Defines a field handler which renders multiple items per row.

Represents a join and creates the SQL necessary to implement the join.

Defines an interface for handling date queries with SQL.

Defines a common interface for Views Wizard plugins.

Defines an interface for View storage classes.

An interface for state value objects.

A transition value object that describes the transition between two states.

Provides an interface for defining workflow entities.

An interface for Workflow type plugins.

Defines interface for workspace forms so they can be easily distinguished.

Workspace negotiators provide a way to get the active workspace.

Defines an interface for the workspace_association service.

Defines an interface for the workspace entity type.

Provides an interface for managing Workspaces.

Defines an interface for the workspace merger.

Defines an interface for workspace operations.

Defines an interface for the workspace publisher.

Provides an interface for workspace tree lookup operations.