wppaste
WordPress

apply_filters( 'pre_do_shortcode_tag', false|string $output, string $tag, array $attr, array $m )

Since
4.7.0, 6.5.0
Filters whether to call a shortcode callback.

Description

Returning a non-false value from filter will short-circuit the shortcode generation process, returning that value instead.

Compatibility

WordPress
since 6.5.0
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0).

Parameters

$outputfalse|string
Short-circuit return value. Either false or the value to replace the shortcode with.
$tagstring
Shortcode name.
$attrarray
Shortcode attributes array, can be empty if the original arguments string cannot be parsed.
$marray
Regular expression match array.

Where this hook fires · 1

  • wp-includes/shortcodes.php:427do_shortcode_tag()

Source code

	 *	 * @param false|string $output Short-circuit return value. Either false or the value to replace the shortcode with.	 * @param string       $tag    Shortcode name.	 * @param array        $attr   Shortcode attributes array, can be empty if the original arguments string cannot be parsed.	 * @param array        $m      Regular expression match array.	 */	$return = apply_filters( 'pre_do_shortcode_tag', false, $tag, $attr, $m );	if ( false !== $return ) {		return $return;	} 	$content = $m[5] ?? null;

Changelog

Introduced in 4.7.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

6.5.0
The $attr parameter is always an array.from the docblock
4.7.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.