01-link-resolving.md

Link Resolver

When working with fields type such as Link or Structured Text, the prismic.io kit will need to generate links to documents within your website.

Define your internal routes

Since routing is specific to your site, you will need to define it and provide it to some of the methods used on the fields.

A Link Resolver is provided in every starter kit, but you may need to adapt it or write your own if you're using a different framework.

An example

Here is an example of a Link Resolver for a Laravel blog site.

@php
    use Prismic\LinkResolver;
    use Prismic\Dom\RichText;
    use Prismic\Dom\Link;

    class ExampleLinkResolver extends LinkResolver
    {
        public function resolve($link) :? string
        {
            if (property_exists($link, 'isBroken') && $link->isBroken === true) {
                return '/404';
            }
            if ($link->type === 'category') {
                return '/category/' . $link->uid;
            }
            if ($link->type === 'post') {
                return '/post/' . $link->uid;
            }
            return '/';
        }
    }

    $linkResolver = new ExampleLinkResolver();
@endphp

<div class="blog-post-content">
    {!! RichText::asHtml($document->data->blog_post, $linkResolver) !!}
</div>

<a href="{{ Link::asUrl($document->data->link, $linkResolver) }}">Click here</a>

Accessible attributes

When creating your Link Resolver function when using the API v2, you will have access to certain attributes of the linked document:

Property	Description
$link->id string	The document id
$link->uid string	The user-friendly unique id
$link->type string	The custom type of the document
$link->tags array	Array of the document tags
$link->lang string	The language code of the document
$link->isBroken boolean	Boolean that states if the link is broken or not