From 5c83f0630aa5d8d8ef117ce894419c7d9492e772 Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Sat, 21 Dec 2019 20:10:25 +0000 Subject: [PATCH] Shortcodes: Introduce `apply_shortcodes()` as an alias for `do_shortcode()`. This better aligns with the semantics of applying filters to the input and returning a result, rather than performing an action and outputting to the current buffer. Props ljasinskipl, thefarlilacfield. Fixes #37422. git-svn-id: https://develop.svn.wordpress.org/trunk@47004 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/shortcodes.php | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/src/wp-includes/shortcodes.php b/src/wp-includes/shortcodes.php index a5e806b40d..06ef90d868 100644 --- a/src/wp-includes/shortcodes.php +++ b/src/wp-includes/shortcodes.php @@ -159,6 +159,24 @@ function has_shortcode( $content, $tag ) { return false; } +/** + * Search content for shortcodes and filter shortcodes through their hooks. + * + * This function is an alias for do_shortcode(). + * + * @since 5.4.0 + * + * @see do_shortcode() + * + * @param string $content Content to search for shortcodes. + * @param bool $ignore_html When true, shortcodes inside HTML elements will be skipped. + * Default false. + * @return string Content with shortcodes filtered out. + */ +function apply_shortcodes( $content, $ignore_html = false ) { + return do_shortcode( $content, $ignore_html ); +} + /** * Search content for shortcodes and filter shortcodes through their hooks. * @@ -170,8 +188,9 @@ function has_shortcode( $content, $tag ) { * * @global array $shortcode_tags List of shortcode tags and their callback hooks. * - * @param string $content Content to search for shortcodes. - * @param bool $ignore_html When true, shortcodes inside HTML elements will be skipped. + * @param string $content Content to search for shortcodes. + * @param bool $ignore_html When true, shortcodes inside HTML elements will be skipped. + * Default false. * @return string Content with shortcodes filtered out. */ function do_shortcode( $content, $ignore_html = false ) {