Laravel Tags

https://github.com/spatie/laravel-tags
Admin
Laravel Tags is a package that provides taggable behavior for Laravel models, offering features like...
Tokens:17,276
Snippets:140
Trust Score:10
License:MIT
Update:1 week ago
Show doc for...
Tokens:
Raw
### Publish config file with artisan vendor:publish

Source: https://github.com/spatie/laravel-tags/blob/main/docs/installation-and-setup.md

Optionally publish the configuration file using the tags-config tag.

```bash
php artisan vendor:publish --provider="Spatie\Tags\TagsServiceProvider" --tag="tags-config"
```

--------------------------------

### Install package via Composer

Source: https://github.com/spatie/laravel-tags/blob/main/docs/installation-and-setup.md

Run this command to install the spatie/laravel-tags package via Composer.

```bash
composer require spatie/laravel-tags
```

--------------------------------

### Run migrations to create tags and taggables tables

Source: https://github.com/spatie/laravel-tags/blob/main/docs/installation-and-setup.md

After publishing the migration, run this command to create the `tags` and `taggables` tables.

```bash
php artisan migrate
```

--------------------------------

### Publish migrations with artisan vendor:publish

Source: https://github.com/spatie/laravel-tags/blob/main/docs/installation-and-setup.md

Publishes the migration files for the tags package using the tags-migrations tag.

```bash
php artisan vendor:publish --provider="Spatie\Tags\TagsServiceProvider" --tag="tags-migrations"
```

--------------------------------

### Published config file contents

Source: https://github.com/spatie/laravel-tags/blob/main/docs/installation-and-setup.md

Shows the default configuration for the tags package, including the slugger function, tag model class, and taggable morph settings.

```php
return [

    /*
     * The given function generates a URL friendly "slug" from the tag name property before saving it.
     * Defaults to Str::slug (https://laravel.com/docs/master/helpers#method-str-slug)
     */
    'slugger' => null,

    /*
     * The fully qualified class name of the tag model.
     */
    'tag_model' => Spatie\Tags\Tag::class,

    /*
     * The name of the table associated with the taggable morph relation.
     */
    'taggable' => [
        'table_name' => 'taggables',
        'morph_name' => 'taggable',

        /*
         * The fully qualified class name of the pivot model.
         */
        'class_name' => Illuminate\Database\Eloquent\Relations\MorphPivot::class,
    ]
];
```

--------------------------------

### Using tag types with findOrCreate

Source: https://github.com/spatie/laravel-tags/blob/main/docs/introduction.md

Demonstrates creating a tag with a custom type by passing the type as the second argument to findOrCreate.

```php
// using tag types
$tag = Tag::findOrCreate('tag 1', 'my type');
```

--------------------------------

### Apply HasTags trait to a model

Source: https://github.com/spatie/laravel-tags/blob/main/README.md

Add the HasTags trait to an Eloquent model to make it taggable. This is the only setup required after installing the package.

```php
// apply HasTags trait to a model
use Illuminate\Database\Eloquent\Model;
use Spatie\Tags\HasTags;

class NewsItem extends Model
{
    use HasTags;
    
    // ...
}
```

--------------------------------

### Searching tags by value with containing

Source: https://github.com/spatie/laravel-tags/blob/main/docs/introduction.md

Shows how to retrieve all tags that contain a given value using the containing method.

```php
// get all tags containing a given value
Tag::containing('test'); // returns all tags that contain 'test'
```

--------------------------------

### Translating tags with setTranslation

Source: https://github.com/spatie/laravel-tags/blob/main/docs/introduction.md

Shows how to translate a tag using setTranslation for French and Dutch locales. Requires the tag to be saved after setting translations.

```php
// translating a tag
$tag = Tag::findOrCreate('my tag');
$tag->setTranslation('fr', 'mon tag');
$tag->setTranslation('nl', 'mijn tag');
$tag->save();
```

--------------------------------

### Get all registered tag types

Source: https://github.com/spatie/laravel-tags/blob/main/docs/basic-usage/using-tags.md

Call the static method getTypes() to fetch a collection of all registered tag types.

```php
Tag::getTypes();
```

--------------------------------

### Using tag types, slugs, and sorting

Source: https://github.com/spatie/laravel-tags/blob/main/README.md

Shows creating a tag with a type, accessing the auto-generated slug, and using the order_column for sorting. Also demonstrates swapping the order of two tags.

```php
// using tag types
$tag = Tag::findOrCreate('tag 1', 'my type');

// tags have slugs
$tag = Tag::findOrCreate('yet another tag');
$tag->slug; //returns "yet-another-tag"

// tags are sortable
$tag = Tag::findOrCreate('my tag');
$tag->order_column; //returns 1
$tag2 = Tag::findOrCreate('another tag');
$tag2->order_column; //returns 2

// manipulating the order of tags
$tag->swapOrder($anotherTag);
```

--------------------------------

### Translating tags

Source: https://github.com/spatie/laravel-tags/blob/main/README.md

Shows how to create a tag, set translations for its name, and retrieve translations. The translate method returns the name in the default locale if no locale is specified.

```php
// translating a tag
$tag = Tag::findOrCreate('my tag');
$tag->setTranslation('name', 'fr', 'mon tag');
$tag->setTranslation('name', 'nl', 'mijn tag');
$tag->save();

// getting translations
$tag->translate('name'); //returns my name
$tag->translate('name', 'fr'); //returns mon tag (optional locale param)

// convenient translations through taggable models
$newsItem->tagsTranslated();// returns tags with slug_translated and name_translated properties
$newsItem->tagsTranslated('fr');// returns tags with slug_translated and name_translated properties set for specified locale
```

--------------------------------

### Accessing tag slugs

Source: https://github.com/spatie/laravel-tags/blob/main/docs/introduction.md

Shows that tags have slugs automatically generated from the tag name; the slug property returns a URL-friendly version.

```php
// tags have slugs
$tag = Tag::findOrCreate('yet another tag');
$tag->slug; //returns "yet-another-tag"
```

--------------------------------

### Checking if a model has a tag and retrieving models by tag type

Source: https://github.com/spatie/laravel-tags/blob/main/README.md

Shows how to check if a model has a specific tag (optionally with a type) and how to retrieve models that have any tags of a given type or types.

```php
// checking if a model has a tag
$newsItem->hasTag('first tag');
$newsItem->hasTag('first tag', 'some_type');

// Retrieve models that have tags of a 
Model::withAnyTagsOfType('type');
Model::withAnyTagsOfType(['first type', 'second type']);
```

--------------------------------

### Tagging operations: create, attach, detach, sync, retrieve

Source: https://github.com/spatie/laravel-tags/blob/main/README.md

Shows common tag operations: creating a model with tags, attaching/detaching tags (optionally with a type), retrieving all tags, syncing tags (with or without type), and retrieving tags by type. Tags are created automatically if they don't exist.

```php

// create a model with some tags
$newsItem = NewsItem::create([
   'name' => 'The Article Title',
   'tags' => ['first tag', 'second tag'], //tags will be created if they don't exist
]);

// attaching tags
$newsItem->attachTag('third tag');
$newsItem->attachTag('third tag','some_type');
$newsItem->attachTags(['fourth tag', 'fifth tag']);
$newsItem->attachTags(['fourth_tag','fifth_tag'],'some_type');

// detaching tags
$newsItem->detachTag('third tag');
$newsItem->detachTag('third tag','some_type');
$newsItem->detachTags(['fourth tag', 'fifth tag']);
$newsItem->detachTags(['fourth tag', 'fifth tag'],'some_type');

// get all tags of a model
$newsItem->tags;

// syncing tags
$newsItem->syncTags(['first tag', 'second tag']); // all other tags on this model will be detached

// syncing tags with a type
$newsItem->syncTagsWithType(['category 1', 'category 2'], 'categories'); 
$newsItem->syncTagsWithType(['topic 1', 'topic 2'], 'topics'); 

// retrieving tags with a type
$newsItem->tagsWithType('categories'); 
$newsItem->tagsWithType('topics'); 

// retrieving models that have any of the given tags
NewsItem::withAnyTags(['first tag', 'second tag'])->get();

// retrieve models that have all of the given tags
NewsItem::withAllTags(['first tag', 'second tag'])->get();

// retrieve models that don't have any of the given tags
NewsItem::withoutTags(['first tag', 'second tag'])->get();
```

--------------------------------

### Detach tags from a model

Source: https://github.com/spatie/laravel-tags/blob/main/docs/basic-usage/using-tags.md

Detach tags using a string, an array, or a Tag instance. The example shows detachTag, detachTags, and detach methods.

```php
//using a string
$yourModel->detachTag('tag 1');

//using an array
$yourModel->detachTags(['tag 2', 'tag 3']);

//using an instance of \Spatie\Tags\Tag
$yourModel->detach(\Spatie\Tags\Tag::find('tag4'));
```

--------------------------------

### Sorting tags and manipulating order

Source: https://github.com/spatie/laravel-tags/blob/main/docs/introduction.md

Shows that tags are sortable via the order_column property and that swapOrder can be used to manipulate the order. The order_column values are assigned sequentially as tags are created.

```php
// tags are sortable
$tag = Tag::findOrCreate('my tag');
$tag->order_column; //returns 1
$tag2 = Tag::findOrCreate('another tag');
$tag2->order_column; //returns 2

//manipulating the order of tags
$tag->swapOrder($anotherTag);
```

--------------------------------

### Manage tags with the Tag model

Source: https://github.com/spatie/laravel-tags/blob/main/docs/basic-usage/using-tags.md

Create, update, retrieve, and delete tags using the Spatie\Tags\Tag model. Use findFromString instead of find to retrieve a tag, findOrCreateFromString to create if missing, and findFromStringOfAnyType to get tags of various types.

```php
//create a tag
$tag = Tag::create(['name' => 'my tag']);

//update a tag
$tag->name = 'another tag';
$tag->save();

//use "findFromString" instead of "find" to retrieve a certain tag
$tag = Tag::findFromString('another tag');

//create a tag if it doesn't exist yet
$tag = Tag::findOrCreateFromString('yet another tag');

//delete a tag
$tag->delete();

//use "findFromStringOfAnyType" to retrieve a collection of tags with various types
$tags = Tag::findFromStringOfAnyType('one more tag');
```

--------------------------------

### Get tags by type with getWithType and withType

Source: https://github.com/spatie/laravel-tags/blob/main/docs/advanced-usage/using-types.md

Use getWithType to retrieve all tags of a specific type. There is also a scoped version withType that returns the same result when called with get().

```php
$tagA = Tag::findOrCreate('tagA', 'firstType');
$tagB = Tag::findOrCreate('tagB', 'firstType');
$tagC = Tag::findOrCreate('tagC', 'secondType');
$tagD = Tag::findOrCreate('tagD', 'secondType');

Tag::getWithType('firstType'); // returns a collection with $tagA and $tagB

//there's also a scoped version
Tag::withType('firstType')->get(); // returns the same result
```

--------------------------------

### Published config file contents

Source: https://github.com/spatie/laravel-tags/blob/main/README.md

The published config file contains a slugger option that generates a URL friendly slug from the tag name property before saving. Defaults to Str::slug.

```php
return [

    /*
     * The given function generates a URL friendly "slug" from the tag name property before saving it.
     * Defaults to Str::slug (https://laravel.com/docs/5.8/helpers#method-str-slug)
     */
    'slugger' => null, 
];
```

--------------------------------

### Find tags containing a value

Source: https://github.com/spatie/laravel-tags/blob/main/docs/basic-usage/using-tags.md

Use the containing scope to find all tags that contain a specific value. The example creates several tags and then retrieves all tags containing 'on', which returns all except 'two'.

