CKEditor 5 Phone Link

CKEditor 5 Phone Link adds a Phone link button to CKEditor 5 to insert links to phone numbers that work on every phone, from any country.

Editors often add phone links by hand, such as tel:201-555-0123. Without the country code, these links fail on phones outside the country, and nothing checks that the number is valid. This module ensures every phone link points to a valid number in international E.164 format, such as tel:+12015550123, while the text shown to visitors keeps the format you choose.

Features

• A balloon form, like the Link one, with a country and a phone number. Numbers can be typed in national or international format and are checked as you type.
• The link always points to the E.164 number. The inserted text can be international (+1 201 555 0123), national ((201) 555-0123), national with dashes (201-555-0123) or dots (201.555.0123), or as typed.
• Existing phone links without a country code are read as numbers of the default country, and fixed when edited.
• The links are regular links made with the core Link plugin, so the link balloon edits and removes them as usual.
• Validation on save: content with an invalid phone link cannot be saved, including links added in Source mode or through REST, JSON:API and migrations. Each text format can show a warning instead.
• Accessible balloon form: labelled fields, announced errors and full keyboard support.

Requirements

• Drupal 11.1 or later, with CKEditor 5 and the Link button in the text format.
• libphonenumber-for-php, installed by Composer.

Installation

composer require drupal/ckeditor5_phone_link

Configuration

Edit a text format that uses CKEditor 5, drag the Phone link button to the toolbar, and choose the default country, the display format, and the validation severity under CKEditor 5 plugin settings → Phone link.

Similar projects

• Telephone Validation and Phone Number validate telephone fields; this module works on phone links inside formatted text.
• Editor Email Link adds a phone field to the link dialog, without validation or formatting, and without CKEditor 5 support.