Upgrade Guide

High Impact Changes

Medium Impact Changes

Upgrading To 9.0 From 8.x

Estimated Upgrade Time: 30 Minutes

{tip} We attempt to document every possible breaking change. Since some of these breaking changes are in obscure parts of the framework only a portion of these changes may actually affect your application. Want to save time? You can use Laravel Shift to help automate your application upgrades.

Updating Dependencies

Likelihood Of Impact: High

PHP 8.0.2 Required

Laravel now requires PHP 8.0.2 or greater.

Composer Dependencies

You should update the following dependencies in your application’s composer.json file:

  • laravel/framework to ^9.0
  • nunomaduro/collision to ^6.0

In addition, please replace facade/ignition with "spatie/laravel-ignition": "^1.0" in your application’s composer.json file.

Furthermore, the following first-party packages have received new major releases to support Laravel 9.x. If applicable, you should read their individual upgrade guides before upgrading:

Finally, examine any other third-party packages consumed by your application and verify you are using the proper version for Laravel 9 support.

PHP Return Types

PHP is beginning to transition to requiring return type definitions on PHP methods such as offsetGet, offsetSet, etc. In light of this, Laravel 9 has implemented these return types in its code base. Typically, this should not affect user written code; however, if you are overriding one of these methods by extending Laravel’s core classes, you will need to add these return types to your own application or package code:

  • count(): int
  • getIterator(): Traversable
  • getSize(): int
  • jsonSerialize(): array
  • offsetExists($key): bool
  • offsetGet($key): mixed
  • offsetSet($key, $value): void
  • offsetUnset($key): void

In addition, return types were added to methods implementing PHP’s SessionHandlerInterface. Again, it is unlikely that this change affects your own application or package code:

  • open($savePath, $sessionName): bool
  • close(): bool
  • read($sessionId): string|false
  • write($sessionId, $data): bool
  • destroy($sessionId): bool
  • gc($lifetime): int

Application

The Application Contract

Likelihood Of Impact: Low

The storagePath method of the Illuminate\Contracts\Foundation\Application interface has been updated to accept a $path argument. If you are implementing this interface you should update your implementation accordingly:

  1. public function storagePath($path = '');

Exception Handler ignore Method

Likelihood Of Impact: Low

The exception handler’s ignore method is now public instead of protected. This method is not included in the default application skeleton; however, if you have manually defined this method you should update its visibility to public:

  1. public function ignore(string $class);

Blade

Lazy Collections & The $loop Variable

Likelihood Of Impact: Low

When iterating over a LazyCollection instance within a Blade template, the $loop variable is no longer available, as accessing this variable causes the entire LazyCollection to be loaded into memory, thus rendering the usage of lazy collections pointless in this scenario.

Collections

The Enumerable Contract

Likelihood Of Impact: Low

The Illuminate\Support\Enumerable contract now defines a sole method. If you are manually implementing this interface, you should update your implementation to reflect this new method:

  1. public function sole($key = null, $operator = null, $value = null);

The reduceWithKeys Method

The reduceWithKeys method has been removed as the reduce method provides the same functionality. You may simply update your code to call reduce instead of reduceWithKeys.

The reduceMany Method

The reduceMany method has been renamed to reduceSpread for naming consistency with other similar methods.

Container

The Container Contract

Likelihood Of Impact: Very Low

The Illuminate\Contracts\Container\Container contract has received two method definitions: scoped and scopedIf. If you are manually implementing this contract, you should update your implementation to reflect these new methods.

The ContextualBindingBuilder Contract

Likelihood Of Impact: Very Low

The Illuminate\Contracts\Container\ContextualBindingBuilder contract now defines a giveConfig method. If you are manually implementing this interface, you should update your implementation to reflect this new method:

  1. public function giveConfig($key, $default = null);

Database

Postgres “Schema” Configuration

Likelihood Of Impact: Medium

The schema configuration option used to configure Postgres connection search paths in your application’s config/database.php configuration file should be renamed to search_path.

Schema Builder registerCustomDoctrineType Method

Likelihood Of Impact: Low

The registerCustomDoctrineType method has been removed from the Illuminate\Database\Schema\Builder class. You may use the registerDoctrineType method on the DB facade instead, or register custom Doctrine types in the config/database.php configuration file.

Eloquent

Custom Casts & null

Likelihood Of Impact: Medium

In previous releases of Laravel, the set method of custom cast classes was not invoked if the cast attribute was being set to null. However, this behavior was inconsistent with the Laravel documentation. In Laravel 9.x, the set method of the cast class will be invoked with null as the provided $value argument. Therefore, you should ensure your custom casts are able to sufficiently handle this scenario:

  1. /**
  2.  * Prepare the given value for storage.
  3.  *
  4.  * @param  \Illuminate\Database\Eloquent\Model  $model
  5.  * @param  string  $key
  6.  * @param  AddressModel  $value
  7.  * @param  array  $attributes
  8.  * @return array
  9.  */
  10. public function set($model, $key, $value, $attributes)
  11. {
  12.     if (! $value instanceof AddressModel) {
  13.         throw new InvalidArgumentException('The given value is not an Address instance.');
  14.     }
  16.     return [
  17.         'address_line_one' => $value->lineOne,
  18.         'address_line_two' => $value->lineTwo,
  19.     ];
  20. }

Belongs To Many firstOrNew, firstOrCreate, and updateOrCreate Methods

Likelihood Of Impact: Medium

The belongsToMany relationship’s firstOrNew, firstOrCreate, and updateOrCreate methods all accept an array of attributes as their first argument. In previous releases of Laravel, this array of attributes was compared against the “pivot” / intermediate table for existing records.

However, this behavior was unexpected and typically unwanted. Instead, these methods now compare the array of attributes against the table of the related model:

  1. $user->roles()->updateOrCreate([
  2.     'name' => 'Administrator',
  3. ]);

In addition, the firstOrCreate method now accepts a $values array as its second argument. This array will be merged with the first argument to the method ($attributes) when creating the related model if one does not already exist. This changes makes this method consistent with the firstOrCreate methods offered by other relationship types:

  1. $user->roles()->firstOrCreate([
  2.     'name' => 'Administrator',
  3. ], [
  4.     'created_by' => $user->id,
  5. ]);

The touch Method

Likelihood Of Impact: Low

The touch method now accepts an attribute to touch. If you were previously overwriting this method, you should update your method signature to reflect this new argument:

  1. public function touch($attribute = null);

Encryption

The Encrypter Contract

Likelihood Of Impact: Low

The Illuminate\Contracts\Encryption\Encrypter contract now defines a getKey method. If you are manually implementing this interface, you should update your implementation accordingly:

  1. public function getKey();

Facades

The getFacadeAccessor Method

Likelihood Of Impact: Low

The getFacadeAccessor method must always return a container binding key. In previous releases of Laravel, this method could return an object instance; however, this behavior is no longer supported. If you have written your own facades, you should ensure that this method returns a container binding string:

  1. /**
  2.  * Get the registered name of the component.
  3.  *
  4.  * @return string
  5.  */
  6. protected static function getFacadeAccessor()
  7. {
  8.     return Example::class;
  9. }

Filesystem

The FILESYSTEM_DRIVER Environment Variable

Likelihood Of Impact: Low

The FILESYSTEM_DRIVER environment variable has been renamed to FILESYSTEM_DISK to more accurately reflect its usage. This change only affects the application skeleton; however, you are welcome to update your own application’s environment variables to reflect this change if you wish.

The “Cloud” Disk

Likelihood Of Impact: Low

The cloud disk configuration option was removed from the default application skeleton in November of 2020. This change only affects the application skeleton. If you are using the cloud disk within your application, you should leave this configuration value in your own application’s skeleton.

Flysystem 3.x

Likelihood Of Impact: High

Laravel 9.x has migrated from Flysystem 1.x to 3.x. Under the hood, Flysystem powers all of the file manipulation methods provided by the Storage facade. In light of this, some changes may be required within your application; however, we have tried to make this transition as seamless as possible.

Driver Prerequisites

Before using the S3 or SFTP drivers, you will need to install the appropriate package via the Composer package manager:

  • Amazon S3: composer require --with-all-dependencies league/flysystem-aws-s3-v3 "^3.0"
  • SFTP: composer require league/flysystem-sftp-v3 "^3.0"

Overwriting Existing Files

Write operations such as put, write, writeStream now overwrite existing files by default. If you do not want to overwrite existing files, you should manually check for the file’s existence before performing the write operation.

Reading Missing Files

Attempting to read from a file that does not exist now returns null. In previous releases of Laravel, an Illuminate\Contracts\Filesystem\FileNotFoundException would have been thrown.

Deleting Missing Files

Attempting to delete a file that does not exist now returns true.

Cached Adapters

Flysystem no longer supports “cached adapters”. Thus, they have been removed from Laravel and any relevant configuration (such as the cache key within disk configurations) can be removed.

Custom Filesystems

Slight changes have been made to the steps required to register custom filesystem drivers. Therefore, if you were defining your own custom filesystem drivers, or using packages that define custom drivers, you should update your code and dependencies.

