ContentTypes / Relationships

You can define relationships between records by adding a relation to contenttypes.yaml.

pages:
    name: Pages
    singular_name: Page
    [..]

entries:
    name: Entries
    singular_name: Entry
    fields:
        [..]
    relations:
        pages:
            multiple: false
            required: false
            label: Select a related page
            order: -id
    [..]

The relations are defined by the slug of the ContentType that it's related to. If a slug is not explicitly defined for a ContentType, the name is used. In the example above, it is pages. It takes a few parameters:

Editing a record that has relations defined looks like this:

If you see this, you might consider adding the reverse relation to the contenttypes.yaml as well.

Relations in templates¶

To get the related records in twig, use the filter related.

    {% set relatedrecords = record|related %}
    {% if relatedrecords is not empty %}
        <p>Related content:</p>
        <ul>
        {% for related in relatedrecords %}
            <li><a href="{{ related|link }}">{{ related.title }}</a></li>
        {%  endfor %}
        </ul>
    {% endif %}

Relations and directions¶

Relationships have a direction; they point from a content record to another. This directionality comes into play when fetching related records.

For example, you may have a contenttype entries that has a relation to entries itself; this allows you to show hand-selected "related posts".

When you edit record A, and select record B as a relation in the Relations tab, the relation will be from A to B.

The directionality in relations allows you to either select all records with a relation to the current record, in any direction, or you can specify that you only want one of the directions.

Let's take this example:

entries:
    name: Entries
    singular_name: Entry
    fields:
        [..]
    relations:
        entries:
            multiple: true
            required: false
            label: Select one or more related entries
            order: -id
    [..]

Then, after adding some content and making relations between the entries, we can display them in the templates using the related() method. If you'd use the previous example of Twig code, you'd get all related records for the current record, regardless of contenttype or direction.

Using the second parameter of the related() method, you can specify which relations you want to see. For instance, to only display relations to other records of the entries contenttype, that the current record is the "from" end for, you'd do this:

    {% set relatedrecords = record|related("entries", "from") %}
    {% if relatedrecords is not empty %}
        <p>Related content:</p>
        <ul>
        {% for related in relatedrecords %}
            <li><a href="{{ related|link }}">{{ related.title }}</a></li>
        {%  endfor %}
        </ul>
    {% endif %}