Slug

.. versionadded:: 7.3

The ``Slug`` constraint was introduced in Symfony 7.3.

Validates that a value is a slug.

A slug is a string that, by default, matches the regex ``/^[a-z0-9]+(?:-[a-z0-9]+)*$/``.

.. include:: /reference/constraints/_empty-values-are-valid.rst.inc

Applies to :ref:`property or method <validation-property-target>`

Class :class:`Symfony\\Component\\Validator\\Constraints\\Slug`

Validator :class:`Symfony\\Component\\Validator\\Constraints\\SlugValidator`

Basic Usage

The ``Slug`` constraint can be applied to a property or a "getter" method:

.. configuration-block::

.. code-block:: php-attributes

.. code-block:: yaml

.. code-block:: xml

.. code-block:: php

Examples of valid values :

* foobar

* foo-bar

* foo123

* foo-123bar

Upper case characters would result in an violation of this constraint.

Options

``regex``

**type**: ``string`` default: ``/^[a-z0-9]+(?:-[a-z0-9]+)*$/``

This option allows you to modify the regular expression pattern that the input will be matched against

via the :phpfunction:`preg_match` PHP function.

If you need to use it, you might also want to take a look at the :doc:`Regex constraint <Regex>`.

``message``

**type**: ``string`` **default**: ``This value is not a valid slug``

This is the message that will be shown if this validator fails.

You can use the following parameters in this message:

Parameter Description

``{{ value }}`` The current (invalid) value

.. include:: /reference/constraints/_groups-option.rst.inc

.. include:: /reference/constraints/_payload-option.rst.inc

* :doc:`Slug </reference/constraints/Slug>`