How do I reload a relation collection in laravel?

Question

In Laravel, after using attach() or detach() to add or remove something from a relation, the collection has not changed. So if I have a model whose relation contains [1, 2], after this:

$model->relation()->detach(1);
$model->relation()->attach(3);

it will still contain [1, 2]! How do I refresh it?

score 144 · Answer 1 · edited May 11 '20 at 00:14

144

You can easily tell laravel to load a relation with a single command:

$model->load('relation');

Will tell it to refresh the relation collection, and $model->relation will now show the correct values.

Also unloading a relation will be like this:

$model->unsetRelation('relation')

edited May 11 '20 at 00:14

Amin Shojaei

5,451
2
38
46

answered Apr 29 '14 at 12:09

Benubird

18,551
27
90
141

4

This is also handy for reloading a model after doing a `$model->relation()->save($relation)` situation. – Silver Paladin Oct 29 '14 at 15:05
6

You can also do `unset($model->relation)` – Benubird Feb 12 '15 at 09:55
@SilverPaladin Might be better to save it like this: http://laravel.com/docs/5.0/eloquent#inserting-related-models – haakym May 12 '15 at 14:34

score 8 · Answer 2 · answered Jan 07 '21 at 17:39

8

From Laravel 7.x you can use $model->refresh() for refreshing the model and it's relations.

Here the docs

answered Jan 07 '21 at 17:39

Giuse Petroso

557
6
7

Correct. This is now the simplest way. – Legionar Jul 27 '22 at 09:27

Yevgeniy Afanasyev · Answer 3 · 2020-01-15T06:55:13.253

7

either just unset it and let the system reload on demand.

unset($model->relation)

or

$model->unsetRelation('relation');

And let it be loaded on request.

edited Jan 15 '20 at 06:55

answered Aug 13 '19 at 01:07

Yevgeniy Afanasyev

37,872
26
173
191

score 5 · Answer 4 · edited Aug 13 '19 at 01:06

5

Conclusion: three solutions in here

$model->load('relation');

unset($model->relation);

$freshCollection = $user->roles()->get();`

edited Aug 13 '19 at 01:06

Yevgeniy Afanasyev

37,872
26
173
191

answered Mar 30 '18 at 09:51

kevinYang

111
2
1

score 4 · Answer 5 · answered Apr 03 '16 at 11:04

4

It is possible to use Eloquent query builder:

$freshCollection = $user->roles()->get();

answered Apr 03 '16 at 11:04

James Akwuh

2,169
1
23
25

score 3 · Answer 6 · edited Oct 23 '18 at 05:32

3

If you want to force all your relations to reload on an as-needed basis and you're inside your model, you can use:

$this->relations = [];

edited Oct 23 '18 at 05:32

Yevgeniy Afanasyev

37,872
26
173
191

answered Apr 14 '15 at 19:24

Sabrina Leggett

9,079
7
47
50

this is not intuitive, does it mean that every time when my relation has no items it makes a DB request? – Yevgeniy Afanasyev Aug 13 '19 at 01:09
1

yes, when you do `$user->posts` it checks the `relations` property to see if the related collection has already been retrieved. If not it'll load it from the database. – Sabrina Leggett Aug 14 '19 at 02:58

score 1 · Answer 7 · answered Aug 11 '21 at 06:30

1

$model->fresh() did the job for me. Wanted to replicate multiple levels of nested models then do a loop over them. Laravel was caching the previous relation and not the new "current" relation.

answered Aug 11 '21 at 06:30

Liam Mitchell

1,001
13
23

How do I reload a relation collection in laravel?

7 Answers7