optional

statamic/cms

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) !!}

<?php         return [

            'title' => $this->title(),

            'path' => $this->path(),

            'parent_path' => optional($this->parent())->path(),

            'basename' => $this->basename(),

        ];

    }

src/Assets/AssetFolder.php

<?php     protected function searchIndex()

    {

        return optional($this->data->searchIndex())->name();

    }



    protected function assets()

src/Assets/AugmentedAssetContainer.php

<?php     public function avatarFieldUrl()

    {

        return optional($this->avatarFieldValue()->value())->url();

    }

src/Auth/HasAvatar.php

<?php     private function isOnAllowedRoute()

    {

        if (! $route = optional(request()->route())->getName()) {

            return false;

        }

src/Entries/AddSiteColumnToBlueprint.php

<?php     public function orderable()

    {

        return optional($this->structure())->maxDepth() === 1;

    }



    public function sortField($field = null)

src/Entries/Collection.php

<?php         $site = $site ?? $this->sites()->first();



        return optional($mount->in($site))->url();

    }



    public function uri($site = null)

src/Entries/Collection.php

<?php         $site = $site ?? $this->sites()->first();



        return optional($mount->in($site))->uri();

    }



    public function showUrl()

src/Entries/Collection.php

<?php     private function dispatchEntryBlueprintFoundEvent($blueprint, $entry)

    {

        $id = optional($entry)->id() ?? 'null';



        $blink = 'collection-entry-blueprint-'.$this->handle().'-'.$blueprint->handle().'-'.$id;

src/Entries/Collection.php

<?php             'locale' => $this->locale(),

            'origin' => $this->hasOrigin() ? $this->origin()->id() : null,

            'slug' => $this->slug(),

            'date' => optional($this->date())->format('Y-m-d-Hi'),

            'published' => $this->published(),

            'path' => $this->initialPath() ?? $this->path(),

            'data' => $this->data(),

src/Entries/Entry.php

<?php                 tap($structure->in($this->locale()), function ($tree) {


                    $parent = $this->parent();

                    if (optional($parent)->isRoot()) {

                        $parent = null;

                    }

                    $this->page()->pages()->all()->each(function ($child) use ($tree, $parent) {

src/Entries/Entry.php

<?php                         $parent = null;

                    }

                    $this->page()->pages()->all()->each(function ($child) use ($tree, $parent) {

                        $tree->move($child->id(), optional($parent)->id());

                    });

                    $tree->remove($this);

                })->save();

src/Entries/Entry.php

<?php         $this->taxonomize();



        optional(Collection::findByMount($this))->updateEntryUris();



        foreach ($afterSaveCallbacks as $callback) {

            $callback($this);

src/Entries/Entry.php

<?php         return $this

            ->fluentlyGetOrSet('template')

            ->getter(function ($template) {

                return $template ?? optional($this->origin())->template() ?? $this->collection()->template();

            })

            ->args(func_get_args());

    }

src/Entries/Entry.php

<?php         return $this

            ->fluentlyGetOrSet('layout')

            ->getter(function ($layout) {

                return $layout ?? optional($this->origin())->layout() ?? $this->collection()->layout();

            })

            ->args(func_get_args());

    }

src/Entries/Entry.php

<?php     {

        $array = Arr::removeNullValues([

            'id' => $this->id(),

            'origin' => optional($this->origin())->id(),

            'published' => $this->published === false ? false : null,

            'blueprint' => $this->blueprint()->handle(),

        ]);

src/Entries/Entry.php