Blade Templates

Blade is the simple, yet powerful templating engine provided with Laravel. Unlike other popular PHP templating engines, Blade does not restrict you from using plain PHP code in your views. All Blade views are compiled into plain PHP code and cached until they are modified, meaning Blade adds essentially zero overhead to your application. Blade view files use the file extension and are typically stored in the resources/views directory.

Template Inheritance

Two of the primary benefits of using Blade are template inheritance and sections. To get started, let's take a look at a simple example. First, we will examine a "master" page layout. Since most web applications maintain the same general layout across various pages, it's convenient to define this layout as a single Blade view:

As you can see, this file contains typical HTML mark-up. However, take note of the @section and @yield directives. The @section directive, as the name implies, defines a section of content, while the @yield directive is used to display the contents of a given section.

Now that we have defined a layout for our application, let's define a child page that inherits the layout.

Extending A Layout

When defining a child page, you may use the Blade @extends directive to specify which layout the child page should "inherit". Views which @extends a Blade layout may inject content into the layout's sections using @section directives. Remember, as seen in the example above, the contents of these sections will be displayed in the layout using @yield:

  1. <!-- Stored in resources/views/child.blade.php -->
  3. @extends('layouts.master')
  5. @section('title', 'Page Title')
  7. @section('sidebar')
  8.     @parent
  10.     <p>This is appended to the master sidebar.</p>
  11. @endsection
  13. @section('content')
  14.     <p>This is my body content.</p>

In this example, the sidebar section is utilizing the @parent directive to append (rather than overwriting) content to the layout's sidebar. The @parent directive will be replaced by the content of the layout when the view is rendered.

Of course, just like plain PHP views, Blade views may be returned from routes using the global view helper function:

  1. Route::get('blade', function () {
  2.     return view('child');
  3. });

You may display data passed to your Blade views by wrapping the variable in "curly" braces. For example, given the following route:

  1. Route::get('greeting', function () {
  2.     return view('welcome', ['name' => 'Samantha']);
  3. });

You may display the contents of the name variable like so:

  1. Hello, {{ $name }}.

Of course, you are not limited to displaying the contents of the variables passed to the view. You may also echo the results of any PHP function. In fact, you can put any PHP code you wish inside of a Blade echo statement:

  1. The current UNIX timestamp is {{ time() }}.

Blade & JavaScript Frameworks

  1. <h1>Laravel</h1>
  3. Hello, @{{ name }}.

In this example, the @ symbol will be removed by Blade; however, {{ name }} expression will remain untouched by the Blade engine, allowing it to instead be rendered by your JavaScript framework.

Echoing Data If It Exists

Sometimes you may wish to echo a variable, but you aren't sure if the variable has been set. We can express this in verbose PHP code like so:

  1. {{ isset($name) ? $name : 'Default' }}

However, instead of writing a ternary statement, Blade provides you with the following convenient short-cut:

In this example, if the $name variable exists, its value will be displayed. However, if it does not exist, the word will be displayed.

Displaying Unescaped Data

By default, Blade {{ }} statements are automatically sent through PHP's htmlentities function to prevent XSS attacks. If you do not want your data to be escaped, you may use the following syntax:

  1. Hello, {!! $name !!}.

Control Structures

In addition to template inheritance and displaying data, Blade also provides convenient short-cuts for common PHP control structures, such as conditional statements and loops. These short-cuts provide a very clean, terse way of working with PHP control structures, while also remaining familiar to their PHP counterparts.

If Statements

You may construct if statements using the @if, @elseif, @else, and @endif directives. These directives function identically to their PHP counterparts:

  1. @if (count($records) === 1)
  2.     I have one record!
  3. @elseif (count($records) > 1)
  4.     I have multiple records!
  5. @else
  6.     I don't have any records!
  7. @endif

For convenience, Blade also provides an @unless directive:

  1. @unless (Auth::check())
  2.     You are not signed in.
  3. @endunless

You may also determine if a given layout section has any content using the @hasSection directive:

  1. <title>
  2.     @hasSection ('title')
  3.         @yield('title') - App Name
  4.     @else
  5.         App Name
  6.     @endif
  7. </title>

Loops

In addition to conditional statements, Blade provides simple directives for working with PHP's supported loop structures. Again, each of these directives functions identically to their PHP counterparts:

  1. @for ($i = 0; $i < 10; $i++)
  2.     The current value is {{ $i }}
  3. @endfor
  5. @foreach ($users as $user)
  6.     <p>This is user {{ $user->id }}</p>
  7. @endforeach
  9. @forelse ($users as $user)
  10.     <li>{{ $user->name }}</li>
  11.     <p>No users</p>
  12. @endforelse
  14. @while (true)
  15.     <p>I'm looping forever.</p>
  16. @endwhile

When using loops you might need to end the loop or skip the current iteration:

  1. @foreach ($users as $user)
  2.     @if ($user->type == 1)
  3.         @continue
  6.     <li>{{ $user->name }}</li>
  8.     @if ($user->number == 5)
  9.         @break
  10.     @endif
  11. @endforeach

You may also include the condition with the directive declaration in one line:

  1. @foreach ($users as $user)
  2.     @continue($user->type == 1)
  4.     <li>{{ $user->name }}</li>
  6.     @break($user->number == 5)
  7. @endforeach

Including Sub-Views

Blade's @include directive, allows you to easily include a Blade view from within an existing view. All variables that are available to the parent view will be made available to the included view:

  1. @include('view.name', ['some' => 'data'])

Rendering Views For Collections

You may combine loops and includes into one line with Blade's @each directive:

  1. @each('view.name', $jobs, 'job')

The first argument is the view partial to render for each element in the array or collection. The second argument is the array or collection you wish to iterate over, while the third argument is the variable name that will be assigned to the current iteration within the view. So, for example, if you are iterating over an array of jobs, typically you will want to access each job as a job variable within your view partial. The key for the current iteration will be available as the key variable within your view partial.

You may also pass a fourth argument to the @each directive. This argument determines the view that will be rendered if the given array is empty.

  1. @each('view.name', $jobs, 'job', 'view.empty')

Comments

Blade also allows you to define comments in your views. However, unlike HTML comments, Blade comments are not included in the HTML returned by your application:

  1. {{-- This comment will not be present in the rendered HTML --}}

Blade also allows you to push to named stacks which can be rendered somewhere else in another view or layout:

  1. @push('scripts')
  2.     <script src="/example.js"></script>
  3. @endpush

You may push to the same stack as many times as needed. To render a stack, use the @stack syntax:

  1. <head>
  2.     <!-- Head Contents -->
  4.     @stack('scripts')
  5. </head>

Service Injection

The @inject directive may be used to retrieve a service from the Laravel . The first argument passed to @inject is the name of the variable the service will be placed into, while the second argument is the class / interface name of the service you wish to resolve:

  1. @inject('metrics', 'App\Services\MetricsService')
  3. <div>
  4.     Monthly Revenue: {{ $metrics->monthlyRevenue() }}.

Blade even allows you to define your own custom directives. You can use the directive method to register a directive. When the Blade compiler encounters the directive, it calls the provided callback with its parameter.

The following example creates a @datetime($var) directive which formats a given $var:

As you can see, Laravel's with helper function was used in this directive. The with helper simply returns the object / value it is given, allowing for convenient method chaining. The final PHP generated by this directive will be:

After updating the logic of a Blade directive, you will need to delete all of the cached Blade views. The cached Blade views may be removed using the view:clear Artisan command.