{"id":169,"date":"2013-11-03T21:01:15","date_gmt":"2013-11-03T21:01:15","guid":{"rendered":"http:\/\/www.webtipblog.com\/?p=169"},"modified":"2013-11-15T21:03:07","modified_gmt":"2013-11-15T21:03:07","slug":"add-shortcode-functionality-wordpress-plugin","status":"publish","type":"post","link":"https:\/\/www.webtipblog.com\/add-shortcode-functionality-wordpress-plugin\/","title":{"rendered":"Add Shortcode Functionality to a WordPress Plugin"},"content":{"rendered":"

The WordPress Shortcode API<\/a> allows you to render template blocks by simply calling the shortcode in a post or page. Template blocks can be a part of a theme or a plugin, but may be included by entering a shortcode for the template when creating a post\/page in wp-admin, allowing users to easily include content.<\/p>\n

Basic Shortcode Usage<\/h3>\n

To create a shortcode, start by creating a function that will return the content you would like to display when the shortcode is used. The function should take one argument, $atts. It is important to note that the function returns the content, it does not print it to the screen. In this example we will display an alert box that says “Attention!” when the shortcode is called.<\/p>\n

\/**\r\n * render alert box\r\n * [js_alert_box]\r\n *\r\n * @author  Joe Sexton <joe@webtipblog.com>\r\n * @param   array $atts\r\n * @return  string\r\n *\/\r\nfunction js_alert_box_function( $atts ) {\r\n\r\n    $output = '<div class=\"alert\">Attention!<\/div>';\r\n\r\n    return $output;\r\n}<\/pre>\n
 <\/p>\n
The next step is to register the shortcode with WordPress so that it can be used. A shortcode looks like this to a user: [shortcode] with the name of the shortcode surrounded in brackets. To register the shortcode WordPress offers the add_shortcode()<\/a> function. The first argument is the name of the shortcode and the second is the callback function. To register the alert box shortcode using add_shortcode() simply add this line to functions.php or your plugin file:<\/p>\n
add_shortcode( 'js_alert_box', 'js_alert_box_function' );<\/pre>\n
 <\/p>\n
There are two ways to call the newly created shortcode. A user can use the shortcode syntax in wp-admin in the post or page editor, to call the alert box it would look like this:<\/p>\n
[js_alert_box]<\/pre>\n
 <\/p>\n
WordPress has a function called do_shortcode()<\/a> which allows you to call the shortcode from a theme file programmatically. To render the alert box using do_shortcode() add this snippet to the theme file:<\/p>\n
<?php echo do_shortcode('[js_alert_box]'); ?><\/pre>\n
 <\/p>\n
Adding [js_alert_box] to a post in wp-admin or using do_shortcode() will render the following element on the page:<\/p>\n
<div class=\"alert\">Attention!<\/div><\/pre>\n
 <\/p>\n
Adding Shortcode Parameters<\/h3>\n
It is possible to add parameters to the shortcode to allow a user to pass some input into the shortcode template. To do so, we can extract the shortcode attributes from the shortcode with shortcode_atts()<\/a>.  For example, let’s allow the user to render the alert box with an optional title and content by adding a few attributes to the shortcode. The js_alert_box_function() will now look like this:<\/p>\n
\/**\r\n * render alert box\r\n * [js_alert_box]\r\n *\r\n * @author  Joe Sexton <joe@webtipblog.com>\r\n * @param   array $atts\r\n * @return  string\r\n *\/\r\nfunction js_alert_box_function( $atts ) {\r\n\r\n    extract( shortcode_atts( array(\r\n        'title'   => null,\r\n        'content' => '',\r\n    ), $atts ) );\r\n\r\n    $output = '<div class=\"alert\">';\r\n    if ( !is_null( $title ) ) {\r\n        $output .= '<h2>'.$title.'<\/h2>';\r\n    }\r\n    $output .= $content.'<\/div>';\r\n\r\n    return $output;\r\n}<\/pre>\n
 <\/p>\n
The shortcode gets registered the same as before with add_shortcode(). The attributes are added to the shortcode very much like they would be added to an HTML element: <\/p>\n
[js_alert_box title=\"Attention\" content=\"Check out this alert box\"]<\/pre>\n
 <\/p>\n
Calling the shortcode with these attributes would render this content on the page:<\/p>\n
<div class=\"alert\">\r\n<h2>Attention<\/h2>\r\nCheck out this alert box\r\n<\/div><\/pre>\n
 <\/p>\n
Adding Shortcode Content<\/h3>\n
Shortcodes can be used like HTML tags to wrap content and pass the content to the shortcode. This allows a user to add more than a few words to the shortcode and use punctuation without escaping. To allow this, add a second argument to the alert box function called $content, which will be the content that is wrapped with the shortcode tags. It might be nice to use this to allow users to add content to the alert box in our example, this is what js_alert_box_function() would look like to add the content:<\/p>\n
\/**\r\n * render alert box\r\n * [js_alert_box]\r\n *\r\n * @author  Joe Sexton <joe@webtipblog.com>\r\n * @param   array $atts\r\n * @param   string $content\r\n * @return  string\r\n *\/\r\nfunction js_alert_box_function( $atts, $content = null ) {\r\n\r\n    extract( shortcode_atts( array(\r\n        'title'   => null,\r\n    ), $atts ) );\r\n\r\n    $output = '<div class=\"alert\">';\r\n    if ( !is_null( $title ) ) {\r\n        $output .= '<h2>'.$title.'<\/h2>';\r\n    }\r\n    $output .= $content.'<\/div>';\r\n\r\n    return $output;\r\n}<\/pre>\n
 <\/p>\n
The shortcode gets registered normally using add_shortcode() and calling the shortcode with content would look like this:<\/p>\n
[js_alert_box title=\"Attention\"]Check out this alert box[\/js_alert_box]<\/pre>\n
 <\/p>\n
This will render the following on the page:<\/p>\n
<div class=\"alert\">\r\n<h2>Attention<\/h2>\r\nCheck out this alert box\r\n<\/div><\/pre>\n
 <\/p>\n
Separate Shortcode Template Files<\/h3>\n
If the shortcode will be returning more than a few lines of HTML it might be a good idea to use a separate template file for the shortcode template. Since the shortcode content is returned and not simply printed we need to do more than just require() the template file. By using output buffering the template file can be added as a separate file and its contents returned instead of printed. To add a separate template file for the alert box shortcode, update js_alert_box_function() to include output buffering:<\/p>\n
\/**\r\n * render alert box\r\n * [js_alert_box]\r\n *\r\n * @author  Joe Sexton <joe@webtipblog.com>\r\n * @param   array $atts\r\n * @param   string $content\r\n * @return  string\r\n *\/\r\nfunction js_alert_box_function( $atts, $content = null ) {\r\n\r\n    extract( shortcode_atts( array(\r\n        'title'   => null,\r\n    ), $atts ) );\r\n\r\n    ob_start();\r\n    require '\/templates\/alert_box_template.php';\r\n    $output = ob_get_contents();\r\n    ob_end_clean();\r\n\r\n    return $output;\r\n}<\/pre>\n
 <\/p>\n
The template file can now be created like any other theme template file using the variables set as shortcode attributes.<\/p>\n
<?php \/\/ \/templates\/alert_box_template.php ?>\r\n\r\n<div class=\"alert\">\r\n\r\n    <?php if ( !is_null( $title ) ) : ?>\r\n        <h2><?php echo $title; ?><\/h2>\r\n    <?php endif; ?>\r\n\r\n    <?php echo $content; ?>\r\n<\/div><\/pre>\n","protected":false},"excerpt":{"rendered":"
The WordPress Shortcode API allows you to render template blocks by simply calling the shortcode in a post or page. Template blocks can be a part of a theme or a plugin, but may be included by entering a shortcode for the template when creating a post\/page in wp-admin, allowing users to easily include content.<\/p>\n","protected":false},"author":1,"featured_media":313,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[2],"tags":[23,10],"_links":{"self":[{"href":"https:\/\/www.webtipblog.com\/wp-json\/wp\/v2\/posts\/169"}],"collection":[{"href":"https:\/\/www.webtipblog.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.webtipblog.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.webtipblog.com\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.webtipblog.com\/wp-json\/wp\/v2\/comments?post=169"}],"version-history":[{"count":6,"href":"https:\/\/www.webtipblog.com\/wp-json\/wp\/v2\/posts\/169\/revisions"}],"predecessor-version":[{"id":314,"href":"https:\/\/www.webtipblog.com\/wp-json\/wp\/v2\/posts\/169\/revisions\/314"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.webtipblog.com\/wp-json\/wp\/v2\/media\/313"}],"wp:attachment":[{"href":"https:\/\/www.webtipblog.com\/wp-json\/wp\/v2\/media?parent=169"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.webtipblog.com\/wp-json\/wp\/v2\/categories?post=169"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.webtipblog.com\/wp-json\/wp\/v2\/tags?post=169"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}