| [ Index ] |
PHP Cross Reference of WordPress |
[Source view] [Print] [Project Stats]
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: | 684 lines (21 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| add_shortcode( $tag, $callback ) X-Ref |
| Adds a new shortcode. Care should be taken through prefixing or other means to ensure that the shortcode tag being added is unique and will not conflict with other, already-added shortcode tags. In the event of a duplicated tag, the tag loaded last will take precedence. param: string $tag Shortcode tag to be searched in post content. param: callable $callback The callback function to run when the shortcode is found. since: 2.5.0 |
| remove_shortcode( $tag ) X-Ref |
| Removes hook for shortcode. param: string $tag Shortcode tag to remove hook for. since: 2.5.0 |
| 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.0 |
| shortcode_exists( $tag ) X-Ref |
| Whether a registered shortcode exists named $tag return: bool Whether the given shortcode exists. param: string $tag Shortcode tag to check. since: 3.6.0 |
| has_shortcode( $content, $tag ) X-Ref |
| Whether the passed content contains the specified shortcode return: bool Whether the passed content contains the given shortcode. param: string $content Content to search for shortcodes. param: string $tag Shortcode tag to check. since: 3.6.0 |
| apply_shortcodes( $content, $ignore_html = false ) X-Ref |
| Search content for shortcodes and filter shortcodes through their hooks. This function is an alias for do_shortcode(). return: string Content with shortcodes filtered out. param: string $content Content to search for shortcodes. param: bool $ignore_html When true, shortcodes inside HTML elements will be skipped. since: 5.4.0 |
| do_shortcode( $content, $ignore_html = false ) 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. return: string Content with shortcodes filtered out. param: string $content Content to search for shortcodes. param: bool $ignore_html When true, shortcodes inside HTML elements will be skipped. since: 2.5.0 |
| get_shortcode_regex( $tagnames = null ) 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 expression contains 6 different sub matches to help with parsing. 1 - An extra [ 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. 6 - An extra ] to allow for escaping shortcodes with double [[]] return: string The shortcode search regular expression param: array $tagnames Optional. List of shortcodes to find. Defaults to all registered shortcodes. since: 2.5.0 since: 4.4.0 Added the `$tagnames` parameter. |
| do_shortcode_tag( $m ) X-Ref |
| Regular Expression callable for do_shortcode() for calling shortcode hook. return: string|false Shortcode output on success, false on failure. param: array $m Regular expression match array. since: 2.5.0 |
| do_shortcodes_in_html_tags( $content, $ignore_html, $tagnames ) X-Ref |
| Search only inside HTML elements for shortcodes and process them. Any [ or ] characters remaining inside elements will be HTML encoded to prevent interference with shortcodes that are outside the elements. Assumes $content processed by KSES already. Users with unfiltered_html capability may get unexpected output if angle braces are nested in tags. return: string Content with shortcodes filtered out. param: string $content Content to search for shortcodes. param: bool $ignore_html When true, all square braces inside elements will be encoded. param: array $tagnames List of shortcodes to find. since: 4.2.3 |
| unescape_invalid_shortcodes( $content ) X-Ref |
| Remove placeholders added by do_shortcodes_in_html_tags(). return: string Content with placeholders removed. param: string $content Content to search for placeholders. since: 4.2.3 |
| get_shortcode_atts_regex() X-Ref |
| Retrieve the shortcode attributes regex. return: string The shortcode attribute regular expression since: 4.4.0 |
| 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. return: array|string List of attribute values. param: string $text since: 2.5.0 |
| shortcode_atts( $pairs, $atts, $shortcode = '' ) 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. return: array Combined and filtered attribute list. param: array $pairs Entire list of supported attributes and their defaults. param: array $atts User defined attributes in shortcode tag. param: string $shortcode Optional. The name of the shortcode, provided for context to enable filtering since: 2.5.0 |
| strip_shortcodes( $content ) X-Ref |
| Remove all shortcode tags from the given content. return: string Content without shortcode tags. param: string $content Content to remove shortcode tags. since: 2.5.0 |
| strip_shortcode_tag( $m ) X-Ref |
| Strips a shortcode tag based on RegEx matches against post content. return: string|false The content stripped of the tag, otherwise false. param: array $m RegEx matches against post content. since: 3.3.0 |
| Generated: Thu Nov 21 01:00:03 2024 | Cross-referenced by PHPXref 0.7.1 |