Shortcodes: Add the `pre_do_shortcode_tag` filter.
This filter allows the shortcode generation process to be short-circuited, so expensive short codes can be cached and returned immediately. Props ideag. Fixes #37906. git-svn-id: https://develop.svn.wordpress.org/trunk@38506 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
parent
74cee3d59c
commit
6d59b289a9
|
@ -321,6 +321,24 @@ function do_shortcode_tag( $m ) {
|
||||||
return $m[0];
|
return $m[0];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Filters whether to call a shortcode callback.
|
||||||
|
*
|
||||||
|
* Passing a truthy value to the filter will effectively short-circuit the
|
||||||
|
* shortcode generation process, returning that value instead.
|
||||||
|
*
|
||||||
|
* @since 4.7.0
|
||||||
|
*
|
||||||
|
* @param bool|string $return 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,
|
||||||
|
* @param array $m Regular expression match array.
|
||||||
|
*/
|
||||||
|
$return = apply_filters( 'pre_do_shortcode_tag', false, $tag, $attr, $m );
|
||||||
|
if ( false !== $return ) {
|
||||||
|
return $return;
|
||||||
|
}
|
||||||
|
|
||||||
if ( isset( $m[5] ) ) {
|
if ( isset( $m[5] ) ) {
|
||||||
// enclosing tag - extra parameter
|
// enclosing tag - extra parameter
|
||||||
return $m[1] . call_user_func( $shortcode_tags[$tag], $attr, $m[5], $tag ) . $m[6];
|
return $m[1] . call_user_func( $shortcode_tags[$tag], $attr, $m[5], $tag ) . $m[6];
|
||||||
|
|
|
@ -676,4 +676,71 @@ EOF;
|
||||||
$expected = "<img alt=\"Hello :-) World\" />\n";
|
$expected = "<img alt=\"Hello :-) World\" />\n";
|
||||||
$this->assertEquals( $expected, $out );
|
$this->assertEquals( $expected, $out );
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @ticket 37906
|
||||||
|
*/
|
||||||
|
public function test_pre_do_shortcode_tag() {
|
||||||
|
// does nothing if no filters are set up
|
||||||
|
$str = 'pre_do_shortcode_tag';
|
||||||
|
add_shortcode( $str, array( $this, '_shortcode_pre_do_shortcode_tag' ) );
|
||||||
|
$result_nofilter = do_shortcode( "[{$str}]" );
|
||||||
|
$this->assertSame( 'foo', $result_nofilter );
|
||||||
|
|
||||||
|
// short-circuit with filter
|
||||||
|
add_filter( 'pre_do_shortcode_tag', array( $this, '_filter_pre_do_shortcode_tag_bar' ) );
|
||||||
|
$result_filter = do_shortcode( "[{$str}]" );
|
||||||
|
$this->assertSame( 'bar', $result_filter );
|
||||||
|
|
||||||
|
// respect priority
|
||||||
|
add_filter( 'pre_do_shortcode_tag', array( $this, '_filter_pre_do_shortcode_tag_p11' ), 11 );
|
||||||
|
$result_priority = do_shortcode( "[{$str}]" );
|
||||||
|
$this->assertSame( 'p11', $result_priority );
|
||||||
|
|
||||||
|
// pass arguments
|
||||||
|
$arr = array(
|
||||||
|
'return' => 'p11',
|
||||||
|
'key' => $str,
|
||||||
|
'atts' => array( 'a'=>'b', 'c'=>'d' ),
|
||||||
|
'm' => array(
|
||||||
|
"[{$str} a='b' c='d']",
|
||||||
|
"",
|
||||||
|
$str,
|
||||||
|
" a='b' c='d'",
|
||||||
|
"",
|
||||||
|
"",
|
||||||
|
"",
|
||||||
|
),
|
||||||
|
);
|
||||||
|
add_filter( 'pre_do_shortcode_tag', array( $this, '_filter_pre_do_shortcode_tag_attr' ), 12, 4 );
|
||||||
|
$result_atts = do_shortcode( "[{$str} a='b' c='d']" );
|
||||||
|
$this->assertSame( wp_json_encode( $arr ), $result_atts );
|
||||||
|
|
||||||
|
remove_filter( 'pre_do_shortcode_tag', array( $this, '_filter_pre_do_shortcode_tag_attr' ), 12, 4 );
|
||||||
|
remove_filter( 'pre_do_shortcode_tag', array( $this, '_filter_pre_do_shortcode_tag_p11' ), 11 );
|
||||||
|
remove_filter( 'pre_do_shortcode_tag', array( $this, '_filter_pre_do_shortcode_tag_bar' ) );
|
||||||
|
remove_shortcode( $str, array( $this, '_shortcode_pre_do_shortcode_tag' ) );
|
||||||
|
}
|
||||||
|
|
||||||
|
public function _shortcode_pre_do_shortcode_tag( $atts = array(), $content = '' ) {
|
||||||
|
return 'foo';
|
||||||
|
}
|
||||||
|
|
||||||
|
public function _filter_pre_do_shortcode_tag_bar() {
|
||||||
|
return 'bar';
|
||||||
|
}
|
||||||
|
|
||||||
|
public function _filter_pre_do_shortcode_tag_p11() {
|
||||||
|
return 'p11';
|
||||||
|
}
|
||||||
|
|
||||||
|
public function _filter_pre_do_shortcode_tag_attr( $return, $key, $atts, $m ){
|
||||||
|
$arr = array(
|
||||||
|
'return' => $return,
|
||||||
|
'key' => $key,
|
||||||
|
'atts' => $atts,
|
||||||
|
'm' => $m,
|
||||||
|
);
|
||||||
|
return wp_json_encode( $arr );
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue