URL

Version: 3.4
Edit this page

Warning: You are browsing the documentation for Symfony 3.4, which is no longer maintained.

Read the updated version of this page for Symfony 6.0 (the current stable version).

URL

Validates that a value is a valid URL string.

Applies to property or method
Options
Class Url
Validator UrlValidator

Basic Usage

  • Annotations
  • YAML
  • XML
  • PHP 
1
2
3
4
5
6
7
8
9
10
11
12
// src/AppBundle/Entity/Author.php
namespace AppBundle\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Author
{
    /**
     * @Assert\Url
     */
    protected $bioUrl;
}

Note

As with most of the other constraints, null and empty strings are considered valid values. This is to allow them to be optional values. If the value is mandatory, a common solution is to combine this constraint with NotBlank.

Options

groups

type: array | string

It defines the validation group or groups this constraint belongs to. Read more about validation groups.

message

type: string default: This value is not a valid URL.

This message is shown if the URL is invalid.

You can use the following parameters in this message:

Parameter Description
{{ value }} The current (invalid) value
  • Annotations
  • YAML
  • XML
  • PHP 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
// src/AppBundle/Entity/Author.php
namespace AppBundle\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Author
{
    /**
     * @Assert\Url(
     *    message = "The url '{{ value }}' is not a valid url",
     * )
     */
    protected $bioUrl;
}

protocols

type: array default: ['http', 'https']

The protocols considered to be valid for the URL. For example, if you also consider the ftp:// type URLs to be valid, redefine the protocols array, listing http, https, and also ftp.

  • Annotations
  • YAML
  • XML
  • PHP 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
// src/AppBundle/Entity/Author.php
namespace AppBundle\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Author
{
    /**
     * @Assert\Url(
     *    protocols = {"http", "https", "ftp"}
     * )
     */
    protected $bioUrl;
}

payload

type: mixed default: null

This option can be used to attach arbitrary domain-specific data to a constraint. The configured payload is not used by the Validator component, but its processing is completely up to you.

For example, you may want to use several error levels to present failed constraints differently in the front-end depending on the severity of the error.

checkDNS

type: boolean default: false

By default, this constraint just validates the syntax of the given URL. If you also need to check whether the associated host exists, set the checkDNS option to the value of any of the CHECK_DNS_TYPE_* constants in the Url class:

  • Annotations
  • YAML
  • XML
  • PHP 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
// src/AppBundle/Entity/Author.php
namespace AppBundle\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Author
{
    /**
     * @Assert\Url(
     *    checkDNS = "ANY"
     * )
     */
    protected $bioUrl;
}

This option uses the checkdnsrr PHP function to check the validity of the DNS record corresponding to the host associated with the given URL.

dnsMessage

type: string default: The host could not be resolved.

This message is shown when the checkDNS option is set to true and the DNS check failed.

  • Annotations
  • YAML
  • XML
  • PHP 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
// src/AppBundle/Entity/Author.php
namespace AppBundle\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Author
{
    /**
     * @Assert\Url(
     *    dnsMessage = "The host '{{ value }}' could not be resolved."
     * )
     */
    protected $bioUrl;
}
This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.