For example, in Laravel 8.x, a custom filesystem driver might be registered like so:

  1. use Illuminate\Support\Facades\Storage;
  2. use League\Flysystem\Filesystem;
  3. use Spatie\Dropbox\Client as DropboxClient;
  4. use Spatie\FlysystemDropbox\DropboxAdapter;
  6. Storage::extend('dropbox', function ($app, $config) {
  7.     $client = new DropboxClient(
  8.         $config['authorization_token']
  9.     );
  11.     return new Filesystem(new DropboxAdapter($client));
  12. });

However, in Laravel 9.x, the callback given to the Storage::extend method should return an instance of Illuminate\Filesystem\FilesystemAdapter directly:

  1. use Illuminate\Filesystem\FilesystemAdapter;
  2. use Illuminate\Support\Facades\Storage;
  3. use League\Flysystem\Filesystem;
  4. use Spatie\Dropbox\Client as DropboxClient;
  5. use Spatie\FlysystemDropbox\DropboxAdapter;
  7. Storage::extend('dropbox', function ($app, $config) {
  8.     $adapter = new DropboxAdapter(new DropboxClient(
  9.         $config['authorization_token']
  10.     ););
  12.     return new FilesystemAdapter(
  13.         new Filesystem($adapter, $config),
  14.         $adapter,
  15.         $config
  16.     );
  17. });

Helpers

The data_get Helper & Iterable Objects

Likelihood Of Impact: Very Low

Previously, the data_get helper could be used to retrieve nested data on arrays and Collection instances; however, this helper can now retrieve nested data on all iterable objects.

The str Helper

Likelihood Of Impact: Very Low

Laravel 9.x now includes a global str helper function. If you are defining a global str helper in your application, you should rename or remove it so that it does not conflict with Laravel’s own str helper.

The when / unless Methods

Likelihood Of Impact: Medium

As you may know, when and unless methods are offered by various classes throughout the framework. These methods can be used to conditionally perform an action if the boolean value of the first argument to the method evaluates to true or false:

  1. $collection->when(true, function ($collection) {
  2.     $collection->merge([1, 2, 3]);
  3. });

Therefore, in previous releases of Laravel, passing a closure to the when or unless methods meant that the conditional operation would always execute, since a loose comparison against a closure object (or any other object) always evaluates to true. This often led to unexpected outcomes because developers expect the result of the closure to be used as the boolean value that determines if the conditional action executes.

So, in Laravel 9.x, any closures passed to the when or unless methods will be executed and the value returned by the closure will be considered the boolean value used by the when and unless methods:

  1. $collection->when(function ($collection) {
  2.     // This closure is executed...
  3.     return false;
  4. }, function ($collection) {
  5.     // Not executed since first closure returned "false"...
  6.     $collection->merge([1, 2, 3]);
  7. });

HTTP Client

Default Timeout

Likelihood Of Impact: Medium

The HTTP client now has a default timeout of 30 seconds. In other words, if the server does not respond within 30 seconds, an exception will be thrown. Previously, no default timeout length was configured on the HTTP client, causing requests to sometimes “hang” indefinitely.

If you wish to specify a longer timeout for a given request, you may do so using the timeout method:

  1. $response = Http::timeout(120)->get(...);

HTTP Fake & Middleware

Likelihood Of Impact: Low

Previously, Laravel would not execute any provided Guzzle HTTP middleware when the HTTP client was “faked”. However, in Laravel 9.x, Guzzle HTTP middleware will be executed even when the HTTP client is faked.

HTTP Fake & Dependency Injection

Likelihood Of Impact: Low

In previous releases of Laravel, invoking the Http::fake() method would not affect instances of the Illuminate\Http\Client\Factory that were injected into class constructors. However, in Laravel 9.x, Http::fake() will ensure fake responses are returned by HTTP clients injected into other services via dependency injection. This behavior is more consistent with the behavior of other facades and fakes.

Symfony Mailer

Likelihood Of Impact: High

One of the largest changes in Laravel 9.x is the transition from SwiftMailer, which is no longer maintained as of December 2021, to Symfony Mailer. However, we have tried to make this transition as seamless as possible for your applications. That being said, please thoroughly review the list of changes below to ensure your application is fully compatible.

Driver Prerequisites

To continue using the Mailgun transport, your application should require the symfony/mailgun-mailer Composer package:

  1. composer require symfony/mailgun-mailer

The wildbit/swiftmailer-postmark Composer package should be removed from your application. Instead, your application should require the symfony/postmark-mailer Composer package:

  1. composer require symfony/postmark-mailer

Updated Return Types

