Which Function Do You Use To Register Your Own Custom Shortcode In Wordpress?

Shortcodes are a popular feature included in many plugins and themes. Even so, if yous've never built your own shortcodes earlier, yous may accept no thought how to add them to your own WordPress projects.

Thankfully, WordPress' Shortcode API makes it adequately elementary to create your ain shortcodes. Doing this will enable users to take advantage of your plugin or theme's features from any text-based area on their WordPress site. Including shortcodes in your projects is an easy way to build on the functionality you lot've already created, so you get the about bang for your cadet.

In this commodity, we'll talk a bit more about how shortcodes work. Then, we'll show you how uncomplicated information technology can be to plan your own shortcodes for your WordPress site in three steps. Let's get started!

Table of Contents

An Introduction to Shortcodes and the Shortcode API
1. What is a Shortcode?
2. What is the Shortcode API?
3. WordPress Default Shortcodes
4. Custom Shortcodes in WordPress
How to Write Your Own Custom Short Code (in 3 Simple Steps)
Determination

An Introduction to Shortcodes and the Shortcode API

What is a Shortcode?

Shortcodes look like small pieces of text within foursquare brackets, like this: [instance]. Each one represents a unique execution of predefined code, which is triggered on demand. You lot can use them nearly anywhere text can exist added in WordPress.

What is Shortcode API?

The WordPress Shortcode API is a handy tool for developers.

WordPress Default Shortcodes

While most shortcodes are added past themes and plugins, WordPress' cadre does accept a few default shortcodes you tin can use. Some examples of these are sound, gallery, and caption.

For example, when you add together an image with a caption, WordPress generates a particular shortcode:

When you view this on the front end, you'll see an paradigm with a caption:

Custom Shortcodes in WordPress

Fortunately, the Shortcode API makes it relatively simple to create custom shortcodes for your own WordPress projects. This is oftentimes a smart idea because it makes your users' lives easier by enabling them to use circuitous functionality with just a few keystrokes.

How to Write Your Ain Custom Shortcode (In 3 Elementary Steps)

Now that yous understand how shortcodes piece of work, let's learn how to add together WordPress shortcode to your ain theme or plugin! Of grade, what your shortcode does volition exist up to you. In this example, we'll utilize a simple "How-do-you-do world!" function to go you started.

1. Write the Shortcode Function

First, yous'll want to open up a new file in a text editor. Adjacent, write a role with a unique name, which will execute the lawmaking y'all'd like the shortcode to trigger:

function torque_hello_world_shortcode() {    return 'Hullo world!'; }

If nosotros were to use this role ordinarily, it would render Hello world! every bit a string that could be output to HTML. This function tin as well accept custom parameters. For example, if yous desire someone to exist able to make it say Hello Bob! instead, you might add a name parameter. These parameters are called attributes, and they are all handled using a single array predefined every bit $atts past WordPress.

Hither'south an example of how to use the shortcode $atts role to properly handle shortcode attributes in WordPress. You can larn more about how this works for your own needs in the WordPress codex:

part torque_hello_world_shortcode( $atts ) {    $a = shortcode_atts( array(       'name' => 'world'    ), $atts );    return 'Hello ' . $a['name'] . !'; }

This defaults the name attribute to globe if no other name is available. If a name is provided, the function will output that instead. Here's an example of how this would exist executed with a shortcode:

[helloworld] // Outputs "Hello globe!"

[helloworld proper name="Bob"]

// Outputs "Howdy Bob!"

Once you lot're finished, this can be used throughout whatever text-based areas on a WordPress site where the plugin or theme that contains this shortcode is installed.

two. Salve the File and Add It to Your Projection

Once your shortcode is ready, y'all can create a new file within your custom theme or plugin to salvage the function. A descriptive name volition help y'all find this file later on (for example:shortcode-function-hello-world.php).

At present, it'due south time to tell the rest of your project about this new file. If you're working with a theme, you'll want to include it in the functions.php file. If you're edifice a plugin, you can include it in whatsoever file already loaded into the project.

Here is an example how you would load the file into a theme using get_stylesheet_directory(). Exist sure to edit the path to your file to match the folder construction inside your theme:

include( get_stylesheet_directory() . 'path/to/shortcode-office-hello-world.php' );

On the other hand, this is what loading the file into a plugin looks like, using plugin_dir_url(). Again, edit the path to your file to match your plugin's binder construction:

include( plugin_dir_url( __FILE__ ) . 'path/to/shortcode-function-hello-earth.php' );

At this point, your part is now available for use! All that's left is to actively register the shortcode within WordPress.

3. Register the Shortcode

The last step is to annals your new shortcode with the Shortcode API. This is done with the add_shortcode part. It requires two arguments:

The shortcode tag to be used within the text editor
The name of the part handling the execution of the shortcode

Beneath your shortcode function, include this line of code and update information technology to match your ain values:

add_shortcode( 'helloworld', 'torque_hello_world_shortcode' );

The first value will go within square brackets in the text editor. The second volition match the function name you wrote in the previous two steps. Both should exist unique enough so they don't interfere with other shortcodes included by WordPress cadre, themes, or plugins.

Once you're finished, all that's left is to test it out. Log in to the WordPress admin and try adding your shortcode to a post:

Hello world shortcode example in text editor

That'due south all there is to it! Your shortcode can exist equally complicated or unproblematic as yous want – what you decide to build using this ability is up to you! For advanced situations where you lot'd like to tweak the output for unlike situations, it might be worth writing a unique PHP form to handle your new shortcode.

Conclusion

To learn more most shortcodes, check out our postal service nearly vii free shortcode plugins for WordPress. Calculation circuitous functionality to WordPress posts and pages is like shooting fish in a barrel with shortcodes. They are elementary to program and add value to your existing projection past making straightforward content dynamic.

In this commodity, you've learned that information technology only takes three unproblematic steps to create a shortcode: