[ Index ]

PHP Cross Reference of BackPress

title

Body

[close]

/includes/ -> functions.shortcodes.php (summary)

WordPress API for creating bbcode like tags or what WordPress calls "shortcodes." The tag and attribute parsing or regular expression code is based on the Textpattern tag parser. A few examples are below:

File Size: 296 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 9 functions

  add_shortcode()
  remove_shortcode()
  remove_all_shortcodes()
  do_shortcode()
  get_shortcode_regex()
  do_shortcode_tag()
  shortcode_parse_atts()
  shortcode_atts()
  strip_shortcodes()

Functions
Functions that are not part of a class:

add_shortcode($tag, $func)   X-Ref
Add hook for shortcode tag.

There can only be one hook for each shortcode. Which means that if another
plugin has a similar shortcode, it will override yours or yours will override
theirs depending on which order the plugins are included and/or ran.

Simplest example of a shortcode tag using the API:

<code>
// [footag foo="bar"]
function footag_func($atts) {
return "foo = {$atts[foo]}";
}
add_shortcode('footag', 'footag_func');
</code>

Example with nice attribute defaults:

<code>
// [bartag foo="bar"]
function bartag_func($atts) {
extract(shortcode_atts(array(
'foo' => 'no foo',
'baz' => 'default baz',
), $atts));

return "foo = {$foo}";
}
add_shortcode('bartag', 'bartag_func');
</code>

Example with enclosed content:

<code>
// [baztag]content[/baztag]
function baztag_func($atts, $content='') {
return "content = $content";
}
add_shortcode('baztag', 'baztag_func');
</code>

since: 2.5
param: string $tag Shortcode tag to be searched in post content.
param: callable $func Hook to run when shortcode is found.

remove_shortcode($tag)   X-Ref
Removes hook for shortcode.

since: 2.5
param: string $tag shortcode tag to remove hook for.

remove_all_shortcodes()   X-Ref
Clear all shortcodes.

This function is simple, it clears all of the shortcode tags by replacing the
shortcodes global by a empty array. This is actually a very efficient method
for removing all shortcodes.

since: 2.5

do_shortcode($content)   X-Ref
Search content for shortcodes and filter shortcodes through their hooks.

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.

since: 2.5
param: string $content Content to search for shortcodes
return: string Content with shortcodes filtered out.

get_shortcode_regex()   X-Ref
Retrieve the shortcode regular expression for searching.

The regular expression combines the shortcode tags in the regular expression
in a regex class.

The regular expresion contains 6 different sub matches to help with parsing.

1/6 - An extra [ or ] to allow for escaping shortcodes with double [[]]
2 - The shortcode name
3 - The shortcode argument list
4 - The self closing /
5 - The content of a shortcode when it wraps some content.

since: 2.5
return: string The shortcode search regular expression

do_shortcode_tag($m)   X-Ref
Regular Expression callable for do_shortcode() for calling shortcode hook.

since: 2.5
param: array $m Regular expression match array
return: mixed False on failure.

shortcode_parse_atts($text)   X-Ref
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.

since: 2.5
param: string $text
return: array List of attributes and their value.

shortcode_atts($pairs, $atts)   X-Ref
Combine user attributes with known attributes and fill in defaults when needed.

The pairs should be considered to be all of the attributes which are
supported by the caller and given as a list. The returned attributes will
only contain the attributes in the $pairs list.

If the $atts list has unsupported attributes, then they will be ignored and
removed from the final returned list.

since: 2.5
param: array $pairs Entire list of supported attributes and their defaults.
param: array $atts User defined attributes in shortcode tag.
return: array Combined and filtered attribute list.

strip_shortcodes( $content )   X-Ref
Remove all shortcode tags from the given content.

since: 2.5
param: string $content Content to remove shortcode tags.
return: string Content without shortcode tags.



Generated: Wed Dec 19 01:01:51 2018 Cross-referenced by PHPXref 0.7.1