Custom Field
This module provides a flexible and performant way to create custom fields with various widget and formatter options, storing data efficiently in a single table. It aims to be a scalable alternative to other field types, reducing overhead and potentially replacing the need for additional modules.
Dynamic custom field types with extensive widget and formatter plugin support. A highly performant & scalable alternative to paragraphs and entity reference by storing data in a single table.
Community support
Have a support question or new feature you want to discuss? Join the Drupal #custom-field slack channel.
Features
- Multiple-value fields without entity references
- Inline field widgets using a customizable css-flexbox-based layout system
- Multiple field formatters: Default (custom theme hook), Inline, HTML List, Table, Flipped Table, Single Directory Component, Custom Template (similar to views' field rewrite functionality)
- Clone field settings from ANY entity type
- Add/Remove columns to fields with existing data. See documentation
- Performance & scalability - Eliminates unnecessary field table bloat and configuration files
- Reduce overhead - May replace the need for additional contrib modules
Integrations
- AI (Artificial Intelligence)
- Default Content - (Patch required)
- Entity Browser
- Entity Usage
- Feeds
- Field Updater Service
- GraphQL Compose
- Linkit
- Search API
- Simple Add More
- Token Browser
Migrate to Custom fields
You can use the Field Updater Service module to map 1 or more fields in a configuration entity and use the provided service in an update hook from your custom module.
Included sub-modules
Module Description custom_field_ai AI (Artificial Intelligence) integration custom_field_entity_browser Entity Browser integration custom_field_graphql GraphQL compose integration custom_field_jsonapi JSON:API integration custom_field_linkit Linkit integration custom_field_media Provides a Media Library widget custom_field_sdc Use Single Directory Components in manage display. custom_field_search_api Enhances Search API integration custom_field_viewfield Provides the ability to reference and display viewsWhy this module?
In most cases, creating multiple single value field api fields in an entity form is overkill for storing simple field data that would be better to consolidate in a single table. One Custom Field can contain many columns in a single table which can lead to a substantial boost in performance by eliminating unnecessary joins and allowing for simpler configuration management.
Depends on
Dependencies of the latest stable release
- field Drupal core
- file Drupal core
- filter Drupal core
- image Drupal core
- link Drupal core
Required by
Tracked projects that depend on this one
No tracked projects depend on this one yet.
Activity
Release Timeline
Releases
| Version | Type | Core | Notes | Release date | |
|---|---|---|---|---|---|
| 5.0.2 | Stable | 11 | Expand test coverage, bug fixes and new features | Aug 17, 2026 | |
| 4.0.11 | Stable | 10 | Expand test coverage, bug fixes and new features | Aug 17, 2026 | |
| 4.0.10 | Stable | 10 | Fix regression in sub-modules version requirement | Jul 28, 2026 | |
| 5.0.1 | Stable | 11 | Replace deprecated function in views | Jul 26, 2026 | |
| 4.0.9 | Stable | 10 | Set core version max to 11.3 + documentation | Jul 23, 2026 | |
| 5.0.0 | Stable | 11 | Drupal core ^11.4 || ^12 support + new documentation | Jul 23, 2026 | |
| 5.0.x-dev | Dev | 11 | Drupal ^11.4 support. | Jul 22, 2026 | |
| 4.0.8 | Stable | 10–11 | Single directory component enhancements, code optimizations | May 23, 2026 | |
| 4.0.7 | Stable | 10–11 | Apr 25, 2026 | ||
| 4.0.6 | Stable | 10–11 | Introduces custom_field_sdc sub-module, several features + bugfixes | Mar 11, 2026 | |
| 4.0.5 | Stable | 10–11 | SDC display formatter + views enhancements | Feb 24, 2026 | |
| 4.0.4 | Stable | 10–11 | Bug fixes. | Dec 27, 2025 | |
| 4.0.3 | Stable | 10–11 | Fixes regression in link widget values for field settings | Dec 9, 2025 | |
| 4.0.2 | Stable | 10–11 | Bugfixes | Dec 8, 2025 | |
| 4.0.1 | Stable | 10–11 | UX enhancements, bugfixes | Nov 17, 2025 | |
| 4.0.0 | Stable | 10–11 | New field types and extended AI module integration. | Oct 27, 2025 | |
| 4.0.0-rc2 | Pre-release | 10–11 | Fix update hook for base fields | Aug 31, 2025 | |
| 4.0.0-rc1 | Pre-release | 10–11 | Initial 4.x release candidate. | Aug 29, 2025 | |
| 3.1.16 | Stable | 10 | Remove D11 support in lieu of 4.x. | Aug 29, 2025 | |
| 3.1.15 | Stable | 10–11 | Remove D11 support in lieu of 4.x version. | Aug 29, 2025 | |
| 3.1.14 | Stable | 10–11 | Aug 6, 2025 | ||
| 3.1.13 | Stable | 10–11 | Jul 24, 2025 | ||
| 4.0.x-dev | Dev | 10 | Jul 14, 2025 | ||
| 3.1.12 | Stable | 10–11 | Bugfixes & new features | Jul 10, 2025 | |
| 3.1.11 | Stable | 10–11 | Bugfixes + New features | Jun 16, 2025 | |
| 3.1.10 | Stable | 10–11 | Fix image formatter | May 27, 2025 | |
| 3.1.9 | Stable | 10–11 | Minor fix to unblock update hook from 3.1.8 for some fields. | May 25, 2025 | |
| 3.1.8 | Stable | 10–11 | Code optimization, Bugfixes and New Features | May 20, 2025 | |
| 3.1.7 | Stable | 10–11 | Bugfixes and Entity Usage integration. | Apr 14, 2025 | |
| 3.1.6 | Stable | 10–11 | Bugfixes, features & UX enhancements. | Mar 31, 2025 | |
| 3.1.5 | Stable | 10–11 | Formatter fixes/enhancements | Mar 24, 2025 | |
| 3.1.4 | Stable | 10–11 | Bugfixes | Mar 5, 2025 | |
| 3.1.3 | Stable | 10–11 | Token replacement in viewfield | Feb 27, 2025 | |
| 3.1.2 | Stable | 10–11 | Fixes and features | Feb 26, 2025 | |
| 3.1.1 | Stable | 10–11 | Minor bugfixes. | Jan 25, 2025 | |
| 3.1.x-dev | Dev | 10 | Jan 8, 2025 | ||
| 3.1.0 | Stable | 10–11 | Theming enhancements + multi-lingual fixes. | Jan 8, 2025 | |
| 3.0.3 | Stable | 10–11 | Regression fix + translation support per subfield | Dec 30, 2024 | |
| 3.0.2 | Stable | 10–11 | Hierarchical select widget and custom viewfield sub-module. | Dec 29, 2024 | |
| 3.0.1 | Stable | 10–11 | Regression with custom_field.tokens.inc | Dec 9, 2024 | |
| 3.0.0 | Stable | 10–11 | Stable release | Dec 9, 2024 | |
| 3.0.0-rc12 | Pre-release | 10–11 | tokens.inc error fix | Dec 3, 2024 | |
| 3.0.0-rc11 | Pre-release | 10–11 | New Term hierarchy formatter, Token module support in custom templates | Dec 2, 2024 | |
| 3.0.0-rc10 | Pre-release | 10–11 | Enhance map widget support. | Nov 12, 2024 | |
| 3.0.0-rc9 | Pre-release | 10–11 | Bugfixes media library and paragraphs compatibility | Oct 11, 2024 |