Searches content for shortcodes and filter shortcodes through their hooks.
Description
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.
Parameters
$content
stringrequired- Content to search for shortcodes.
$ignore_html
booloptional- When true, shortcodes inside HTML elements will be skipped.
Default:
false
Source
function do_shortcode( $content, $ignore_html = false ) {
global $shortcode_tags;
if ( ! str_contains( $content, '[' ) ) {
return $content;
}
if ( empty( $shortcode_tags ) || ! is_array( $shortcode_tags ) ) {
return $content;
}
// Find all registered tag names in $content.
preg_match_all( '@\[([^<>&/\[\]\x00-\x20=]++)@', $content, $matches );
$tagnames = array_intersect( array_keys( $shortcode_tags ), $matches[1] );
if ( empty( $tagnames ) ) {
return $content;
}
// Ensure this context is only added once if shortcodes are nested.
$has_filter = has_filter( 'wp_get_attachment_image_context', '_filter_do_shortcode_context' );
$filter_added = false;
if ( ! $has_filter ) {
$filter_added = add_filter( 'wp_get_attachment_image_context', '_filter_do_shortcode_context' );
}
$content = do_shortcodes_in_html_tags( $content, $ignore_html, $tagnames );
$pattern = get_shortcode_regex( $tagnames );
$content = preg_replace_callback( "/$pattern/", 'do_shortcode_tag', $content );
// Always restore square braces so we don't break things like <!--[if IE ]>.
$content = unescape_invalid_shortcodes( $content );
// Only remove the filter if it was added in this scope.
if ( $filter_added ) {
remove_filter( 'wp_get_attachment_image_context', '_filter_do_shortcode_context' );
}
return $content;
}
Changelog
Version | Description |
---|---|
2.5.0 | Introduced. |
The most common use of the shortcode is the following
Square brackets are required to echo the shortcode, not just the name of the shortcode.
echo do_shortcode( ' [my_shortcode] ' );
This is not clear in the example.
Example
Hook shortcode in single posts
To only allow specific shortcodes in comments:
An easy approach to defining and using shortcode.
Now you can use
[shortcode_name]........ your content ........ [/shortcode_name]
in your post editor.Sometimes could be really useful to have a shortcode inside another:
To allow shortcodes in comments: