shortcode_parse_atts()
Retrieve all attributes from the shortcodes tag.
The attributes list has the attribute name as the key and the value of the attribute as the value in the key/value pair. This allows for easier retrieval of the attributes, since all attributes have to be known.
1 time — 0.000195 sec (fast) | 50000 times — 0.07 sec (speed of light)
No Hooks.
Return
Array|String
. List of attribute values. Returns empty array if '""' === trim( $text ). Returns empty string if '' === trim( $text ). All other matches are checked for not empty().
Usage
shortcode_parse_atts( $text );
- $text(string) (required)
- -
Examples
#1 Demo
$res = shortcode_parse_atts( ' module="WP" bar="" foo=\'bar\' baz bax=' ); print_r( $res ); /* Array [module] => WP [bar] => [foo] => bar [0] => baz [1] => bax= */
#2 Cut and break down the shortcode parameters
An example of how you can cut a shortcode parameter string and parse it into separate key=value
$str = <<<'STR' Content [five_element name="big badaboom" ident="multipassport" foo='bar'] More Content STR; // for this check, the shortcode must be registered in WP, see: add_shortcode() if( ! has_shortcode( $str, 'five_element' ) ){ echo 'Shortcode not found'; } preg_match( '~\[five_element(.+)\]~s', $str, $mm ); $res = shortcode_parse_atts( $mm[1] ); print_r( $res ); /* Array ( [name] => big badaboom [ident] => multipassport [foo] => bar ) */
Changelog
Since 2.5.0 | Introduced. |