zaimealabs/sluggable

The ZaimeaLabs Sluggable package.

1.1 2025-03-25 10:25 UTC

Requires

• php: ^8.2
• illuminate/database: ^10.0|^11.0|^12.0
• illuminate/support: ^10.0|^11.0|^12.0

Requires (Dev)

• orchestra/testbench: ^8.0|^9.0|^10.0
• pestphp/pest: ^2.0|^3.0

MIT

• Custură Laurențiu

• sluggable
• laravel
• zaimealabs

README

Generate aotomated slug for your models.

Hey 👋 thanks for considering making a donation, with these donations I can continue working to contribute to ZaimeaLabs projects.

Usage

namespace App;

use ZaimeaLabs\Sluggable\HasSlug;
use ZaimeaLabs\Sluggable\SlugOptions;
use Illuminate\Database\Eloquent\Model;

class EloquentModel extends Model
{
    use HasSlug;

    /**
     * Create a new options for generating the slug.
     *
     * @return \ZaimeaLabs\Sluggable\SlugOptions
     */
    public function newSlugOptions(): SlugOptions
    {
        return SlugOptions::create()
            ->generateSlugsFrom('name')
            ->saveSlugsTo('slug');
    }
}

With route

/**
 * Get the route key for the model.
 */
public function getRouteKeyName(): string
{
    return 'slug';
}

Options for slug

->generateSlugsFrom(['field', 'field_2'])
->saveSlugsTo('slug');
->allowDuplicateSlugs();
->slugsShouldBeNoLongerThan(50);
->usingSeparator('_');
->doNotGenerateSlugsOnCreate();
->doNotGenerateSlugsOnUpdate();
->preventOverwrite();
->startSlugSuffixFrom(2);

Find models by slug

For convenience, you can use the alias findBySlug to retrieve a model. The query will compare against the field passed to saveSlugsTo when defining the SlugOptions.

$model = Article::findBySlug('my-article');

findBySlug also accepts a second parameter $columns just like the default Eloquent find method.