Themosis framework is bundled with a templating engine called Scout. The engine is a fork of the Laravel Blade engine and provides helpers in order to rapidly build your view.
In order to use the Scout engine, all your template/view files should use the .scout.php extension.
Here is an example of a basic view stored inside the resources/views folder:
<!-- View stored in resources/views/welcome.scout.php -->
@extends('layouts.main')
@section('main')
<h1>Hello, {{ $name }}</h1>
@stop
@section('sidebar')
<h3>Latest posts</h3>
<ul>
<li>First post</li>
<li>Second post</li>
</ul>
@stopAnd this view may be returned to the browser like so:
Route::get('home', function()
{
return View::make('welcome', ['name' => 'Julien']);
});In the previous example, we used the @extends syntax. This function allows you to use layouts:
<!-- Layout stored in resources/views/layouts/main.scout.php -->
@include('header')
<div class="container">
@yield('main')
</div>
<div class="sidebar">
@section('sidebar')
<p>Sidebar section from the "main" layout file.</p>
@show
</div>
@include('footer')@include('header')This command can include a view file called header.php or header.scout.php stored inside the root of the resources/views directory.
@include('header', ['title' => 'Documentation'])Add the @overwrite statement when closing your section. This will overwrite the content of the parent section defined inside the layout view.
@extends('layouts.main')
@section('sidebar')
<p>New sidebar content</p>
@overwriteAdd the @parent statement in order to keep the content of the parent section defined in the layout view.
@extends('layouts.main')
@section('sidebar')
@parent
<p>Child sidebar content appended to parent's content</p>
@stopHello {{ $name }}The double curly braces echo the data but do not escape it.
Hello {{{ $name }}}Use three curly braces to escape your data. This command pass your data through the PHP function htmlentities().
By default you could write the following statement:
{{{ isset($name) ? $name : 'Default' }}}Instead of writing a ternary statement, Scout allows you to use the following convenient short-cut:
{{{ $name or 'Default' }}}@if(isset($value))
<p>The value is {{ $value }}.</p>
@elseif(is_array($value))
<p>The value is an array.</p>
@else
<p>Something is wrong, there is no value.</p>
@endifSometimes it is more readable to use @unless syntax instead of @if.
@unless(User::current()->can('edit_posts'))
<p>No editing permission.</p>
@endunlessThe above is the same as:
@if( ! User::current()->can('edit_posts'))
<p>No editing permission.</p>
@endunless<ul>
@for($i = 0; $i < 10; $i++)
<li>Item {{ $i }}</li>
@endfor
</ul>@while(true)
<p>Show it!</p>
@endwhile@foreach($objects as $key => $value)
<p>This {{ $value }} opens that {{ $key }}.</p>
@endforeachThe Scout engine gives you a shortcut to use the WordPress loop.
In place of typing these statements:
<?php
if (have_posts())
{
while(have_posts())
{
the_post();
?>
<h1><?php the_title(); ?></h1>
<div>
<?php the_content(); ?>
</div>
<?php
}
}Simply write this code inside your view:
@loop
<h1>{{ Loop::title() }}</h1>
<div>
{{ Loop::content() }}
</div>
@endloopThe Scout engine also provides a helper to make custom loops:
@query(['post_type' => 'post', 'posts_per_page' => 3])
<h1>{{ Loop::title() }}</h1>
<div>
{{ Loop::content() }}
</div>
@endqueryThe array you pass inside the @query statement is equivalent to the one you pass when using the WP_Query class. Check the WordPress codex to customize your loop query. You can also pass the WP_Query instance to the @query statement.
The
Loopclass used in the examples is a core class to be used only inside the WordPress loop. More informations below.
If you need to display a string that is wrapped in curly braces, you may escape the Scout behavior by prefixing your text with an @ symbol:
@{{ This is not processed by Scout }}{{-- This comment will not be rendered in HTML --}}The Loop helper class provides methods with a simple syntax in order to call WordPress loop functions.
Here is a list of the available methods.
Currently this class only works inside WordPress loop statements. The
Loopmethods always return a result, so use echo statements to output their content.
@loop
$id = Loop::id();
@endloop@loop
<h1>{{ Loop::title() }}</h1>
@endloop@loop
<em>{{ Loop::author() }}</em>
@endloop@loop
<article>{{ Loop::content() }}</article>
@endloop@loop
<aside>{{ Loop::excerpt() }}</aside>
@endloopThis method accepts two arguments:
@loop
{{ Loop::thumbnail('thumbnail') }}
@endloopYou can also pass a $size value (string or array) and $icon boolean value as arguments:
@loop
<img src="{{ Loop::thumbnailUrl('thumbnail') }}">
@endloop@loop
<a href="{{ Loop::link() }}">Read more</a>
@endloop@loop
<ul>
@foreach(Loop::category() as $cat)
<li>{{ $cat->name }}</li>
@endforeach
</ul>
@endloop@loop
<ul>
@foreach(Loop::tags() as $tag)
<li>{{ $tag->name }}</li>
@endforeach
</ul>
@endloopPass the custom taxonomy slug as first argument.
@loop
<ul>
@foreach(Loop::terms('custom-slug') as $term)
<li>{{ $term->name }}</li>
@endforeach
</ul>
@endloopYou can pass a date format string as an argument as well.
@loop
<time>{{ Loop::date() }}</time>
@endloopThe Loop::postClass() method returns the HTML class attribute with WordPress generated class terms. You also have the opportunity to add one or more custom classes to the current post or a defined post.
Loop::postClass($class = '', $post_id = null):
Output the post classes:
@loop
<article {{ Loop::postClass() }}>
<h2>Title</h2>
</article>
@endloopHere is an example of the rendered HTML code with the class attribute:
<article class="post-4 post type-post status-publish hentry">
<h2>Title</h2>
</article>This article closes the "Getting started" guide.
There are many APIs that will help you shape your WordPress administration. Discover those features/API of the framework below:
Made in Belgium