```php
Tag::findOrCreate('one');
Tag::findOrCreate('another-one');
Tag::findOrCreate('another-ONE-with-different-casing');
Tag::findOrCreate('two');

Tag::containing('on')->get(); // will return all tags except `two`
```

--------------------------------

### Basic tag operations with HasTags trait

Source: https://github.com/spatie/laravel-tags/blob/main/docs/introduction.md

Shows core taggable operations after adding the HasTags trait to an Eloquent model: creating a model with tags, attaching, detaching, syncing, and querying by tags. Tags are created automatically if they don't exist. syncTags detaches all other tags on the model.

```php
// create a model with some tags
$newsItem = NewsItem::create([
   'name' => 'testModel',
   'tags' => ['tag', 'tag2'], //tags will be created if they don't exist
]);

// attaching tags
$newsItem->attachTag('tag3');
$newsItem->attachTags(['tag4', 'tag5']);

// detaching tags
$newsItem->detachTag('tag3');
$newsItem->detachTags(['tag4', 'tag5']);

// syncing tags
$newsItem->syncTags(['tag1', 'tag2']); // all other tags on this model will be detached

// retrieving models that have any of the given tags
NewsItem::withAnyTags(['tag1', 'tag2']);

// retrieve models that have all of the given tags
NewsItem::withAllTags(['tag1', 'tag2']);
```

--------------------------------

### Get tags with a specific type from a model using tagsWithType

Source: https://github.com/spatie/laravel-tags/blob/main/docs/advanced-usage/using-types.md

Call tagsWithType on a model instance to retrieve all tags of the given type as a collection.

```php
$newsItem->tagsWithType('firstType'); // returns a collection
```

--------------------------------

### Set and get tag translations with setTranslation and getTranslation

Source: https://github.com/spatie/laravel-tags/blob/main/docs/advanced-usage/adding-translations.md

Creates a tag in the current locale, adds French and Dutch translations, saves the model, and retrieves translations. The name attribute returns the tag name in the current app locale. Translations are stored in a JSON column named 'name' in the tags table.

```php
$tag = Tag::findOrCreate('my tag'); //store in the current locale of your app

//let's add some translation for other languages
$tag->setTranslation('name', 'fr', 'mon tag');
$tag->setTranslation('name', 'nl', 'mijn tag');

//don't forget to save the model
$tag->save();

$tag->getTranslation('name', 'fr'); // returns 'mon tag'

$tag->name // returns the name of the tag in current locale of your app.
```

--------------------------------

### withAllTagsOfAnyType scope usage

Source: https://github.com/spatie/laravel-tags/blob/main/docs/basic-usage/retrieving-tagged-models.md

Returns only models that have all of the given tags, without restricting the tags to any type when passed as strings. Passing a non-existing tag returns no models.

```php
//returns models that have all given tags of any type
YourModel::withAllTagsOfAnyType(['tag 1', 'tag 2'])->get();
```

--------------------------------

### withAnyTagsOfAnyType scope usage

Source: https://github.com/spatie/laravel-tags/blob/main/docs/basic-usage/retrieving-tagged-models.md

Returns models that have one or more of the given tags, without restricting the tags to any type when passed as strings.

```php
//returns models that have one or more of the given tags of any type
YourModel::withAnyTagsOfAnyType(['tag 1', 'tag 2'])->get();
```

--------------------------------

### Sort and reorder tags using eloquent-sortable methods

Source: https://github.com/spatie/laravel-tags/blob/main/docs/advanced-usage/sorting-tags.md

Use these methods to retrieve tags sorted by `order_column`, set a new order, move models up/down, move a tag to the start/end, or swap order with another tag. `Tag::ordered()` returns all tags sorted on `order_column`; `Tag::setNewOrder()` expects an array of tag IDs. The `moveOrderUp()` and `moveOrderDown()` methods are called on a model instance.

