If you see anything missing from this guide, please don’t hesitate to make a pull request to our repository! Any help is appreciated!
New requirements
- PHP 8.2+
- Laravel v11.28+
- Tailwind CSS v4.1+, if you’re currently using Tailwind CSS v3.0 with Filament. This doesn’t apply if you’re just using a Filament panel without a custom theme CSS file.
- Filament no longer requires
doctrine/dbal, but if your application still does, and you don’t have it installed directly, you should add it to yourcomposer.jsonfile.
Running the automated upgrade script
The upgrade script is not a replacement for the upgrade guide. It handles many small changes that aren’t mentioned in the upgrade guide, but it doesn’t handle all breaking changes. You should still read the manual upgrade steps to see what changes you need to make to your code.
Some plugins you’re using may not be available in v4 just yet. You could temporarily remove them from your
composer.json file until they’ve been upgraded, replace them with similar plugins that are v4-compatible, wait for the plugins to be upgraded before upgrading your app, or even write PRs to help the authors upgrade them.--dry-run option will show you what the command would do without actually making any changes. If you’re happy with the changes, you can run the command without the --dry-run option to apply the changes:
composer remove filament/upgrade --dev as you don’t need it anymore.
Publishing the configuration file
Some changes in Filament v4 can be reverted using the configuration file. If you haven’t published the configuration file yet, you can do so by running the following command:default_filesystem_disk in v4 is set to the FILESYSTEM_DISK variable instead of FILAMENT_FILESYSTEM_DISK. To preserve the v3 behavior, make sure you use this setting:
file_generation section has been added to the v4 configuration file, so that you can revert back to the v3 style if you would like to keep new code consistent with how it looked before upgrading. If your configuration file doesn’t already have a file_generation section, you should add it yourself, or re-publish the configuration file and tweak it to your liking:
Breaking changes that must be handled manually
To begin, filter the upgrade guide for your specific needs by selecting only the packages that you use in your project:This package is also often used in a panel, or using the tables or actions package.
This package is also often used in a panel, or using the tables or actions package.
This package is also often used in a panel.
This package is also often used in a panel.
This package is also often used in a panel.
This package is also often used in a panel.
High-impact changes
File visibility is now private by default for non-local disks
In addition to the default disk being changed to
local, the file visibility settings for non-local disks (such as s3, but not public or local) across various components have been changed to private instead of public by default. This means that files aren’t publicly accessible by default, and you need to generate a temporary signed URL to access them. This change affects the following components:FileUploadform field, includingSpatieMediaLibraryFileUploadImageColumntable column, includingSpatieMediaLibraryImageColumnImageEntryinfolist entry, includingSpatieMediaLibraryImageEntry
Custom themes need to be upgraded to Tailwind CSS v4
Previously, custom theme CSS files contained this:Now, they should contain this:This will load Tailwind CSS. The The
@source entries tell Tailwind where to find the classes that are used in your app. You should check the content paths in your old tailwind.config.js file, and add them as @source entries like this. You don’t need to include vendor/filament as a @source, but check plugins you have installed to see if they require @source entries.Finally, you should use the Tailwind upgrade tool to automatically adjust your configuration files to use Tailwind v4, and install Tailwind v4 packages to replace Tailwind v3 ones:tailwind.config.js file for your theme is no longer used, since Tailwind CSS v4 defines configuration in CSS. Any customizations you made to the tailwind.config.js file should be added to the CSS file.Tailwind CSS classes from Filament views no longer available without a custom theme
In v3, Filament’s Blade views contained Tailwind CSS classes directly in the HTML. This meant that if you used any of those same Tailwind classes in your own code (such as
hidden or text-primary-600), they would “just work” without you needing to set up a custom theme - Filament’s asset compilation would include them for you.In v4, Filament’s Tailwind classes have been moved into CSS files using Tailwind’s @apply directive. This means those classes are no longer scanned by Tailwind when compiling assets, so they won’t be included in Filament’s default stylesheet.If you’re using Tailwind classes in your own Blade views, Livewire components, or other code, and you don’t have a custom theme, those styles will no longer work. To fix this, you need to create a custom theme.Run php artisan make:filament-theme and follow the theming documentation. In your theme CSS file, add @source entries pointing to your files that use Tailwind classes:Changes to table filters are deferred by default
The
deferFilters() method from Filament v3 is now the default behavior in Filament v4, so users must click a button before the filters are applied to the table. To disable this behavior, you can use the deferFilters(false) method.The Grid, Section and Fieldset layout components now do not span all columns by default
Grid, Section and Fieldset layout components now do not span all columns by defaultIn v3, the
Grid, Section and Fieldset layout components consumed the full width of their parent grid by default. This was inconsistent with the behavior of every other component in Filament, which only consumes one column of the grid by default. The intention was to make these components easier to integrate into the default Filament resource form and infolist, which uses a two column grid out of the box.In v4, the Grid, Section and Fieldset layout components now only consume one column of the grid by default. If you want them to span all columns, you can use the columnSpanFull() method:The unique() validation rule behavior for ignoring Eloquent records
unique() validation rule behavior for ignoring Eloquent recordsIn v3, the
unique() method didn’t ignore the current form’s Eloquent record when validating by default. This behavior was enabled by the ignoreRecord: true parameter, or by passing a custom ignorable record.In v4, the unique() method’s ignoreRecord parameter defaults to true.If you were previously using unique() validation rule without the ignoreRecord or ignorable parameters, you should use ignoreRecord: false to disable the new behavior.The all pagination page option is not available for tables by default
all pagination page option is not available for tables by defaultThe Be aware when using
all pagination page method is now not available for tables by default. If you want to use it on a table, you can add it to the configuration:all as it will cause performance issues when dealing with a large number of records.The official Spatie Translatable Plugin is now deprecated
Last year, the Filament team decided to hand over maintenance of the Spatie Translatable Plugin to the team at Lara Zeus, who are trusted developers of many Filament plugins. They’ve maintained a fork of the plugin ever since.The official Spatie Translatable Plugin will not receive v4 support, and is now deprecated. You can use the Lara Zeus Translatable Plugin as a direct replacement. The plugin is compatible with the same version of Spatie Translatable as the official plugin, and has been tested with Filament v4. It also fixes some long-standing bugs in the official plugin.The automated upgrade script suggests commands that uninstall the official plugin and install the Lara Zeus plugin, and replaces any references in your code to the official plugin with the Lara Zeus plugin.
Medium-impact changes
columnSpan() now targets >= lg devices by default
columnSpan() now targets >= lg devices by defaultSimilar to the In v4, the Of course, you can still continue to use an array to define how many columns a component should span at different breakpoints:
columns() method, which accepts a number and affects >= lg devices by default, the columnSpan() method has been changed to do the same. This improves consistency between the APIs, making them easier to use and less prone to causing layout issues.In v3, the following code might have been written. If you used columnSpan(2) instead of columnSpan(['lg' => 2]), the layout would have been a little broken on < lg devices:columnSpan() affects >= lg devices by default, in the same way that columns() does, so the following code is required instead:Enum field state
In v3, fields that wrote to an enum attribute on a model, such as a
Select, CheckboxList or Radio field using options(Enum::class), would inconsistently return the value of the field as either the enum value or the enum instance, depending on whether or not the field was last modified by the server or by the user. This wasn’t useful, and you had to check the type of the value returned by the field to determine if it was an enum value or an enum instance.In v4, the field state is always returned as the enum instance. This means that you can always use the enum methods on field state. If you weren’t handling the possibility of the field state being an enum instance in your code previously, you now need to do so.The following code examples illustrate how field state may now return an enum instance:URL parameter names have changed
Filament v4 has renamed some of the URL parameters that are used on resource pages, to make them cleaner in the URL and easier to remember:
activeRelationManagerhas been renamed torelationon Edit / View resource pages.activeTabhas been renamed totabon List / Manage Relation resource pages.isTableReorderinghas been renamed toreorderingon List / Manage Relation resource pages.tableFiltershas been renamed tofilterson List / Manage Relation resource pages.tableGroupinghas been renamed togroupingon List / Manage Relation resource pages.tableGroupingDirectionhas been renamed togroupingDirectionon List / Manage Relation resource pages.tableSearchhas been renamed tosearchon List / Manage Relation resource pages.tableSorthas been renamed tosorton List / Manage Relation resource pages.
'activeRelationManager' => (etc.) in your code, and looking for areas where you’re using ::getUrl() or another method of generating a URL with a parameter.Automatic tenancy global scoping and association
When using tenancy in v3, Filament only scoped resource queries to the current tenant: to render the resource table, resolve URL parameters, and fetch global search results. There were many situations where other queries in the panel weren’t scoped by default, and the developer had to manually scope them. While this was a documented feature, it created a lot of additional work for developers.In v4, Filament automatically scopes all queries in a panel to the current tenant, and automatically associates new records with the current tenant using model events. This means that you no longer need to manually scope queries or associate new Eloquent records in most cases. There are still some important points to consider, so the documentation has been updated to reflect this.
The Radio inline() method behavior
Radio inline() method behaviorIn v3, the
inline() method put the radio buttons inline with each other, and also inline with the label at the same time. This is inconsistent with other components.In v4, the inline() method now only puts the radio buttons inline with each other, and not with the label. If you want the radio buttons to be inline with the label, you can use the inlineLabel() method as well.If you were previously using inline()->inlineLabel(false) to achieve the v4 behavior, you can now simply use inline().Import and export job retries
In Filament v3, import and export jobs were retries continuously for 24 hours if they failed, with no backoff between tries by default. This caused issues for some users, as there was no backoff period and the jobs could be retried too quickly, causing the queue to be flooded with continuously failing jobs.In v4, they’re retried 3 times with a 60 second backoff between each retry.This behavior can be customized in the importer and exporter classes.
Low-impact changes
The isSeparate parameter of ImageColumn::limitedRemainingText() and ImageEntry::limitedRemainingText() has been removed
isSeparate parameter of ImageColumn::limitedRemainingText() and ImageEntry::limitedRemainingText() has been removedPreviously, users were able to display the number of limited images separately to an image stack using the
isSeparate parameter. Now the parameter has been removed, and if a stack exists, the text will always be stacked on top and not separate. If the images aren’t stacked, the text will be separate.The RichEditor component's disableGrammarly() method has been removed
RichEditor component's disableGrammarly() method has been removedThe
disableGrammarly() method has been removed from the RichEditor component. This method was used to disable the Grammarly browser extension acting on the editor. Since moving the underlying implementation of the editor from Trix to TipTap, we haven’t found a way to disable Grammarly on the editor.Overriding the Field::make(), MorphToSelect::make(), Placeholder::make(), or Builder\Block::make() methods
Field::make(), MorphToSelect::make(), Placeholder::make(), or Builder\Block::make() methodsThe signature for the This is due to the introduction of the If you’re overriding the Ideally, you should avoid overriding the
Field::make(), MorphToSelect::make(), Placeholder::make(), and Builder\Block::make() methods has changed. Any classes that extend the Field, MorphToSelect, Placeholder, or Builder\Block class and override the make() method must update the method signature to match the new signature. The new signature is as follows:getDefaultName() method, that can be overridden to provide a default $name value if one is not specified (null). If you were previously overriding the make() method in order to provide a default $name value, it is advised that you now override the getDefaultName() method instead, to avoid further maintenance burden in the future:make() method to pass default configuration to the object once it is instantiated, please note that it is recommended to instead override the setUp() method, which is called immediately after the object is instantiated:make() method altogether as there are alternatives like setUp(), and doing so causes your code to be brittle if Filament decides to introduce new constructor parameters in the future.Overriding the Entry::make() method
Entry::make() methodThe signature for the This is due to the introduction of the If you’re overriding the Ideally, you should avoid overriding the
Entry::make() method has changed. Any classes that extend the Entry class and override the make() method must update the method signature to match the new signature. The new signature is as follows:getDefaultName() method, that can be overridden to provide a default $name value if one is not specified (null). If you were previously overriding the make() method in order to provide a default $name value, it is advised that you now override the getDefaultName() method instead, to avoid further maintenance burden in the future:make() method to pass default configuration to the object once it is instantiated, please note that it is recommended to instead override the setUp() method, which is called immediately after the object is instantiated:make() method altogether as there are alternatives like setUp(), and doing so causes your code to be brittle if Filament decides to introduce new constructor parameters in the future.Overriding the Column::make() or Constraint::make() methods
Column::make() or Constraint::make() methodsThe signature for the This is due to the introduction of the If you’re overriding the Ideally, you should avoid overriding the
Column::make() and Constraint::make() methods has changed. Any classes that extend the Column or Constraint class and override the make() method must update the method signature to match the new signature. The new signature is as follows:getDefaultName() method, that can be overridden to provide a default $name value if one is not specified (null). If you were previously overriding the make() method in order to provide a default $name value, it is advised that you now override the getDefaultName() method instead, to avoid further maintenance burden in the future:make() method to pass default configuration to the object once it is instantiated, please note that it is recommended to instead override the setUp() method, which is called immediately after the object is instantiated:make() method altogether as there are alternatives like setUp(), and doing so causes your code to be brittle if Filament decides to introduce new constructor parameters in the future.Overriding the ExportColumn::make() or ImportColumn::make() methods
ExportColumn::make() or ImportColumn::make() methodsThe signature for the This is due to the introduction of the If you’re overriding the Ideally, you should avoid overriding the
ExportColumn::make() and ImportColumn::make() methods has changed. Any classes that extend the ExportColumn or ImportColumn class and override the make() method must update the method signature to match the new signature. The new signature is as follows:getDefaultName() method, that can be overridden to provide a default $name value if one is not specified (null). If you were previously overriding the make() method in order to provide a default $name value, it is advised that you now override the getDefaultName() method instead, to avoid further maintenance burden in the future:make() method to pass default configuration to the object once it is instantiated, please note that it is recommended to instead override the setUp() method, which is called immediately after the object is instantiated:make() method altogether as there are alternatives like setUp(), and doing so causes your code to be brittle if Filament decides to introduce new constructor parameters in the future.Authenticating the user inside the import and export jobs
In v3, the
Illuminate\Auth\Events\Login event was fired from the import and export jobs, to set the current user. This is no longer the case in v4: the user is authenticated, but that event is not fired, to avoid running any listeners that should only run for actual user logins.Tables now have default primary key sorting
Filament v4 introduces a new default behavior for tables: they will now automatically have a primary key sort applied to their queries to ensure that records are always returned in a consistent order.If your table doesn’t have a primary key, or you want to disable this behavior, you can do so by using the
defaultKeySort(false) method:Overriding the can*() authorization methods on a Resource, RelationManager or ManageRelatedRecords class
can*() authorization methods on a Resource, RelationManager or ManageRelatedRecords classAlthough these methods, such as
canCreate(), canViewAny() and canDelete() weren’t documented, if you’re overriding those to provide custom authorization logic in v3, you should be aware that they aren’t always called in v4. The authorization logic has been improved to properly support policy response objects, and these methods were too simple as they are just able to return booleans.If you can make the authorization customization inside the policy of the model instead, you should do that. If you need to customize the authorization logic in the resource or relation manager class, you should override the get*AuthorizationResponse() methods instead, such as getCreateAuthorizationResponse(), getViewAnyAuthorizationResponse() and getDeleteAuthorizationResponse(). These methods are called when the authorization logic is executed, and they return a policy response object. If you remove the override for the can*() methods, the get*AuthorizationResponse() methods will be used to determine the authorization response boolean, so you don’t have to maintain the logic twice.European Portuguese translations
The European Portuguese translations have been moved from
pt_PT to pt, which appears to be the more commonly used language code for the language within the Laravel community.Nepalese translations
The Nepalese translations have been moved from
np to ne, which appears to be the more commonly used language code for the language within the Laravel community.Norwegian translations
The Norwegian translations have been moved from
no to nb, which appears to be the more commonly used language code for the language within the Laravel community.Khmer translations
The Khmer translations have been moved from
kh to km, which appears to be the more commonly used language code for the language within the Laravel community.Some deprecated table configuration methods have been removed
Before Filament v3, tables could be configured by overriding methods on the Livewire component class, instead of modifying the
$table configuration object. This was deprecated in v3, and removed in v4. If you were using any of the following methods, you should remove them from your Livewire component class, and use their corresponding $table configuration methods instead:getTableRecordUrlUsing()should be replaced with$table->recordUrl()getTableRecordClassesUsing()should be replaced with$table->recordClasses()getTableRecordActionUsing()should be replaced with$table->recordAction()isTableRecordSelectable()should be replaced with$table->checkIfRecordIsSelectableUsing()