The send, html, text, and plain methods no longer return the number of recipients that received the message. Instead, an instance of Illuminate\Mail\SentMessage is returned. This object contains an instance of Symfony\Component\Mailer\SentMessage that is accessible via the getSymfonySentMessage method or by dynamically invoking methods on the object.

Renamed “Swift” Methods

Various SwiftMailer related methods, some of which were undocumented, have been renamed to their Symfony Mailer counterparts. For example, the withSwiftMessage method has been renamed to withSymfonyMessage:

  1. // Laravel 8.x...
  2. $this->withSwiftMessage(function ($message) {
  3.     $message->getHeaders()->addTextHeader(
  4.         'Custom-Header', 'Header Value'
  5.     );
  6. });
  8. // Laravel 9.x...
  9. use Symfony\Component\Mime\Email;
  11. $this->withSymfonyMessage(function (Email $message) {
  12.     $message->getHeaders()->addTextHeader(
  13.         'Custom-Header', 'Header Value'
  14.     );
  15. });

{note} Please thoroughly review the Symfony Mailer documentation for all possible interactions with the Symfony\Component\Mime\Email object.

The list below contains a more thorough overview of renamed methods. Many of these methods are low-level methods used to interact with SwiftMailer / Symfony Mailer directly, so may not be commonly used within most Laravel applications:

  1. Message::getSwiftMessage();
  2. Message::getSymfonyMessage();
  4. Mailable::withSwiftMessage($callback);
  5. Mailable::withSymfonyMessage($callback);
  7. MailMessage::withSwiftMessage($callback);
  8. MailMessage::withSymfonyMessage($callback);
  10. Mailer::getSwiftMailer();
  11. Mailer::getSymfonyTransport();
  13. Mailer::setSwiftMailer($swift);
  14. Mailer::setSymfonyTransport(TransportInterface $transport);
  16. MailManager::createTransport($config);
  17. MailManager::createSymfonyTransport($config);

Proxied Illuminate\Mail\Message Methods

The Illuminate\Mail\Message typically proxied missing methods to the underlying Swift_Message instance. However, missing methods are now proxied to an instance of Symfony\Component\Mime\Email instead. So, any code that was previously relying on missing methods to be proxied to SwiftMailer should be updated to their corresponding Symfony Mailer counterparts.

Again, many applications may not be interacting with these methods, as they are not documented within the Laravel documentation:

  1. // Laravel 8.x...
  2. $message
  3.     ->setFrom('taylor@laravel.com')
  4.     ->setTo('example@example.org')
  5.     ->setSubject('Order Shipped')
  6.     ->setBody('<h1>HTML</h1>', 'text/html')
  7.     ->addPart('Plain Text', 'text/plain');
  9. // Laravel 9.x...
  10. $message
  11.     ->from('taylor@laravel.com')
  12.     ->to('example@example.org')
  13.     ->subject('Order Shipped')
  14.     ->html('<h1>HTML</h1>')
  15.     ->text('Plain Text');

Generated Messages IDs

SwiftMailer offered the ability to define a custom domain to include in generated Message IDs via the mime.idgenerator.idright configuration option. This is not supported by Symfony Mailer. Instead, Symfony Mailer will automatically generate a Message ID based on the sender.

Forced Reconnections

It is no longer possible to force a transport reconnection (for example when the mailer is running via a daemon process). Instead, Symfony Mailer will attempt to reconnect to the transport automatically and throw an exception if the reconnection fails.

SMTP Stream Options

Defining stream options for the SMTP transport is no longer supported. Instead, you must define the relevant options directly within the configuration if they are supported. For example, to disable TLS peer verification:

  1. 'smtp' => [
  2.     // Laravel 8.x...
  3.     'stream' => [
  4.         'ssl' => [
  5.             'verify_peer' => false,
  6.         ],
  7.     ],
  9.     // Laravel 9.x...
  10.     'verify_peer' => false,
  11. ],

To learn more about the available configuration options, please review the Symfony Mailer documentation.

{note} In spite of the example above, you are not generally advised to disable SSL verification since it introduces the possibility of “man-in-the-middle” attacks.

SMTP auth_mode

Defining the SMTP auth_mode in the mail configuration file is no longer required. The authentication mode will be automatically negotiated between Symfony Mailer and the SMTP server.

Failed Recipients

It is no longer possible to retrieve a list of failed recipients after sending a message. Instead, a Symfony\Component\Mailer\Exception\TransportExceptionInterface exception will be thrown if a message fails to send. Instead of relying on retrieving invalid email addresses after sending a message, we recommend that you validate email addresses before sending the message instead.

Packages

The lang Directory

Likelihood Of Impact: Medium

