Shortcake (Shortcode UI) Richtext

FAQ

Installation Instructions

You need the latest version of of [Shortcake (Shortcode UI)] installed and activated.

1. Upload the plugin files to the /wp-content/plugins/shortcode-ui-richtext directory.
2. Activate the plugin through the ‘Plugins’ screen in WordPress
3. Add the meta class option to the textarea input type of an existing shortcake register_for_shortcode call.
4. Due to the possibility of the user entered content to contain special characters like [, ] and « , it is highly recommended to turn on the encode flag as well.
   php
'encode' => true,
'meta' => array(
'class' => 'shortcake-richtext',
),

How does an example rich textarea input element shortcake register code looks like?

This is a default shortcode with a single textarea:

`php

shortcode_ui_register_for_shortcode( ‘shortcode_name’,
array(
‘label’ => esc_html__( ‘Shortcode Name’, ‘namespace’ ),
‘listItemImage’ => ‘dashicons-text’,
‘attrs’ => array(
array(
‘label’ => esc_html__( ‘Text Element’, ‘namespace’ ),
‘attr’ => ‘text_element’,
‘type’ => ‘textarea’,
),
),
)
);
`

This is the same code with the richtext capability added in on the text_element:

`php

shortcode_ui_register_for_shortcode( ‘shortcode_name’,
array(
‘label’ => esc_html__( ‘Shortcode Name’, ‘namespace’ ),
‘listItemImage’ => ‘dashicons-text’,
‘attrs’ => array(
array(
‘label’ => esc_html__( ‘Text Element’, ‘namespace’ ),
‘attr’ => ‘text_element’,
‘type’ => ‘textarea’,
‘encode’ => true,
‘meta’ => array(
‘class’ => ‘shortcake-richtext’,
),
),
),
)
);
`

Outputting requires decoding, and since Shortcake uses url encoding, the attribute powered by the rich text editor needs to be urldecoded before rendering its contents, like in the following example using the urldecode function:

`php

function shortcode_name( $atts ) {
extract( shortcode_atts(
array(
‘text_element’ =>  »,
),
$atts
));
return ‘

‘ . urldecode( $text_element ) . ‘

‘;
}
`

This doesn’t work although I added the class according to the instructions. Am I missing anything?

Before submitting a report on the GitHub Issue tracker, please ensure the issue you are experiencing does not exist with using the latest Shortcake (Shortcode UI) version downloaded from their own GitHub repository.