Laravel conditional belongsToMany relationship

Question

I have a method tenants() inside the User model, now inside this method it returns like this below which is working fine,

return $this->belongsToMany(
     Municipality::class,
     'municipality_user',
     'user_id',
     'municipality_id'
);

but I want to get all the municipality when the user is a super admin user.

$user->isSuperAdmin()

I tried with this,


if ($this->isSuperAdmin()) {
    return Municipality::all();
}

return $this->belongsToMany(
    Municipality::class,
    'municipality_user',
    'user_id',
    'municipality_id'
);

but it return this error: App\Models\User::tenants must return a relationship instance.

Should I build a custom belongsToMany class or how can I achieve that?

Nicolas · Accepted Answer · 2025-03-16 10:27:56Z

1

public function tenants(): BelongsToMany
{
    $relation = $this->belongsToMany(
        Municipality::class,
        'municipality_user',
        'user_id',
        'municipality_id'
    );

    if ($this->isSuperAdmin()) {
        // For super admins, return a new query for all municipalities
        return Municipality::query();
    }

    return $relation;
}

answered Mar 16 at 10:27

Nicolas

461 bronze badge

Sign up to request clarification or add additional context in comments.

1 Comment

Community Mar 16 at 15:28

Your answer could be improved with additional supporting information. Please edit to add further details, such as citations or documentation, so that others can confirm that your answer is correct. You can find more information on how to write good answers in the help center.

Collectives™ on Stack Overflow

Laravel conditional belongsToMany relationship

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related