do_shortcode( string $content, bool $ignore_html = false ): string

Searches content for shortcodes and filter shortcodes through their hooks.

Description
Parameters
Return
More Information
Source
Related
- Uses
- Used By
Changelog
User Contributed Notes

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.

Top ↑

Parameters

$content string Required: Content to search for shortcodes.
$ignore_html bool Optional: When true, shortcodes inside HTML elements will be skipped.

Default: false

Top ↑

Return

string Content with shortcodes filtered out.

Top ↑

More Information

If there are no shortcode tags defined, then the content will be returned without any filtering. This might cause issues if a plugin is disabled as its shortcode will still show up in the post or content.

Top ↑

Source

File: wp-includes/shortcodes.php. View all references

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;
}

View on Trac View on GitHub

Top ↑

Uses

Uses
Uses	Description
do_shortcodes_in_html_tags() wp-includes/shortcodes.php	Searches only inside HTML elements for shortcodes and process them.
unescape_invalid_shortcodes() wp-includes/shortcodes.php	Removes placeholders added by do_shortcodes_in_html_tags() .
get_shortcode_regex() wp-includes/shortcodes.php	Retrieves the shortcode regular expression for searching.
has_filter() wp-includes/plugin.php	Checks if any filter has been registered for a hook.
remove_filter() wp-includes/plugin.php	Removes a callback function from a filter hook.
add_filter() wp-includes/plugin.php	Adds a callback function to a filter hook.

Show 1 more use Hide more uses

Top ↑

Used By

Used By
Used By	Description
get_the_block_template_html() wp-includes/block-template.php	Returns the markup for the current template.
apply_shortcodes() wp-includes/shortcodes.php	Searches content for shortcodes and filter shortcodes through their hooks.
wp_ajax_parse_embed() wp-admin/includes/ajax-actions.php	Applies [embed] Ajax handlers to a string.
wp_ajax_parse_media_shortcode() wp-admin/includes/ajax-actions.php
WP_Widget_Text::widget() wp-includes/widgets/class-wp-widget-text.php	Outputs the content for the current Text widget instance.
WP_Embed::run_shortcode() wp-includes/class-wp-embed.php	Processes the [embed] shortcode.
img_caption_shortcode() wp-includes/media.php	Builds the Caption shortcode output.

Show 2 more used by Hide more used by

Top ↑

Changelog

Changelog
Version	Description
2.5.0	Introduced.

Top ↑

User Contributed Notes

Contributed by Codex — 8 years ago

// Use shortcode in a PHP file (outside the post editor).
echo do_shortcode( '[gallery]' );

// In case there is opening and closing shortcode.
echo do_shortcode( '[iscorrect]' . $text_to_be_wrapped_in_shortcode . '[/iscorrect]' );

// Enable the use of shortcodes in text widgets.
add_filter( 'widget_text', 'do_shortcode' );

// Use shortcodes in form like Landing Page Template.
echo do_shortcode( '[contact-form-7 id="91" title="quote"]' );

// Store the short code in a variable.
$var = do_shortcode( '[gallery]' );
echo $var;

Skip to note 2 content

You must log in to vote on the helpfulness of this noteVote results for this note: 41You must log in to vote on the helpfulness of this note

Contributed by pansotdev — 7 years ago
The most common use of the shortcode is the following
```
<?php echo do_shortcode('[name_of_shortcode]'); ?>
```
Log in to add feedback
Skip to note 3 content

You must log in to vote on the helpfulness of this noteVote results for this note: 22You must log in to vote on the helpfulness of this note

Contributed by Ken Dirschl — 7 years ago

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.

Log in to add feedback

Contributed by Ismail — 8 years ago

Example

// Making your custom string parses shortcode
$string = do_shortcode( $string );
// If your string has a custom filter, add its tag name in an applicable add_filter function
add_filter( 'my_string_filter_hook_tag_name', 'do_shortcode' );

Skip to note 5 content

You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this note

Contributed by WP Sites - Brad Dalton — 6 years ago
Hook shortcode in single posts
```
add_action( 'loop_start', 'shortcode_before_entry' );

function shortcode_before_entry() {

    if ( ! is_singular( 'post' )  ) {
		return;
	}

    echo do_shortcode('[your_shortcode_handle]');
	
}
```
Log in to add feedback

Contributed by damianc — 6 years ago

To only allow specific shortcodes in comments:

add_filter('get_comment_text', function ($comment) {
    $finalComment = '';
    $allowed = ['snippet', 'quote'];
    $parts = preg_split('/(\[\/?\w+\])/', $comment, null, PREG_SPLIT_DELIM_CAPTURE);

    for ($i = 0; $i < sizeof($parts); $i++) {
        if (preg_match('/\[\w+\]/', $parts[$i])) {
            $shortcodeName = substr($parts[$i], 1, -1);
            if (in_array($shortcodeName, $allowed)) {
                $finalComment .= do_shortcode($parts[$i] . $parts[$i+1] . $parts[$i+2]);
                echo '++' . $parts[$i] . $parts[$i+1] . $parts[$i+2] . '++' . $i;
                $i += 2;
            } else {
               $finalComment .= $parts[$i];  
            }
        } else {
            $finalComment .= $parts[$i];
        }
    }
    return $finalComment;
});

Contributed by Tuts Insider — 1 year ago

An easy approach to defining and using shortcode.

function wpdocs_custom_shortcode ( $content = null ) {
	
	/*------Declare Variables------*/
	$part_1 = $part_2 = $part_3 = $part_4 = $part_5 = '';

	/*------Starting Portion------*/
	$part_1 .= '<div class="content-wrapper">';
	$part_2 .= '<h3 class="content-heading">Here is a heading</h3>';
	$part_3 .= '<div class="content-output">';

	/*------Ending Portion------*/
	$part_4 .= '</div>';
	$part_5 .= '</div>';
	
	/*------Return------*/
	return $part_1 . $part_2 . $part_3 . do_shortcode( $content ) . $part_4 . $part_5; 
}
/*------Register Shortcode------*/
add_shortcode( 'shortcode_name', 'wpdocs_custom_shortcode' );

Now you can use [shortcode_name]........ your content ........ [/shortcode_name] in your post editor.

Skip to note 8 content

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

Contributed by Alvaro Torres — 5 months ago
Sometimes could be really useful to have a shortcode inside another:
```
function wpdocs_concat_shortcodes() {
    $output = 'My new shortcode';

    // Add the old shortcode to the new one
    return do_shortcode( '[wpdocs_box]' ) . $output;
    
}
add_shortcode( 'wpdocs_both_shortcodes', 'wpdocs_concat_shortcodes' );
```
Log in to add feedback
Skip to note 9 content

You must log in to vote on the helpfulness of this noteVote results for this note: -1You must log in to vote on the helpfulness of this note

Contributed by damianc — 6 years ago
To allow shortcodes in comments:
```
function shortcodify($comment) {
  return do_shortcode($comment);
}

add_filter('comment_text', shortcodify);
add_filter('get_comment_text', shortcodify);
```
Log in to add feedback

You must log in before being able to contribute a note or feedback.

Developer Resources

do_shortcode( string $content, bool $ignore_html = false ): string

Contents

Description

Parameters

Return

More Information

Source

Changelog

User Contributed Notes