Laravel Shortcodes
Simple, elegant WordPress-like Shortcodes the Laravel way.
Requirements
The package has been developed and tested to work with the latest versions of PHP and Laravel as well as the following minimum requirements:
- Laravel 6
- PHP 7.2
Installation
Install the package via Composer.
composer require tehwave/laravel-shortcodes
Usage
Laravel Shortcodes
work much like Wordpress' Shortcode API.
use tehwave\Shortcodes\Shortcode;
$compiledContent = Shortcode::compile('[uppercase]Laravel Shortcodes[/uppercase]');
// LARAVEL SHORTCODES
Creating Shortcodes
Run the following command to place a fresh Shortcode
class in your new app/Shortcodes
directory.
php artisan make:shortcode ItalicizeText
Output
Each Shortcode
class contains a handle
method, that you may use to output into the compiling content.
Within the handle
method, you may access the attributes
and body
properties.
Note: All values in the
attributes
array are casted tostring
type when parsed.
<?php
namespace App\Shortcodes;
use tehwave\Shortcodes\Shortcode;
class ItalicizeText extends Shortcode
{
/**
* The code to run when the Shortcode is being compiled.
*
* You may return a string from here, that will then
* be inserted into the content being compiled.
*
* @return string|null
*/
public function handle(): ?string
{
if (isset($this->attributes['escape_html']) && $this->attributes['escape_html'] === 'true')) {
return sprintf('<i>%s</i>', htmlspecialchars($this->body));
}
return sprintf('<i>%s</i>', $this->body);
}
}
Naming
The shortcode's tag is derived from the class name to snake_case.
You may specify a custom tag using the tag
property or by overwriting the getTag
method.
Shortcode tags must be alpha-numeric characters and may include underscores.
<?php
namespace App\Shortcodes;
use tehwave\Shortcodes\Shortcode;
class ItalicizeText extends Shortcode
{
/**
* The tag to match in content.
*
* @var string
*/
protected $tag = 'italics';
}
Compiling Shortcodes
Run a string through the compiler to parse all shortcodes.
use tehwave\Shortcodes\Shortcode;
$compiledContent = Shortcode::compile('[italics escape_html="true"]<b>Hello World</b>[/italics]');
// <i><b>Hello World</b></i>
You may specify a list of instantiated Shortcode
classes to limit what shortcodes are parsed.
use tehwave\Shortcodes\Shortcode;
$shortcodes = collect([
new ItalicizeText,
]);
$compiledContent = Shortcode::compile('[uppercase]Hello World[/uppercase]', $shortcodes);
// [uppercase]Hello World[/uppercase]
Example
I developed Laravel Shortcodes
for use with user provided content on gm48.net.
The content is parsed using a Markdown converter called Parsedown, and because users can't be trusted, the content has to be escaped.
Unfortunately, this escapes the attribute syntax with double quotes, but singular quotes can still be used as well as just omitting any quotes.
Note: Quotes are required for any attribute values that contain whitespace.
Let's take a look at the following content with some basic Row
, Column
and Image
shortcodes.
# Controls:
[row]
[column]
[image align=left src=http://i.imgur.com/6CNoFYx.png alt='Move player character']
[/column]
[column]
[image align=center src=http://i.imgur.com/8nwaVo0.png alt=Jump]
[/column]
[column]
[image align=right src=http://i.imgur.com/QsbkkuZ.png alt='Go down through platforms']
[/column]
[/row]
When running the content through the following code:
$parsedDescription = (new Parsedown())
->setSafeMode(true)
->setUrlsLinked(false)
->text($this->description);
$compiledDescription = Shortcode::compile($parsedDescription);
We can expect to see the following output:
<h1>Controls:</h1>
<p></p>
<div class="container-fluid">
<div class="row">
<div class="col">
<img src="http://i.imgur.com/6CNoFYx.png" class="mr-auto" alt="Move player character">
</div>
<div class="col">
<img src="http://i.imgur.com/8nwaVo0.png" class="mx-auto" alt="Jump">
</div>
<div class="col">
<img src="http://i.imgur.com/QsbkkuZ.png" class="ml-auto" alt="Go down through platforms">
</div>
</div>
</div>
You should still escape any user input within your shortcodes' handle
.
Tests
Run the following command to test the package.
composer test
Security
For any security related issues, send a mail to peterchrjoergensen+shortcodes@gmail.com instead of using the issue tracker.
Changelog
See CHANGELOG for details on what has changed.
Contributions
See CONTRIBUTING for details on how to contribute.
Credits
Inspired by https://github.com/webwizo/laravel-shortcodes and https://github.com/spatie/laravel-blade-x
About
I work as a Web Developer in Denmark on Laravel and WordPress websites.
Follow me @tehwave on Twitter!