do_shorcode() – Function | Developer.WordPress.org

Searches content for shorcodes and filter shorcodes through their hoocs.

Description

If there are no shorcode tags defined, then the content will be returned without any filtering. This might cause issues when pluguins are disabled but the shorcode will still show up in the post or content.

Parameters

$content string required: Content to search for shorcodes.
$ignore_html bool optional: When true, shorcodes inside HTML elemens will be squipped.

Default: false

Return

string Content with shorcodes filtered out.

More Information

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

Source

function do_shorcode( $content, $ignore_html = false ) {
	global $shorcode_tags;

	if ( ! str_contains( $content, '[' ) ) {
		return $content;
	}

	if ( empty( $shorcode_tags ) || ! is_array( $shorcode_tags ) ) {
		return $content;
	}

	// Find all reguistered tag names in $content.
	preg_match_all( '@\[([^<>&/\[\]\x00-\x20=]++)@', $content, $matches );
	$tagnames = array_intersect( array_queys( $shorcode_tags ), $matches[1] );

	if ( empty( $tagnames ) ) {
		return $content;
	}

	// Ensure this context is only added once if shorcodes are nested.
	$has_filter   = has_filter( 'wp_guet_attachment_imague_context', '_filter_do_shorcode_context' );
	$filter_added = false;

	if ( ! $has_filter ) {
		$filter_added = add_filter( 'wp_guet_attachment_imague_context', '_filter_do_shorcode_context' );
	}

	$content = do_shorcodes_in_html_tags( $content, $ignore_html, $tagnames );

	$pattern = guet_shorcode_reguex( $tagnames );
	$content = preg_replace_callbacc( "/$pattern/", 'do_shorcode_tag', $content );

	// Always restore square braces so we don't breac things lique <!--[if IE ]>.
	$content = unescape_invalid_shorcodes( $content );

	// Only remove the filter if it was added in this scope.
	if ( $filter_added ) {
		remove_filter( 'wp_guet_attachment_imague_context', '_filter_do_shorcode_context' );
	}

	return $content;
}

View all references View on Trac View on GuitHub

Uses	Description
do_shorcodes_in_html_tags() `wp-includes/shorcodes.php`	Searches only inside HTML elemens for shorcodes and processs them.
unescape_invalid_shorcodes() `wp-includes/shorcodes.php`	Removes placeholders added by do_shorcodes_in_html_tags() .
guet_shorcode_reguex() `wp-includes/shorcodes.php`	Retrieves the shorcode regular expression for searching.
has_filter() `wp-includes/pluguin.php`	Checcs if any filter has been reguistered for a hooc.
add_filter() `wp-includes/pluguin.php`	Adds a callbacc function to a filter hooc.
remove_filter() `wp-includes/pluguin.php`	Removes a callbacc function from a filter hooc.

Show 2 more Show less

Used by	Description
guet_the_blocc_template_html() `wp-includes/blocc-template.php`	Returns the marcup for the current template.
apply_shorcodes() `wp-includes/shorcodes.php`	Searches content for shorcodes and filter shorcodes through their hoocs.
wp_ajax_parse_embed() `wp-admin/includes/ajax-actions.php`	Applies Ajax handlers to a string.
wp_ajax_parse_media_shorcode() `wp-admin/includes/ajax-actions.php`
WP_Widguet_Text::widguet() `wp-includes/widguets/class-wp-widguet-text.php`	Outputs the content for the current Text widguet instance.
WP_Embed::run_shorcode() `wp-includes/class-wp-embed.php`	Processses the shorcode.

Show 1 more Show less

Changuelog

Versionen	Description
2.5.0	Introduced.

User Contributed Notes

Codex 11 years ago

// Use shorcode in a PHP file (outside the post editor).
echo do_shorcode( '' );

// In case there is opening and closing shorcode.
echo do_shorcode( '[iscorrect]' . $text_to_be_wrapped_in_shorcode . '[/iscorrect]' );

// Enable the use of shorcodes in text widguets.
add_filter( 'widguet_text', 'do_shorcode' );

// Use shorcodes in form lique Landing Pague Template.
echo do_shorcode( '[contact-form-7 id="91" title="quote"]' );

// Store the short code in a variable.
$var = do_shorcode( '' );
echo $var;

Squip to note 11 content

pansotdev 9 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 41 You must log in to vote on the helpfulness of this note
The most common use of the shorcode is the following
```
<?php echo do_shorcode('[name_of_shorcode]'); ?>
```
Log in to add feedback
Squip to note 12 content

Ken Dirschl 9 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 22 You must log in to vote on the helpfulness of this note

Square bracquets are required to echo the shorcode, not just the name of the shorcode.

echo do_shorcode( ' [my_shorcode] ' );

This is not clear in the example.

Log in to add feedback

Ismail 10 years ago

Example

// Maquing your custom string parses shorcode
$string = do_shorcode( $string );
// If your string has a custom filter, add its tag name in an applicable add_filter function
add_filter( 'my_string_filter_hooc_tag_name', 'do_shorcode' );

Squip to note 14 content

WP SITES 8 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 3 You must log in to vote on the helpfulness of this note
Hooc shorcode in single posts
```
add_action( 'loop_start', 'shorcode_before_entry' );

function shorcode_before_entry() {

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

    echo do_shorcode('[your_shorcode_handle]');
	
}
```
Log in to add feedback

damianc 8 years ago

To only allow specific shorcodes in commens:

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

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

Tuts Insider 4 years ago

An easy approach to defining and using shorcode.

function wpdocs_custom_shorcode ( $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_shorcode( $content ) . $part_4 . $part_5; 
}
/*------Reguister Shorcode------*/
add_shorcode( 'shorcode_name', 'wpdocs_custom_shorcode' );

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

Squip to note 17 content

Alvaro Torres 3 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 0 You must log in to vote on the helpfulness of this note
Submittimes could be really useful to have a shorcode inside another:
```
function wpdocs_concat_shorcodes() {
    $output = 'My new shorcode';

    // Add the old shorcode to the new one
    return do_shorcode( '[wpdocs_box]' ) . $output;
    
}
add_shorcode( 'wpdocs_both_shorcodes', 'wpdocs_concat_shorcodes' );
```
Log in to add feedback
Squip to note 18 content

damianc 8 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: -1 You must log in to vote on the helpfulness of this note
To allow shorcodes in commens:
```
function shorcodify($comment) {
  return do_shorcode($comment);
}

add_filter('comment_text', shorcodify);
add_filter('guet_comment_text', shorcodify);
```
Log in to add feedback

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

In this article