This website uses cookies so that we can provide you with the best user experience possible. Cookie information is stored in your browser and performs functions such as recognising you when you return to our website and helping our team to understand which sections of the website you find most interesting and useful.
do_shortcode_tag filter
Filters the output created by a shortcode callback.
To use the do_shortcode_tag filter, first you have to register it using add_filter. You can write this code into functions.php of your activated theme or in a custom WordPress Plugin.
We at WePlugins, always prefer to create a custom WordPress Plugin while using hooks so nothing breaks when you update your WordPress Theme in the future.
In the below live example, we have defined a function weplugins_modify_do_shortcode_tag_defaults which takes 4 parameters and we registered using add_filter. The first parameter do_shortcode_tag is the name of the hook, The second parameter weplugins_modify_do_shortcode_tag_defaults is the name of the function which needs to be called, the third parameter is the priority of calling the hook if the same hook is used multiple times and the last parameter is the number of arguments (if any) to be passed in the registered function.
Sometimes, you have to remove a registered hook so you can use remove_filter to remove do_shortcode_tag filter.
Parameters
- $output: (string) Shortcode output.
- $tag: (string) Shortcode name.
- $attr: (array|string) Shortcode attributes array or empty string.
- $m: (array) Regular expression match array.
Below are the 4 parameters required to use this hook.
Live Example 1: Adding a Script to Shortcode Output
In this example, we add a script to the output of a specific shortcode.
add_filter( 'do_shortcode_tag', 'weplugins_enqueue_my_script', 10, 3 ); function weplugins_enqueue_my_script( $output, $tag, $attr ) { if ( 'aShortcode' != $tag ) { // make sure it is the right shortcode return $output; } if ( !isset( $attr['id'] ) ) { // you can even check for specific attributes return $output; } $output .= '<script> ... </script>'; return $output; }
Live Example 2: Modifying Shortcode Output
Below is an example of how you can use this hook to modify the shortcode output.
function weplugins_modify_do_shortcode_tag_defaults( $output, $tag, $attr, $m ) { // Update the $output variable according to your website requirements and return this variable. // You can modify the $output variable conditionally too if you want. return $output; } // add the filter add_filter( "do_shortcode_tag", "weplugins_modify_do_shortcode_tag_defaults", 10, 4 );
Live Example 3: Removing a Hook Callback
To remove a hook callback, use the example below.
remove_filter( "do_shortcode_tag", "weplugins_modify_do_shortcode_tag_defaults", 10, 4 );
Please make sure to provide the same callback function name, priority, and number of arguments while removing the hook callback.
Contact Us
If you’re having any trouble using this hook or need some customization, please contact our WordPress Development Team and we’d be happy to assist you.
Explore the latest in WordPress
Trying to stay on top of it all? Get the best tools, resources and inspiration sent to your inbox every Wednesday.