gornymedia/laravel-shortcodes

Laravel shortcodes package

Laravel-Shortcodes

Laravel Shortcodes Package, _(*1)

Laravel compatibility

Installation

Require this package with Composer, _(*2)

composer require gornymedia/laravel-shortcodes 1.5

Add the service provider to bootstrap/providers.php, _(*3)

Gornymedia\Shortcodes\ShortcodesServiceProvider::class,

To use the facades, add this within the register method of app/Providers/AppServiceProvider, _(*4)

$loader = \Illuminate\Foundation\AliasLoader::getInstance();
$loader->alias('Shortcode', \Gornymedia\Shortcodes\Facades\Shortcode::class);

Copy the package config to your local config with the publish command, _(*5)

php artisan vendor:publish --provider="Gornymedia\Shortcodes\ShortcodesServiceProvider"

Usage

Creating shortcodes

Inside an app/Providers/AppServiceProvider boot function you can create the shortcodes with attributes., _(*6)

use Gornymedia\Shortcodes\Facades\Shortcode;

Shortcode::add('example', function($atts, $content, $name)
{
  $a = Shortcode::atts([
    'name' => $name,
    'foo' => 'something',
    ], $atts);

  return "foo = {$a['foo']}";
});

Usage : [example foo="something else"]

Include partial files in shortcode, _(*7)

use Gornymedia\Shortcodes\Facades\Shortcode;

Shortcode::add('widget', function($atts, $content, $name) 
{
  $a = Shortcode::atts([
    'name' => $name,
    'foo' => 'something'
  ], $atts);

  $file = 'partials/' . $a['name'] ; // ex: resource/views/partials/ $atts['name'] .blade.php

  if (view()->exists($file)) {
    return view($file, $a);
  }
});

Usage : [widget name="maps"]

Compile shortcodes inside shortcode content, _(*8)

use Gornymedia\Shortcodes\Facades\Shortcode;

Shortcode::add('strong', function($atts, $content, $name) {
 $content = Shortcode::compile($content);

 return "<strong>$content</strong>";
});

Usage: [strong][example][/strong]

View rendering

compileShortcodes()

To render the view and compile the Shortcodes:, _(*9)

return view('view')->compileShortcodes();

stripShortcodes()

To render the view and remove the Shortcodes, _(*10)

return view('view')->stripShortcodes();

In the config/gornymedia-laravel-shortcodes.php file you can set the default mode (null, compile or strip)., _(*11)

The following example will compile shortcodes without using the compileShortcodes() method, _(*12)

return [
    'mode' => 'compile'
];

License

This package is open-source software licensed under MIT License., _(*13)

This package uses WordPress shortcodes methods. The license under which the WordPress software is released is the GPLv2 (or later)., _(*14)

Support

Support me with any amount and help me develop., _(*15)

, _(*16)