webwizo / laravel-shortcodes
Wordpress like shortcodes for Laravel 5, 6, 7, 8, 9, 10, 11 and 12
Installs: 592 530
Dependents: 5
Suggesters: 0
Security: 0
Stars: 217
Watchers: 8
Forks: 52
Open Issues: 16
Requires
- php: ^7.2|^8.0|^8.1|^8.2
- illuminate/contracts: 5.6.x|5.7.x|5.8.x|^6.0|^7.0|^8.0|^9.0|^10.0|^11.0|^12.0
- illuminate/support: 5.6.x|5.7.x|5.8.x|^6.0|^7.0|^8.0|^9.0|^10.0|^11.0|^12.0
- illuminate/view: 5.6.x|5.7.x|5.8.x|^6.0|^7.0|^8.0|^9.0|^10.0|^11.0|^12.0
Requires (Dev)
- orchestra/testbench: ~3.9.0|^4.0|^5.0|^6.0|^7.0|^8.0|^10.0
- phpunit/phpunit: ^8.0|^9.0|^11.5.3
- scrutinizer/ocular: ^1.5
- squizlabs/php_codesniffer: ~2.3|^3.7
README
WordPress like shortcodes for Laravel 5.x
[b class="bold"]Bold text[/b] [tabs] [tab]Tab 1[/tab] [tab]Tab 2[/tab] [/tabs] [user id="1" display="name"]
If you are looking for Laravel 4.2, see: https://github.com/patrickbrouwers/Laravel-Shortcodes
Install
Via Composer
$ composer require "webwizo/laravel-shortcodes:1.0.*"
After updating composer, add the ServiceProvider to the providers array in config/app.php
Usage
Webwizo\Shortcodes\ShortcodesServiceProvider::class,
You can use the facade for shorter code. Add this to your aliases:
'Shortcode' => Webwizo\Shortcodes\Facades\Shortcode::class,
The class is bound to the ioC as shortcode
$shortcode = app('shortcode');
Usage
withShortcodes()
To enable the view compiling features:
return view('view')->withShortcodes();
This will enable shortcode rendering for that view only.
Enable through class
Shortcode::enable();
Disable through class
Shortcode::disable();
Disabling some views from shortcode compiling
With the config set to true, you can disable the compiling per view.
return view('view')->withoutShortcodes();
Default compiling
To use default compiling:
Shortcode::compile($contents);
Strip shortcodes from rendered view.
return view('view')->withStripShortcodes();
Strip shortcode through class
Shortcode::strip($contents);
Registering new shortcodes
Create a new ServiceProvider where you can register all the shortcodes.
php artisan make:provider ShortcodesServiceProvider
After defining shortcodes, add the ServiceProvider to the providers array in config/app.php
Usage
App\Providers\ShortcodesServiceProvider::class,
Callback
Shortcodes can be registered within ShortcodesServiceProvider with a callback:
php artisan make:provider ShortcodesServiceProvider
ShortcodesServiceProvider.php Class File
<?php namespace App\Providers; use App\Shortcodes\BoldShortcode; use Illuminate\Support\ServiceProvider; use Shortcode; class ShortcodesServiceProvider extends ServiceProvider { /** * Bootstrap the application services. * * @return void */ public function boot() { // } /** * Register the application services. * * @return void */ public function register() { Shortcode::register('b', BoldShortcode::class); Shortcode::register('i', 'App\Shortcodes\ItalicShortcode@custom'); } }
Default class for BoldShortcode
You can store each shortcode within their class app/Shortcodes/BoldShortcode.php
namespace App\Shortcodes; class BoldShortcode { public function register($shortcode, $content, $compiler, $name, $viewData) { return sprintf('<strong class="%s">%s</strong>', $shortcode->class, $content); } }
Class with custom method
You can store each shortcode within their class app/Shortcodes/ItalicShortcode.php
namespace App\Shortcodes; class ItalicShortcode { public function custom($shortcode, $content, $compiler, $name, $viewData) { return sprintf('<i class="%s">%s</i>', $shortcode->class, $content); } }
Register helpers
If you only want to show the html attribute when the attribute is provided in the shortcode, you can use $shortcode->get($attributeKey, $fallbackValue = null)
class BoldShortcode { public function register($shortcode, $content, $compiler, $name, $viewData) { return '<strong '. $shortcode->get('class', 'default') .'>' . $content . '</strong>'; } }
Shortcode Artisan Generator Command
This package provides an Artisan command to quickly generate shortcode classes:
php artisan make:shortcode YourShortcodeName
- By default, this creates a new class in
app/Shortcodes/YourShortcodeNameShortcode.php
. - If the file already exists, use the
--force
option to overwrite:
php artisan make:shortcode YourShortcodeName --force
Customizing the Stub
You can publish the stub file to customize the generated class:
php artisan vendor:publish --tag=shortcode-stubs
This will copy the stub to resources/stubs/shortcode.stub
in your Laravel app. Edit this file to change the template for new shortcode classes.
Testing
To run the tests for the shortcode generator command:
composer test
Change log
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING and CONDUCT for details.
Security
If you discover any security related issues, please email webwizo@gmail.com instead of using the issue tracker.
Credits
Support me
License
The MIT License (MIT). Please see License File for more information.