drinky78/shortcode-bundle

Bundle that provides a Twig filter to support WordPress-like shortcodes.

Bundle that provides a Twig filter to support WordPress-like shortcodes., _(*1)

Important: It's an early prototype!, _(*2)

Currently supported are tags of this form: * [demo] (simple tags) * [demo var=xxx var2=yyy] (tags with unquoted attributes), _(*3)

Not yet supported are: * [demo]...[/demo] (tags with embedded content) * [demo var="xxx"] (tags with quoted attributes), _(*4)

Installation

Add ShortcodeBundle in your composer.json:, _(*5)

{
    "require": {
        "drinky78/shortcode-bundle": "dev-master"
    }
}

Register the bundle in AppKernel, _(*6)

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new MW\Bundle\ShortcodeBundle\MWShortcodeBundle(),
    );
}

How to use:

1. Create a new shortcode handler

``` php <?php, <sub>(*7)</sub>

MyProject\Bundle\TestBundle\Shortcode\DemoShortcode.php

namespace MyProject\Bundle\TestBundle\Shortcode;, <sub>(*8)</sub>

use MW\Bundle\ShortcodeBundle\Shortcode\BaseShortcode;, <sub>(*9)</sub>

class DemoShortcode extends BaseShortcode {, <sub>(*10)</sub>

public function parse($options)
{
    // TODO: Render your content
    return 'Shortcode content';
}

}, <sub>(*11)</sub>

###2. Define the shortcode as a service (the alias will be the name of your shortcode):

``` xml
<service id="myproject.shortcode.demo" class="MyProject\Bundle\TestBundle\Shortcode\DemoShortcode">
    <tag name="mw.shortcode" alias="demo" />
</service>

YML example, <sub>(*12)</sub>

parameters:
    myproject.shortcode.demo: MyProject\Bundle\TestBundle\Shortcode\DemoShortcode

services:
    myproject.shortcode.demo:
        class: %myproject.shortcode.demo%
        tags:
            - { name: mw.shortcode, alias: demo }

3. Use it in your Twig templates

html <div>{{ page.content|shortcodes }}</div>, <sub>(*13)</sub>