Skip to main content
drupalreleases

Use direct release data with your AI assistant.

Learn more

Machine Name Widget

Security covered Under active development 235 sites

This module provides a form widget for creating machine-readable names for content entities. It allows for automatic generation of machine names based on a source field and ensures uniqueness.

Widget for a Machine Name form element.

Machine Name Widget provides a field for the machine_name render element. This module does not provide a UI for configuring the widget, but rather is intended to be used by other modules (i.e. content entities).

New Projects: read me first!

You should probably be using the core patch, located here: #2685749: Add a 'machine_name' widget for string field types with a UniqueField constraint. When this lands, this module will be obsolete. You can get ahead of the migration issues by just using the patch now.

Setup

The widget accepts the same configuration as machine_name. Simply use the type machine_name and pass the same config into settings.

Example

Here's an example from Colossal Menu:

$fields['machine_name'] = BaseFieldDefinition::create('string')
  ->setLabel(t('Machine name'))
  ->setDescription(t('Machine name of the menu link'))
  ->setRequired(TRUE)
  ->setSetting('max_length', 255)
  ->addConstraint('UniqueField', [])
  ->setDisplayOptions('form', [
    'type' => 'machine_name',
    'weight' => -4,
    'settings' => [
      'source' => [
        'title',
        'widget',
        0,
        'value',
      ],
      'exists' => '\Drupal\colossal_menu\Entity\Link::loadByMachineName',
    ],
  ]);
Drupal 10 · not 11

Ask your assistant about Machine Name Widget

Check compatibility with your Drupal and PHP version, maintenance and security coverage, from current release data. How it works

Depends on

Dependencies of the latest stable release

No dependencies recorded for this project.

Required by

Tracked projects that depend on this one

No tracked projects depend on this one yet.

Activity

Tracked releases
7
Tracked since
Sep 2023
Latest release
2 years ago
Releases (12 mo)
0
Maintenance
Dormant

Release Timeline

Releases

Version Type Core PHP Release date
3.1.1 Stable 10 Jul 18, 2024
3.1.0 Stable 10 Jul 18, 2024
3.0.1 Stable 10 Nov 28, 2023
8.x-2.0-alpha5 Pre-release 9 Nov 28, 2023
8.x-2.0-alpha4 Pre-release 8–10 Nov 28, 2023
8.x-2.0-alpha3 Pre-release 8–10 Sep 18, 2023
3.0.x-dev Dev 10 Sep 18, 2023