Shortcode

Add a shortcode

Using function add_shortcode:

add_shortcode(string $key, string $name, $string description, callable $callback_function)
  • $callback_function: (callable) (Required) Callback function which will run when rendering shortcode. See example bellow.

Example:

add_shortcode('my-block', 'My block', 'Custom block for me', 'add_custom_block_shortcode');

Add callback function for shortcode. Example:

function add_custom_block_shortcode() {
    return 'This is my custom block';
    // or 
    return view('view-for-my-block')->render(); 
}

If you don't want to create more function callback, you can do like this.

add_shortcode('my-block', 'My block', 'Custom block for me', function() {
    return 'This is my custom block';
    // or 
    return view('view-for-my-block')->render(); 
});

{note} You can add this function to your-theme/functions/functions.php or in function boot of your plugin service provider.

Display shortcode in a theme

By default, shortcode just can be shown on /views/index.blade.php, page.blade.php and post.blade.php

You can find this in your-theme/config.php

$theme->composer(['index', 'page', 'post'], function(View $view) {
    $view->withShortcodes();
});

So you can add short code to page or post content then shortcode should be displayed on page or post.

If you want to show shortcode in other pages, please add them to theme view composer.

Or you can render shortcode by manually. Using function do_short_code.

do_shortcode(string $content)
  • $content: (string) (Required) Content to search for shortcodes. (string) (Required) The name of the shortcode hook.

Example:

{!! do_shortcode('[my-block][/my-block]') !!}

{warning} If there are no shortcode tags defined, then the content will be returned without any filtering. This might cause issues when plugins are disabled but the shortcode will still show up in the post or content.

Generate shortcode

To generate shortcode tag for a shortcode.

echo generate_shortcode('my-block');

You can add param 2 to function generate_shortcode, it's attributes of shortcode.

Example:

echo generate_shortcode('my-block', ['foo' => 'bar', 'abc' => 'xyz']);