Feature Request: add a Custom linktype to the Link field

[maxfenton]

Following the instructions on the Craft 5 Link field docs, I added a custom Link Type with EVENT_REGISTER_LINK_TYPES and it's working, but I kindof want to explain what I needed and nerdsnipe Pixel & Tonic into adding it.

Why: we're migrating a lot of fields on a lot of sites from Typed Link Field to Craft's Link field and both Typed Link Field and Hyper have a Custom type that does not validate that the URL begins with http(s):// nor does it add a pattern or prefix (e.g. tel:) — and we need this for sms: links. To match those plugins (and ease our migration from one of them):

Please consider adding a linktype Custom that has no urlPrefix, no pattern, and inputAttributes of type text and inputmode url

---

For additional reference, see this conversation about migration from Typed Link Field to Craft Link field which includes community migration scripts that (necessarily) omit Custom links:
sebastian-lenz/craft-linkfield#286

---

What I've done in my custom module:

modules/customlinktype/CustomLinkType.php

private function attachEventHandlers(): void
    {
        Event::on(Link::class, Link::EVENT_REGISTER_LINK_TYPES, function (RegisterComponentTypesEvent $event) {
            $event->types[] = 'modules\\customlinktype\\linktypes\\Custom';
        });
    }

modules/customlinktype/linktypes/Custom.php

<?php

namespace modules\customlinktype\linktypes;

use Craft;
use craft\fields\Link;
use craft\fields\linktypes\BaseTextLinkType;

/**
 * Custom text link type.
 */
class Custom extends BaseTextLinkType
{
    public static function id(): string
    {
        return 'custom';
    }

    public static function displayName(): string
    {
        return Craft::t('app', 'Custom');
    }

    protected function urlPrefix(): string|array
    {
        return '';
    }

    protected function inputAttributes(): array
    {
        return [
            'type' => 'text',
            'inputmode' => 'url',
        ];
    }

    protected function pattern(): string
    {
        return '';
    }
}

[brandonkelly]

For the sms: case, we could just add a “SMS” link type, which makes as much sense to have as “Phone” I think.

We could also loosen up “URL” validation, to allow for arbitrary URL schemes.

[Tim-Wils]

Nice, loosening up the URL validation seems to be the most complete solution :)

[maxfenton]

A more loose URL that could handle sms: would work for my use cases

Here's a real world URL example: sms:741741&body=HOME

Just did two Typed Link -> Craft Link migrations today on sites that don't have any sms: links and realized there's also no Site linktype for a Link to the baseUrl of another Site, but was able to kludge those with URL links to / and /es

[brandonkelly]

Added both a new “SMS” link type and an “Allow custom URL schemes” setting, for 5.7 (51d1808).

[maxfenton]

Thank you so much

[brandonkelly]

Craft 5.7.0 is out with that change.

[maxfenton]

I think something has reverted and now a Craft Link Field link with the type URL and the value sms:988 is output as https://tel:988

[maxfenton]

The CraftCMS "Link" field that dumps as \LinkData (as opposed to LinkIt or Typed Link from plugins)

[maxfenton]

HTML Purifier still strips sms links, so I end up needing to make Link fields (or not purify a text field) for cases that need to have sms: in href

ezyang/htmlpurifier#374

---

I haven't figured out what changed with Link, but I had a linkToUrl Link field that could use URL, Phone, or SMS types. And then sometime after you added the setting to not enforce the scheme on URL type, I simplified and removed Phone and SMS types as available options on the field (so it was only URL type but not supposed to care about the scheme)

And maybe it started enforcing https:// again after that despite the setting that it shouldn't. Entries that hadn't been resaved still had tel: but after saving they became https://tel:

I can try to do better testing later this week by:

• make a Link field that can have URL and Phone and not validate the scheme
• make URL content with a tel: scheme
• remove Phone as an available type
• see what happens

[maxfenton]

This was the only clue about where something might be happening. Sorry if it’s a goose chase:

[brandonkelly]

I’m seeing slightly different behavior on my end, but I was able to reproduce that “Call to a member function isValueEmpty() on null” error, and got that fixed in Craft 5.8.18. (7f649e6)

[maxfenton]

It felt like an edge case of an edge case, but the isValueEmpty() exception seemed worth chasing down. Thanks so much!