optional

The optional function accepts any argument and allows you to access properties or call methods on that object. If the given object is null, properties and methods will return null instead of causing an error:
<?php return optional($user->address)->street;

{!! old('name', optional($user)->name) !!}
Logo laravel/framework laravel/framework 
<?php     protected function getCurrentOwner()

    {

        return optional($this->connection->table($this->table)->where('key', $this->name)->first())->owner;

    }
src/Illuminate/Cache/DatabaseLock.php
Logo laravel/framework laravel/framework 
<?php         $this->cachedRoot = null;

        $this->cachedScheme = null;



        tap(optional($this->routeGenerator)->defaultParameters ?: [], function ($defaults) {

            $this->routeGenerator = null;



            if (! empty($defaults)) {
src/Illuminate/Routing/UrlGenerator.php
Logo laravel/framework laravel/framework 
<?php     public function testOptional()

    {

        $this->assertNull(optional(null)->something());



        $this->assertEquals(10, optional(new class

        {
tests/Support/SupportHelpersTest.php
Logo laravel/framework laravel/framework 
<?php     {

        $this->assertNull(optional(null)->something());



        $this->assertEquals(10, optional(new class

        {

            public function something()

            {

                return 10;

            }

        })->something());

    }



    public function testOptionalWithCallback()
tests/Support/SupportHelpersTest.php
Logo laravel/framework laravel/framework 
<?php     public function testOptionalWithCallback()

    {

        $this->assertNull(optional(null, function () {

            throw new RuntimeException(

                'The optional callback should not be called for null'

            );

        }));



        $this->assertEquals(10, optional(5, function ($number) {

            return $number * 2;
tests/Support/SupportHelpersTest.php
Logo laravel/framework laravel/framework 
<?php             );

        }));



        $this->assertEquals(10, optional(5, function ($number) {

            return $number * 2;

        }));

    }



    public function testOptionalWithArray()
tests/Support/SupportHelpersTest.php
Logo laravel/framework laravel/framework 
<?php     public function testOptionalWithArray()

    {

        $this->assertSame('here', optional(['present' => 'here'])['present']);

        $this->assertNull(optional(null)['missing']);

        $this->assertNull(optional(['present' => 'here'])->missing);

    }
tests/Support/SupportHelpersTest.php
Logo laravel/framework laravel/framework 
<?php     public function testOptionalWithArray()

    {

        $this->assertSame('here', optional(['present' => 'here'])['present']);

        $this->assertNull(optional(null)['missing']);

        $this->assertNull(optional(['present' => 'here'])->missing);

    }
tests/Support/SupportHelpersTest.php
Logo laravel/framework laravel/framework 
<?php     {

        $this->assertSame('here', optional(['present' => 'here'])['present']);

        $this->assertNull(optional(null)['missing']);

        $this->assertNull(optional(['present' => 'here'])->missing);

    }



    public function testOptionalReturnsObjectPropertyOrNull()
tests/Support/SupportHelpersTest.php
Logo laravel/framework laravel/framework 
<?php     public function testOptionalReturnsObjectPropertyOrNull()

    {

        $this->assertSame('bar', optional((object) ['foo' => 'bar'])->foo);

        $this->assertNull(optional(['foo' => 'bar'])->foo);

        $this->assertNull(optional((object) ['foo' => 'bar'])->bar);

    }
tests/Support/SupportHelpersTest.php
Logo laravel/framework laravel/framework 
<?php     public function testOptionalReturnsObjectPropertyOrNull()

    {

        $this->assertSame('bar', optional((object) ['foo' => 'bar'])->foo);

        $this->assertNull(optional(['foo' => 'bar'])->foo);

        $this->assertNull(optional((object) ['foo' => 'bar'])->bar);

    }
tests/Support/SupportHelpersTest.php
Logo laravel/framework laravel/framework 
<?php     {

        $this->assertSame('bar', optional((object) ['foo' => 'bar'])->foo);

        $this->assertNull(optional(['foo' => 'bar'])->foo);

        $this->assertNull(optional((object) ['foo' => 'bar'])->bar);

    }



    public function testOptionalDeterminesWhetherKeyIsSet()
tests/Support/SupportHelpersTest.php
Logo laravel/framework laravel/framework 
<?php     public function testOptionalDeterminesWhetherKeyIsSet()

    {

        $this->assertTrue(isset(optional(['foo' => 'bar'])['foo']));

        $this->assertFalse(isset(optional(['foo' => 'bar'])['bar']));

        $this->assertFalse(isset(optional()['bar']));

    }
tests/Support/SupportHelpersTest.php
Logo laravel/framework laravel/framework 
<?php     public function testOptionalDeterminesWhetherKeyIsSet()

    {

        $this->assertTrue(isset(optional(['foo' => 'bar'])['foo']));

        $this->assertFalse(isset(optional(['foo' => 'bar'])['bar']));

        $this->assertFalse(isset(optional()['bar']));

    }
tests/Support/SupportHelpersTest.php
Logo laravel/framework laravel/framework 
<?php     {

        $this->assertTrue(isset(optional(['foo' => 'bar'])['foo']));

        $this->assertFalse(isset(optional(['foo' => 'bar'])['bar']));

        $this->assertFalse(isset(optional()['bar']));

    }



    public function testOptionalAllowsToSetKey()
tests/Support/SupportHelpersTest.php