In new Laravel applications, the resources/lang directory is now located in the root project directory (lang). If your package is publishing language files to this directory, you should ensure that your package is publishing to app()->langPath() instead of a hard-coded path.

Queue

The opis/closure Library

Likelihood Of Impact: Low

Laravel’s dependency on opis/closure has been replaced by laravel/serializable-closure. This should not cause any breaking change in your application unless you are interacting with the opis/closure library directly. In addition, the previously deprecated Illuminate\Queue\SerializableClosureFactory and Illuminate\Queue\SerializableClosure classes have been removed. If you are interacting with opis/closure library directly or using any of the removed classes, you may use Laravel Serializable Closure instead.

The Failed Job Provider flush Method

Likelihood Of Impact: Low

The flush method defined by the Illuminate\Queue\Failed\FailedJobProviderInterface interface now accepts an $hours argument which determines how old a failed job must be (in hours) before it is flushed by the queue:flush command. If you are manually implementing the FailedJobProviderInterface you should ensure that your implementation is updated to reflect this new argument:

  1. public function flush($hours = null);

Session

The getSession Method

Likelihood Of Impact: Low

The Symfony\Component\HttpFoundaton\Request class that is extended by Laravel’s own Illuminate\Http\Request class offers a getSession method to get the current session storage handler. This method is not documented by Laravel as most Laravel applications interact with the session through Laravel’s own session method.

The getSession method previously returned an instance of Illuminate\Session\Store or null; however, due to the Symfony 6.x release enforcing a return type of Symfony\Component\HttpFoundation\Session\SessionInterface, the getSession now correctly returns a SessionInterface implementation or throws an \Symfony\Component\HttpFoundation\Exception\SessionNotFoundException exception when no session is available.

Testing

The assertDeleted Method

Likelihood Of Impact: Medium

All calls to the assertDeleted method should be updated to assertModelMissing.

Trusted Proxies

Likelihood Of Impact: Low

If you are upgrading your Laravel 8 project to Laravel 9 by importing your existing application code into a totally new Laravel 9 application skeleton, you may need to update your application’s “trusted proxy” middleware.

Within your app/Http/Middleware/TrustProxies.php file, update use Fideloper\Proxy\TrustProxies as Middleware to use Illuminate\Http\Middleware\TrustProxies as Middleware.

Next, within app/Http/Middleware/TrustProxies.php, you should update the $headers property definition:

  1. // Before...
  2. protected $headers = Request::HEADER_X_FORWARDED_ALL;
  4. // After...
  5. protected $headers =
  6.     Request::HEADER_X_FORWARDED_FOR |
  7.     Request::HEADER_X_FORWARDED_HOST |
  8.     Request::HEADER_X_FORWARDED_PORT |
  9.     Request::HEADER_X_FORWARDED_PROTO |
  10.     Request::HEADER_X_FORWARDED_AWS_ELB;

Validation

Form Request validated Method

Likelihood Of Impact: Low

The validated method offered by form requests now accepts $key and $default arguments. If you are manually overwriting the definition of this method, you should update your method’s signature to reflect these new arguments:

  1. public function validated($key = null, $default = null)

The password Rule

Likelihood Of Impact: Medium

The password rule, which validates that the given input value matches the authenticated user’s current password, has been renamed to current_password.

Unvalidated Array Keys

Likelihood Of Impact: Medium

In previous releases of Laravel, you were required to manually instruct Laravel’s validator to exclude unvalidated array keys from the “validated” data it returns, especially in combination with an array rule that does not specify a list of allowed keys.

However, in Laravel 9.x, unvalidated array keys are always excluded from the “validated” data even when no allowed keys have been specified via the array rule. Typically, this behavior is the most expected behavior and the previous excludeUnvalidatedArrayKeys method was only added to Laravel 8.x as a temporary measure in order to preserve backwards compatibility.

Although it is not recommended, you may opt-in to the previous Laravel 8.x behavior by invoking a new includeUnvalidatedArrayKeys method within the boot method of one of your application’s service providers:

  1. use Illuminate\Support\Facades\Validator;
  3. /**
  4.  * Register any application services.
  5.  *
  6.  * @return void
  7.  */
  8. public function boot()
  9. {
  10.     Validator::includeUnvalidatedArrayKeys();
  11. }

Miscellaneous

We also encourage you to view the changes in the laravel/laravel GitHub repository. While many of these changes are not required, you may wish to keep these files in sync with your application. Some of these changes will be covered in this upgrade guide, but others, such as changes to configuration files or comments, will not be. You can easily view the changes with the GitHub comparison tool and choose which updates are important to you.