PHPackages webwizo/laravel-shortcodes-filament - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Admin Panels](/categories/admin) 4. / 5. webwizo/laravel-shortcodes-filament ActiveLibrary[Admin Panels](/categories/admin) webwizo/laravel-shortcodes-filament =================================== Filament 3 plugin for managing Laravel Shortcodes via admin panel v1.0.1(3w ago)0241MITPHPPHP ^8.2 Since May 18Pushed 2w agoCompare [ Source](https://github.com/webwizo/laravel-shortcodes-filament)[ Packagist](https://packagist.org/packages/webwizo/laravel-shortcodes-filament)[ RSS](/packages/webwizo-laravel-shortcodes-filament/feed)WikiDiscussions main Synced 1w ago READMEChangelog (2)Dependencies (4)Versions (4)Used By (0) Laravel Shortcodes — Filament Plugin ==================================== [](#laravel-shortcodes--filament-plugin) [![Latest Version on Packagist](https://camo.githubusercontent.com/7155be7def0e7f05d6675a7fc58c9ac051b7fb84772f029fc28a4a8739ebf764/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f77656277697a6f2f6c61726176656c2d73686f7274636f6465732d66696c616d656e742e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/webwizo/laravel-shortcodes-filament)[![Total Downloads](https://camo.githubusercontent.com/a0e8b4ec4b195ca4a7c6455c4d34ad4045c1fe547f43594b9658fe2359d7a1c7/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f77656277697a6f2f6c61726176656c2d73686f7274636f6465732d66696c616d656e742e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/webwizo/laravel-shortcodes-filament)[![License](https://camo.githubusercontent.com/1c9216d829e578926cbcacaf03662b63b329764d20229a0a16a359ea4fd6c778/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f77656277697a6f2f6c61726176656c2d73686f7274636f6465732d66696c616d656e742e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/webwizo/laravel-shortcodes-filament) [![Laravel Shortcodes Filament](assets/art/laravel-shortcodes-filament.jpeg)](assets/art/laravel-shortcodes-filament.jpeg) A [Filament v3](https://filamentphp.com) plugin that gives you a full admin UI for managing [webwizo/laravel-shortcodes](https://github.com/webwizo/laravel-shortcodes) — create, edit, and delete shortcodes from the browser without touching code. Shortcodes are small tags like `[store id="5"]` that your content editors embed in any text field. This plugin stores them in the database and renders them dynamically at runtime, with optional live data pulled from any database table. --- Features -------- [](#features) - **Full CRUD UI** — list, create, edit, and delete shortcodes from the Filament panel - **Shortcode types** — choose between **Static** (attributes + template only) and **Dynamic** (adds a live DB data source) - **Attribute builder** — define named attributes with defaults via a repeater UI - **HTML template editor** — write the output HTML with `{{attr}}`, `{{content}}`, and `{{db.column}}` placeholders - **Dynamic data sources** — pull a live database row into any shortcode template at render time, with soft-delete awareness - **Usage example** — auto-generated, copyable shortcode string shown in the table and edit form - **Annotated Facade** — full IDE autocompletion for `compile()`, `strip()`, and more via `Webwizo\ShortcodesFilament\Facades\Shortcode` - **Multi-tenancy** — first-class Filament multi-tenant support with auto-detection of `int`, `UUID`, and `ULID` primary keys - **Zero boilerplate** — shortcodes register themselves automatically on boot; no manual `Shortcode::register()` calls needed --- Requirements ------------ [](#requirements) DependencyVersionPHP^8.2Laravel^11.0 | ^12.0Filament^3.0webwizo/laravel-shortcodes^1.0--- Installation ------------ [](#installation) Install the package via Composer: ``` composer require webwizo/laravel-shortcodes-filament ``` Publish the config and migration: ``` php artisan vendor:publish --tag=shortcodes-filament-config php artisan vendor:publish --tag=shortcodes-filament-migrations php artisan migrate ``` Register the plugin in your Filament panel provider: ``` use Webwizo\ShortcodesFilament\ShortcodesFilamentPlugin; public function panel(Panel $panel): Panel { return $panel ->plugins([ ShortcodesFilamentPlugin::make(), ]); } ``` --- Usage ----- [](#usage) ### Writing shortcodes in content [](#writing-shortcodes-in-content) Once a shortcode is created in the panel, editors can embed it anywhere: ``` [store id="5"]Buy now[/store] [hero class="dark" title="Welcome"]Homepage banner[/hero] ``` To render shortcodes in a Blade view, use the `webwizo/laravel-shortcodes` parser: ``` {!! Shortcode::compile($post->content) !!} ``` For full IDE autocompletion (`compile`, `strip`, `register`, etc.), import the facade provided by this package instead of the vendor one: ``` use Webwizo\ShortcodesFilament\Facades\Shortcode; // compile() now autocompletes in PhpStorm, VS Code + Intelephense, etc. return Shortcode::compile($post->content); ``` --- ### Creating a shortcode in the panel [](#creating-a-shortcode-in-the-panel) 1. Navigate to **Content → Shortcodes** in the sidebar 2. Click **New Shortcode** 3. Fill in: - **Tag** — the shortcode name used in content, e.g. `store` (lowercase, hyphens allowed) - **Label** — human-readable name shown in the panel - **Type** — `Static` for pure HTML/attribute templates, `Dynamic` to attach a live DB data source - **Attributes** — named parameters editors can pass, each with an optional default value - **Dynamic Data Source** *(Dynamic type only)* — pick the table, lookup column, and which shortcode attribute holds the lookup value - **Template** — the HTML output, using placeholders described below 4. Save — the shortcode is immediately live --- ### Template placeholders [](#template-placeholders) PlaceholderReplaced with`{{content}}`The inner content between opening and closing tags`{{attr_name}}`The value of a named attribute, falling back to its default`{{db.column_name}}`A column from the dynamic data source row**Example template:** ``` {{db.name}} {{db.description}} {{content}} ``` Used in content as: ``` [store id="5" class="featured"]Check it out[/store] ``` --- ### Shortcode types [](#shortcode-types) Every shortcode has a **Type**: - **Static** — renders the HTML template with attribute and content substitution only. The Dynamic Data Source section is hidden. - **Dynamic** — additionally pulls a live row from a database table at render time, making `{{db.column_name}}` placeholders available in the template. ### Dynamic data sources [](#dynamic-data-sources) Set the shortcode type to **Dynamic** and fill in the **Dynamic Data Source** section: - **Database Table** — the table to query - **Lookup Column** — the column used to find the row (e.g. `id`) - **Shortcode Attribute** — which shortcode attribute holds the lookup value (e.g. `id`) Then reference any column from that row in your template with `{{db.column_name}}`. ``` {{db.name}} {{db.slug}} {{content}} ``` Used in content as: ``` [store id="01kre0dee551yx52r6jwdambg6" class="featured"]Check it out[/store] ``` **Validation behaviour:** - If the lookup attribute is missing from the tag (e.g. `[store]`), the shortcode renders nothing. - If the lookup value does not match any row, the shortcode renders nothing. - Soft-deleted rows (`deleted_at IS NOT NULL`) are automatically excluded. - Any `{{db.*}}` placeholders with no matching column are silently removed. Results are cached for 600 seconds by default (configurable via `cache_ttl`). --- Configuration ------------- [](#configuration) After publishing, edit `config/shortcodes-filament.php`: ``` return [ // Eloquent model used for shortcodes. Swap this to extend with your own model. 'model' => \Webwizo\ShortcodesFilament\Models\Shortcode::class, // Database table name 'table_name' => 'shortcodes', // Tables hidden from the Dynamic Data Source picker 'excluded_tables' => [ 'migrations', 'failed_jobs', 'sessions', 'cache', /* ... */ ], // Cache TTL in seconds for dynamic data source results. Set 0 to disable. 'cache_ttl' => 600, 'tenant' => [ // Foreign key column on the shortcodes table 'foreign_key' => 'team_id', // Relationship method name on the Shortcode model 'relationship' => 'team', // Your tenant Eloquent model class 'model' => \App\Models\Team::class, // Primary-key type: 'int', 'uuid', 'ulid', 'string', or null to auto-detect 'key_type' => null, ], ]; ``` --- Plugin fluent API ----------------- [](#plugin-fluent-api) All options can also be set inline in the panel provider, which takes precedence over the config file: ``` ShortcodesFilamentPlugin::make() ->navigationGroup('CMS') ->navigationIcon('heroicon-o-code-bracket') ->navigationSort(5) ->usingDynamicDataSources(true) ``` --- Without multi-tenancy --------------------- [](#without-multi-tenancy) If your app does not use Filament's multi-tenant system, simply leave `tenant.model` as `null` in the config (the default). The migration will create a clean `shortcodes` table with no foreign key column, and tags will be unique globally. ``` 'tenant' => [ 'model' => null, // no tenant column created in the migration ], ``` --- Adding multi-tenancy later -------------------------- [](#adding-multi-tenancy-later) If you installed the package without multi-tenancy and want to add it later, the original migration has already run so you cannot re-run it. Instead, update your config with the tenant model, foreign key, and relationship, then run the built-in command: ``` php artisan shortcodes:add-tenant ``` The command will: - Read your `tenant.model`, `tenant.foreign_key`, and `tenant.key_type` from config - Auto-detect the correct column type from your tenant model's traits if `key_type` is not set - Check the column does not already exist - Generate a new migration file in your `database/migrations` folder Then apply it: ``` php artisan migrate ``` The generated migration adds the FK column, drops the global `UNIQUE(tag)` index, and replaces it with a tenant-scoped `UNIQUE(tenant_fk, tag)` so the same tag can exist independently per tenant. --- Multi-tenancy ------------- [](#multi-tenancy) The plugin has first-class support for Filament's [multi-tenancy](https://filamentphp.com/docs/3.x/panels/tenancy). ### Basic setup [](#basic-setup) Pass your tenant model and relationship details on the plugin: ``` ShortcodesFilamentPlugin::make() ->scopedToTenant(true) ->tenantRelationship('team') // method name on the Shortcode model ->tenantForeignKey('team_id') // FK column on the shortcodes table ->tenantModel(\App\Models\Team::class) ``` ### Tenant primary key types [](#tenant-primary-key-types) The migration automatically uses the right column type for the foreign key based on your tenant model: Tenant key typeColumn createdAuto-increment (`int`)`UNSIGNED BIGINT`UUID (`HasUuids`)`UUID` (36 chars)ULID (`HasUlids`)`CHAR(26)`Custom string`VARCHAR`**Auto-detection** is on by default — the migration inspects `class_uses_recursive()` on your tenant model and picks the right column type. You can override it explicitly: ``` // Via plugin fluent API ShortcodesFilamentPlugin::make() ->tenantKeyType('ulid') // Or via config 'tenant' => [ 'key_type' => 'ulid', ], ``` ### Tenant model — required `hasMany` relationship [](#tenant-model--required-hasmany-relationship) Filament's tenancy system requires your tenant model to declare a `hasMany` relationship back to the shortcodes table. Add this to your tenant model: ``` use Illuminate\Database\Eloquent\Relations\HasMany; use Webwizo\ShortcodesFilament\Models\Shortcode; public function shortcodes(): HasMany { return $this->hasMany(Shortcode::class, 'team_id'); } ``` > Replace `team_id` with whatever foreign key you configured. Without this relationship Filament will throw a "does not have a relationship" error when loading the panel. ### Full multi-tenant example [](#full-multi-tenant-example) **1. Tenant model** (`app/Models/Team.php`): ``` namespace App\Models; use Illuminate\Database\Eloquent\Model; use Illuminate\Database\Eloquent\Relations\HasMany; use Webwizo\ShortcodesFilament\Models\Shortcode; class Team extends Model { // Required: Filament uses this to scope shortcodes to the current tenant public function shortcodes(): HasMany { return $this->hasMany(Shortcode::class, 'team_id'); } } ``` **2. Panel provider** (`app/Providers/Filament/AdminPanelProvider.php`): ``` use App\Models\Team; use Webwizo\ShortcodesFilament\ShortcodesFilamentPlugin; public function panel(Panel $panel): Panel { return $panel ->tenant(Team::class, slugAttribute: 'slug') ->plugins([ ShortcodesFilamentPlugin::make() ->navigationGroup('Content') ->scopedToTenant(true) ->tenantRelationship('team') ->tenantForeignKey('team_id') ->tenantModel(Team::class), ]); } ``` --- Extending the model ------------------- [](#extending-the-model) You can swap in your own model by updating the config: ``` // config/shortcodes-filament.php 'model' => \App\Models\Shortcode::class, ``` Your model should extend the package model to keep all functionality: ``` namespace App\Models; use Webwizo\ShortcodesFilament\Models\Shortcode as BaseShortcode; class Shortcode extends BaseShortcode { // Add your own methods, casts, relationships, etc. } ``` --- Changelog --------- [](#changelog) Please see [CHANGELOG.md](CHANGELOG.md) for recent changes. --- Contributing ------------ [](#contributing) Pull requests are welcome. For major changes please open an issue first to discuss what you would like to change. --- License ------- [](#license) The MIT License (MIT). Please see [LICENSE](LICENSE) for more information. --- Credits ------- [](#credits) - [Asif Iqbal](https://github.com/webwizo) - Built on [webwizo/laravel-shortcodes](https://github.com/webwizo/laravel-shortcodes) and [Filament](https://filamentphp.com) ### Health Score 43 — FairBetter than 89% of packages Maintenance96 Actively maintained with recent releases Popularity11 Limited adoption so far Community7 Small or concentrated contributor base Maturity48 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~0 days Total 2 Last Release 21d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/898d322150be99f183575f39904b6dba239bf86fe1fc0686b70340caca6f2c36?d=identicon)[webwizo](/maintainers/webwizo) --- Top Contributors [![webwizo](https://avatars.githubusercontent.com/u/1593953?v=4)](https://github.com/webwizo "webwizo (5 commits)") --- Tags pluginlaravelcmsshortcodesfilament ### Embed Badge ![Health badge](/badges/webwizo-laravel-shortcodes-filament/health.svg) ``` [![Health](https://phpackages.com/badges/webwizo-laravel-shortcodes-filament/health.svg)](https://phpackages.com/packages/webwizo-laravel-shortcodes-filament) ``` ### Alternatives [psalm/plugin-laravel Psalm plugin for Laravel 3325.1M337](/packages/psalm-plugin-laravel)[a2insights/filament-saas Filament Saas for A2Insights 171.5k](/packages/a2insights-filament-saas) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)