cviebrock/eloquent-sluggable

Easy creation of slugs for your Eloquent models in Laravel.

Your models should use the Sluggable trait, which has an abstract method sluggable() that you need to define. This is where any model-specific configuration is set below for details):

use Cviebrock\EloquentSluggable\Sluggable;
 
class Post extends Model
{
    use Sluggable;
 
    /**
     * Return the sluggable configuration array for this model.
     *
     * @return array
     */
    public function sluggable(): array
    {
        return [
            'slug' => [
                'source' => 'title'
            ]
        ];
    }
}

Of course, your model and database will need a column in which to store the slug. You can use slug or any other appropriate name you want; your configuration array will determine to which field the data will be stored. You will need to add the column (which should be NULLABLE) manually via your own migration.

That's it ... your model is now "sluggable"!

Usage

Saving a model is easy:

$post = Post::create([
    'title' => 'My Awesome Blog Post',
]);

So is retrieving the slug:

echo $post->slug;

NOTE: If you are replicating your models using Eloquent's replicate() method, the package will automatically re-slug the model afterwards to ensure uniqueness.

$post = Post::create([
    'title' => 'My Awesome Blog Post',
]);
// $post->slug is "my-awesome-blog-post"
 
$newPost = $post->replicate();
// $newPost->slug is "my-awesome-blog-post-1"