How to save Urlrelations in Craft 5?

[roland-d]

Hi, I am kinda going down a rabbit hole in Craft 5 doing an upgrade. In Craft 3 I had this code working just fine:

foreach ($urls as $url) {
    $urlRelations['new' . $key] = [
        'type' => 'urlRelations',
        'enabled' => true,
        'fields' => [
            'href' => $url,
            'alias' => $relationType,
        ]
    ];
    $key++;
}

Now in Craft 5 none of the relations are stored. After some digging around I came to this layout but that is not working either but perhaps it is closer to the truth:

foreach ($urls as $url) {
    $urlRelations['entries']['new' . $key] = [
        'type' => 'urlRelations',
        'enabled' => true,
        'fields' => [
            'href' => [
                    'type' => 'url',
                    'value' => $url
                ],
            'alias' => $relationType,
        ]
    ];
    $key++;
}

Basically what I am trying to do is store an Entry programmatically. This entry contains URL relations. Once I constructed the urlRelations I set them as field values like this:

$entry->setFieldValues([
    'musicUrlRelations' => $urlRelations
]);

After that I save the Entry. Upon saving I get no errors or anything just that the entry saved successfully but my URL relations are not there. Is there an easy fix to this?

Some more digging seems to tell me that I need the UIDs for each field in the $urlRelations array, is that correct?

Thanks.

[AugustMiller]

I don't think the requirement is new in Craft 5, but one thing missing from this is the sortOrder array:

$urlRelations = [
    'entries' => [],
    'sortOrder' => [],
];

foreach ($urls as $i => $url) {
    $key = "new-$i";

    // Push data into `entries`:
    $urlRelations['entries'][$key] = [
        'type' => 'urlRelations',
        'enabled' => true,
        'fields' => [
            'href' => [
                'type' => 'url',
                'value' => $url,
            ],
            'alias' => $relationType,
        ],
    ];

    // Add to the `sortOrder` array:
    $urlRelations['sortOrder'][] = $key;
}

See the Matrix field documentation for more info!

[roland-d]

Hi @AugustMiller,

Thank you for your reply. That put me in the right direction of ending up to make it work 🥳

There were 3 things I had to change:

1. The sortOrder is required now otherwise it will not save the changes
2. the type value has changed during the migration, not something I noticed. The new name is now urlRelations2 instead of urlRelations. One of those things that can take hours to spot 😅
3. The new placeholder should be changed to new:. Notice the colon at the end.

My final code is:

foreach ($urls as $url) {
    $urlRelations['entries']['new:' . $key] = [
        'type' => 'urlRelations2',
        'enabled' => true,
        'fields' => [
            'href' => [
                    'type' => 'url',
                    'url' => [
                        ''value' => $url
                    ]
                ],
                'alias' => $relationType,
        ]
    ];
    $urlRelations['sortOrder'][] = 'new:' . $key;
    $key++;
}

Finally, thank you for the documentation link. I had read a lot of it but did not come across that one, perhaps also not searching for the right phrases.

You made my day very happy. Thank you.