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

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.


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 ( false === strpos( $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;
	}

	$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 );

	return $content;
}


Top ↑

Changelog

Changelog
Version Description
2.5.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    Contributed by Codex
    // 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;
  2. Skip to note 6 content
    Contributed by damianc

    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;
    });
  3. Skip to note 7 content
    Contributed by Tuts Insider

    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.

  4. Skip to note 8 content
    Contributed by Alvaro Torres

    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' );

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