```php
//get all tags sorted on `order_column`
$orderedTags = Tag::ordered()->get(); 

//set a new order entirely
Tag::setNewOrder($arrayWithTagIds);

$myModel->moveOrderUp();
$myModel->moveOrderDown();

//let's grab a Tag instance
$tag = $orderedTags->first();

//move the tag to the first or last position
$tag->moveToStart();
$tag->moveToEnd();

$tag->swapOrder($anotherTag);
```

--------------------------------

### withAllTags scope usage

Source: https://github.com/spatie/laravel-tags/blob/main/docs/basic-usage/retrieving-tagged-models.md

Returns only models that have all of the given tags. If the type argument is passed, it looks for tags with that type; otherwise, it only looks for tags without a type. Passing a non-existing tag or a correct tag name with the wrong type returns no models.

```php
//returns models that have all given tags that are not saved with a type
YourModel::withAllTags(['tag 1', 'tag 2'])->get();
```

```php
//returns models that have all given tags that are typed `myType`
YourModel::withAllTags(['tag 1', 'tag 2'], 'myType')->get();
```

--------------------------------

### Attach and detach a Tag instance

Source: https://github.com/spatie/laravel-tags/blob/main/docs/advanced-usage/using-types.md

Methods like attachTag and detachTag accept Tag instances in addition to strings, as mentioned in the basic usage section.

```php
$newsItem->attachTag($tagWithType);
$newsItem->detachTag($tagWithType);
// ...
```

--------------------------------

### Sync tags on a model

Source: https://github.com/spatie/laravel-tags/blob/main/docs/basic-usage/using-tags.md

syncTags ensures only the given tags are attached to the model; all other tags are detached.

```php
$yourModel->syncTags(['tag 2', 'tag 3']);
```

--------------------------------

### Attach tags to a model

Source: https://github.com/spatie/laravel-tags/blob/main/docs/basic-usage/using-tags.md

Use attachTag for a single tag and attachTags for multiple tags. Tags are stored in the 'tags' table, are unique, and a model will have a tag attached only once.

```php
//adding a single tag
$yourModel->attachTag('tag 1');

//adding multiple tags
$yourModel->attachTags(['tag 2', 'tag 3']);
```

--------------------------------

### Sync tags per type with syncTagsWithType

Source: https://github.com/spatie/laravel-tags/blob/main/docs/advanced-usage/using-types.md

Use syncTagsWithType to sync tags for a specific type. This method is available in addition to syncTags and allows per-type syncing.

```php
$newsItem->syncTagsWithType(['tagA', 'tagB'], 'firstType');
$newsItem->syncTagsWithType(['tagC', 'tagD'], 'secondType');
```

--------------------------------

### withAnyTags scope usage

Source: https://github.com/spatie/laravel-tags/blob/main/docs/basic-usage/retrieving-tagged-models.md

Returns models that have one or more of the given tags. If the type argument is passed, it looks for tags with that type; otherwise, it only looks for tags without a type.

```php
//returns models that have one or more of the given tags that are not saved with a type
YourModel::withAnyTags(['tag 1', 'tag 2'])->get();
```

```php
//returns models that have one or more of the given tags that are typed `myType`
YourModel::withAnyTags(['tag 1', 'tag 2'], 'myType')->get();
```

--------------------------------

### Use Tag instances with withAnyTags scope

Source: https://github.com/spatie/laravel-tags/blob/main/docs/advanced-usage/using-types.md

The withAnyTags scope accepts Tag instances. Create tags first, then pass them to the scope to filter models.

```php
$tag = Tag::create(['name' => 'gossip']);
$tag2 = Tag::create(['name' => 'headline']);

NewsItem::withAnyTags([$tag, $tag2])->get();
```

--------------------------------

### Create a tag with a type using Tag::findOrCreate

Source: https://github.com/spatie/laravel-tags/blob/main/docs/advanced-usage/using-types.md

Use the second argument to specify the tag type when creating a tag. This allows separate collections of tags for different models or contexts.

```php
//creating a tag with a certain type
$tagWithType = Tag::findOrCreate('headline', 'newsTag');
```

--------------------------------

### withAllTagsOfAnyType

Source: https://github.com/spatie/laravel-tags/blob/main/docs/basic-usage/retrieving-tagged-models.md

The withAllTagsOfAnyType scope returns only models that have all of the given tags attached, regardless of tag type.

```APIDOC
## withAllTagsOfAnyType

### Description
Returns only the models that have all of the given tags attached to them, without restricting the tags to any type when passed as strings. Passing a non-existing tag will result in no models being returned.

### Method
Scope (Eloquent)

### Parameters
- **tags** (array) - Required - The list of tag names to match.

### Example
```php
// Returns models that have all given tags of any type
YourModel::withAllTagsOfAnyType(['tag 1', 'tag 2'])->get();
```
```

--------------------------------

### withAnyTagsOfAnyType

Source: https://github.com/spatie/laravel-tags/blob/main/docs/basic-usage/retrieving-tagged-models.md

The withAnyTagsOfAnyType scope returns models that have one or more of the given tags attached, regardless of tag type.

```APIDOC
## withAnyTagsOfAnyType

### Description
Returns models that have one or more of the given tags attached to them, without restricting the tags to any type when passed as strings.

### Method
Scope (Eloquent)

### Parameters
- **tags** (array) - Required - The list of tag names to match.

### Example
```php
// Returns models that have one or more of the given tags of any type
YourModel::withAnyTagsOfAnyType(['tag 1', 'tag 2'])->get();
```
```

--------------------------------

### Check if a model has a tag

Source: https://github.com/spatie/laravel-tags/blob/main/docs/basic-usage/using-tags.md

Use hasTag to check if a model has a specific tag. Optionally pass a type to check for a tag with that type. Returns true or false.

```php
$yourModel->hasTag('tag 1'); // returns true if the model has the tag
$yourModel->hasTag('non-existing tag'); // returns false if the model does not have the tag
```

--------------------------------

### withAllTags

Source: https://github.com/spatie/laravel-tags/blob/main/docs/basic-usage/retrieving-tagged-models.md

The withAllTags scope returns only models that have all of the given tags attached. Optionally, you can specify a tag type to filter by.

```APIDOC
## withAllTags

### Description
Returns only the models that have all of the given tags attached to them. If a type is provided, only tags of that type are considered; otherwise, only tags without a type are considered. Passing a non-existing tag or a correct tag name with the wrong type will result in no models being returned.

### Method
Scope (Eloquent)

### Parameters
- **tags** (array) - Required - The list of tag names to match.
- **type** (string|null) - Optional - The tag type to filter by. If not provided, only tags without a type are matched.

### Example
```php
// Returns models that have all given tags that are not saved with a type
YourModel::withAllTags(['tag 1', 'tag 2'])->get();

// Returns models that have all given tags that are typed `myType`
YourModel::withAllTags(['tag 1', 'tag 2'], 'myType')->get();
```
```

--------------------------------

### withAnyTags

Source: https://github.com/spatie/laravel-tags/blob/main/docs/basic-usage/retrieving-tagged-models.md

The withAnyTags scope returns models that have one or more of the given tags attached. Optionally, you can specify a tag type to filter by.

```APIDOC
## withAnyTags

### Description
Returns models that have one or more of the given tags attached to them. If a type is provided, only tags of that type are considered; otherwise, only tags without a type are considered.

### Method
Scope (Eloquent)

### Parameters
- **tags** (array) - Required - The list of tag names to match.
- **type** (string|null) - Optional - The tag type to filter by. If not provided, only tags without a type are matched.

### Example
```php
// Returns models that have one or more of the given tags that are not saved with a type
YourModel::withAnyTags(['tag 1', 'tag 2'])->get();

// Returns models that have one or more of the given tags that are typed `myType`
YourModel::withAnyTags(['tag 1', 'tag 2'], 'myType')->get();
```
```

--------------------------------

### Add HasTags trait to Eloquent model

Source: https://github.com/spatie/laravel-tags/blob/main/docs/basic-usage/using-tags.md

Make an Eloquent model taggable by adding the \Spatie\Tags\HasTags trait. Import the trait and use it inside the model class.

```php
use Illuminate\Database\Eloquent\Model;
use Spatie\Tags\HasTags;

class YourModel extends Model
{
    use HasTags;

    ...
}
```

--------------------------------

### Override getTagClassName to Use Custom Tag Model

Source: https://github.com/spatie/laravel-tags/blob/main/docs/advanced-usage/using-your-own-tag-model.md

Define a custom tag model by overriding the getTagClassName method in your model. The method must return the fully qualified class name of an Eloquent model that extends Spatie\Tags\Tag and uses the same tags table.

```php
use Illuminate\Database\Eloquent\Model;
use Spatie\Tags\HasTags;

class YourModel extends Model
{
    use HasTags;
    
    public static function getTagClassName(): string
    {
        return YourTagModel::class;
    }
}
```

--------------------------------

### Check if a model has a tag with a specific type

Source: https://github.com/spatie/laravel-tags/blob/main/docs/basic-usage/using-tags.md

Use hasTag with a type argument to check if the model has a tag of that type. Returns true or false.

```php
$yourModel->hasTag('tag 1', 'some_type'); // returns true if the model has the tag with the specified type
$yourModel->hasTag('tag 1', 'non-existing type'); // returns false if the model does not have the tag with the specified type
```

--------------------------------

### Manually set tag order_column

Source: https://github.com/spatie/laravel-tags/blob/main/docs/advanced-usage/sorting-tags.md

Directly assign a value to the `order_column` attribute and save the tag to manually control its order. This bypasses the automatic ordering provided by eloquent-sortable.

```php
$tag->order_column = 10;
$tag->save();
```

--------------------------------

### Query tag by translation using JSON column

Source: https://github.com/spatie/laravel-tags/blob/main/docs/advanced-usage/adding-translations.md

Uses Laravel's query builder to find a tag by a specific translation value in the JSON 'name' column. The where clause targets the 'fr' key with the value 'mon tag'.

```php
 \Spatie\Tags\Tag::query()
   ->where('name->fr', 'mon tag')
   ->first();
```

--------------------------------

### Update tag_model in config/tags.php

Source: https://github.com/spatie/laravel-tags/blob/main/docs/advanced-usage/using-another-default-locale.md

Change the 'tag_model' configuration key in config/tags.php to point to your custom App\Models\YourTag class. This ensures Laravel uses your custom model with the overridden locale.

```php
return [

    /*
     * The given function generates a URL friendly "slug" from the tag name property before saving it.
     * Defaults to Str::slug (https://laravel.com/docs/master/helpers#method-str-slug)
     */
    'slugger' => null,

    /*
     * The fully qualified class name of the tag model.
     */
    'tag_model' => App\Models\YourTag::class,
];
```

--------------------------------

### Override tags() Method to Use tag_id Column

Source: https://github.com/spatie/laravel-tags/blob/main/docs/advanced-usage/using-your-own-tag-model.md

Override the tags() method from the HasTags trait to ensure Laravel still looks for the tag_id column in the tags relation instead of your_tag_model_id. This is required when using a custom tag model.

```php
use Illuminate\Database\Eloquent\Relations\MorphToMany;

public function tags(): MorphToMany
{
    return $this
        ->morphToMany(self::getTagClassName(), 'taggable', 'taggables', null, 'tag_id')
        ->orderBy('order_column');
}
```

--------------------------------

### Override getLocale() in custom Tag model

Source: https://github.com/spatie/laravel-tags/blob/main/docs/advanced-usage/using-another-default-locale.md

Create a custom Tag model extending Spatie\Tags\Tag and override the static getLocale() method to return 'nl' for Dutch. This makes the admin section use Dutch as the default language for tags even when the app locale is English.

```php
namespace App\Models;

use Spatie\Tags\Tag as SpatieTag;

class YourTag extends SpatieTag
{
    public static function getLocale(): string
    {
        return 'nl';
    }
}
```
Tokens:
Raw