Usage Core v1.2.0

Install, register, and configure Core

This page is for developers wiring the free Core package into a Laravel + Filament host. Admin field-creation steps are in Workflows. File uploads and Spatie Media are Pro.

Requirements

• PHP 8.2+
• Laravel 11+ (illuminate/support and illuminate/database ≥ 11)
• Filament ^3.3|^4.0|^5.0 — the host starter uses Filament v5 Schema APIs
• Optional: bezhansalleh/filament-shield / Spatie Permission for manage_custom_fields
• Pro only: spatie/laravel-medialibrary and filament/spatie-laravel-media-library-plugin for File fields

Composer package name: spiggle/dynamic-fields-core. PHP namespace: Spiggle\DynamicFields. Filament plugin id: spiggle-dynamic-fields. Public source: skillbobby/Spiggle-Dynamic-Fields-Core.

Install Core

Prefer Packagist when the package is listed:

composer require spiggle/dynamic-fields-core

Or a GitHub VCS repository:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/skillbobby/Spiggle-Dynamic-Fields-Core"
    }
  ],
  "require": {
    "spiggle/dynamic-fields-core": "^1.2"
  }
}

Path repository (this starter):

{
  "repositories": [
    {
      "type": "path",
      "url": "packages/spiggle-dynamic-fields-core",
      "options": { "symlink": true }
    }
  ],
  "require": {
    "spiggle/dynamic-fields-core": "@dev"
  }
}

The service provider and CustomFieldMapper facade alias auto-register via Composer extra.laravel. Download also via GitHub (clone or Releases).

Publish config and migrate

php artisan vendor:publish --tag=dynamic-fields-config
php artisan vendor:publish --tag=dynamic-fields-migrations
php artisan migrate

Do not add a users.custom_fields JSON column. Values belong in custom_field_values. File bytes belong to Spatie Media Library only when Pro is installed.

Register the Filament plugin

In the host panel provider (starter: app/Providers/Filament/AdminPanelProvider.php):

use Spiggle\DynamicFields\Filament\DynamicFieldsPlugin;

$panel->plugin(DynamicFieldsPlugin::make());

That registers the Custom Fields resource. Navigation group defaults to System, icon heroicon-o-adjustments-horizontal, sort 90 — all overridable in config.

Host model

The starter User already implements this pattern:

use Spiggle\DynamicFields\Traits\HasCustomFields;

class User extends Authenticatable
{
    use HasCustomFields;
}

• HasCustomFields is enough for every Core type.
• File fields are Pro: they require HasMedia + HasCustomFieldMedia from spiggle/dynamic-fields-pro.

Mass assignment

Filament nested state uses the key custom_fields (configurable). Add it to fillable so the mutator can queue values:

#[Fillable(['name', 'email', 'password', 'custom_fields'])]

Alternatively, in a page hook: $record->syncCustomFields($data['custom_fields'] ?? []).

Filament resource usage

use Filament\Schemas\Components\Section;
use Spiggle\DynamicFields\Facades\CustomFieldMapper;

Section::make('Custom Profile Data')
    ->schema(CustomFieldMapper::makeFormFields(User::class));

User::query()->withCustomFields()
...CustomFieldMapper::makeTableColumns(User::class)

CustomFieldMapper::makeInfolistEntries(User::class)

Always eager-load with withCustomFields() on list queries to avoid N+1. The starter Users table already does this.

Mapper methods return an empty array if something throws (missing tables during first boot, etc.), so the host resource still renders.

Permissions / Shield

CustomFieldResource::canAccess() checks:

1. The user is authenticated on the panel.
2. Spatie permission manage_custom_fields (config: dynamic-fields.permissions.manage), or role super_admin.
3. If Shield has not created that permission yet, authenticated panel users keep access so a fresh install is not locked out.

Config also lists view_custom_fields. The resource currently gates on the manage permission only.

Typical Shield generate (after the plugin is registered):

php artisan shield:generate --all

Then assign manage_custom_fields to the roles that should see Custom Fields.

Artisan commands

A seeder class Spiggle\DynamicFields\Database\Seeders\StandardUserFieldsSeeder calls the user-fields command.

Configuration

Published file: config/dynamic-fields.php.

Trait / mapper API