BelongsTo Default Models: No Need to Check in Blade Files

I’ve recently found out about a feature in Laravel relationship which changed the way I write code. So sharing with you.

Let’s say we have a relationship in Post model:

public function author()
{
    return $this->belongsTo('App\Author');
}

And then somewhere in Blade file we have this:

{{ $post->author->name }}

Now, what if some post doesn’t have author? Meaning posts.author_id is NULL. You will get an error “Trying to get property of non-object”, meaning that there’s no $post->author, which is correct.

How I handle it usually:

{{ $post->author->name or 'No author' }}

Or you can perform a check for existence:

@if ($post->author)
  {{ $post->author->name }}
@else
  Do something else
@endif

What if I told you there’s a better way?

Apparently, Eloquent relationships allow to define “default” models, in case the model wouldn’t return anything.

public function author()
{
    return $this->belongsTo('App\Author')->withDefault();
}

In this example, the author() relation will return an empty App\Author model if no author is attached to the post.

Furthermore, we can assign default property values to that default model.

public function author()
{
    return $this->belongsTo('App\Author')->withDefault([
        'name' => 'Guest Author',
    ]);
}

By using this structure, you don’t need to check anything in Blade anymore – just have the same

{{ $post->author->name }}

where needed.

Source: official Laravel documentation (look for section Default Models)

Like our articles?
Check out our Laravel online courses!

9 COMMENTS

  1. {{ $post->user ? $post->user->name : $post->name }}

    instead:
    App\Board:
    return $this->belongsTo(‘App\User’)->withDefault([‘name’=>$this->name]);

  2. Really nice tip, but this applies only to belongsTo relationships, right? I normally don’t need checks for these; I’d love to be to skip checks for other relationships, such as belongsToMany.

LEAVE A REPLY

Please enter your comment!
Please enter your name here