enmi-conf.org: comparison wp/wp-includes/shortcodes.php

equal deleted inserted replaced

-:7b1b88e27a20
+:48c4eec2b7e6
 * @subpackage Shortcodes
 * @since 2.5.0
 */
 /**
-* Container for storing shortcode tags and their hook to call for the shortcode
+* Container for storing shortcode tags and their hook to call for the shortcode.
 *
 * @since 2.5.0
 *
 * @name $shortcode_tags
 * @var array
 	unset( $shortcode_tags[ $tag ] );
 }
 /**
-* Clear all shortcodes.
+* Clears all shortcodes.
 *
-* This function is simple, it clears all of the shortcode tags by replacing the
+* This function clears all of the shortcode tags by replacing the shortcodes global with
-* shortcodes global by a empty array. This is actually a very efficient method
+* an empty array. This is actually an efficient method for removing all shortcodes.
-* for removing all shortcodes.
 *
 * @since 2.5.0
 *
 * @global array $shortcode_tags
 */
 	$shortcode_tags = array();
 }
 /**
-* Whether a registered shortcode exists named $tag
+* Determines whether a registered shortcode exists named $tag.
 *
 * @since 3.6.0
 *
 * @global array $shortcode_tags List of shortcode tags and their callback hooks.
 *
 	global $shortcode_tags;
 	return array_key_exists( $tag, $shortcode_tags );
 }
 /**
-* Whether the passed content contains the specified shortcode
+* Determines whether the passed content contains the specified shortcode.
 *
 * @since 3.6.0
 *
 * @global array $shortcode_tags
 *
 * @param string $content Content to search for shortcodes.
 * @param string $tag     Shortcode tag to check.
 * @return bool Whether the passed content contains the given shortcode.
 */
 function has_shortcode( $content, $tag ) {
-	if ( false === strpos( $content, '[' ) ) {
+	if ( ! str_contains( $content, '[' ) ) {
 		return false;
 	}
 	if ( shortcode_exists( $tag ) ) {
 		preg_match_all( '/' . get_shortcode_regex() . '/', $content, $matches, PREG_SET_ORDER );
 	}
 	return false;
 }
 /**
-* Search content for shortcodes and filter shortcodes through their hooks.
+* Returns a list of registered shortcode names found in the given content.
+*
+* Example usage:
+*
+*     get_shortcode_tags_in_content( '[audio src="file.mp3"][/audio] [foo] [gallery ids="1,2,3"]' );
+*     // array( 'audio', 'gallery' )
+*
+* @since 6.3.2
+*
+* @param string $content The content to check.
+* @return string[] An array of registered shortcode names found in the content.
+*/
+function get_shortcode_tags_in_content( $content ) {
+	if ( false === strpos( $content, '[' ) ) {
+		return array();
+	}
+	preg_match_all( '/' . get_shortcode_regex() . '/', $content, $matches, PREG_SET_ORDER );
+	if ( empty( $matches ) ) {
+		return array();
+	}
+	$tags = array();
+	foreach ( $matches as $shortcode ) {
+		$tags[] = $shortcode[2];
+		if ( ! empty( $shortcode[5] ) ) {
+			$deep_tags = get_shortcode_tags_in_content( $shortcode[5] );
+			if ( ! empty( $deep_tags ) ) {
+				$tags = array_merge( $tags, $deep_tags );
+			}
+		}
+	}
+	return $tags;
+}
+/**
+* Searches content for shortcodes and filter shortcodes through their hooks.
 *
 * This function is an alias for do_shortcode().
 *
 * @since 5.4.0
 *
 function apply_shortcodes( $content, $ignore_html = false ) {
 	return do_shortcode( $content, $ignore_html );
 }
 /**
-* Search content for shortcodes and filter shortcodes through their hooks.
+* Searches 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.
 */
 function do_shortcode( $content, $ignore_html = false ) {
 	global $shortcode_tags;
-	if ( false === strpos( $content, '[' ) ) {
+	if ( ! str_contains( $content, '[' ) ) {
 		return $content;
 	}
 	if ( empty( $shortcode_tags ) || ! is_array( $shortcode_tags ) ) {
 		return $content;
 	if ( empty( $tagnames ) ) {
 		return $content;
 	}
+	// Ensure this context is only added once if shortcodes are nested.
+	$has_filter   = has_filter( 'wp_get_attachment_image_context', '_filter_do_shortcode_context' );
+	$filter_added = false;
+	if ( ! $has_filter ) {
+		$filter_added = add_filter( 'wp_get_attachment_image_context', '_filter_do_shortcode_context' );
+	}
 	$content = do_shortcodes_in_html_tags( $content, $ignore_html, $tagnames );
 	$pattern = get_shortcode_regex( $tagnames );
 	$content = preg_replace_callback( "/$pattern/", 'do_shortcode_tag', $content );
 	// Always restore square braces so we don't break things like <!--[if IE ]>.
 	$content = unescape_invalid_shortcodes( $content );
+	// Only remove the filter if it was added in this scope.
+	if ( $filter_added ) {
+		remove_filter( 'wp_get_attachment_image_context', '_filter_do_shortcode_context' );
+	}
 	return $content;
 }
 /**
-* Retrieve the shortcode regular expression for searching.
+* Filter the `wp_get_attachment_image_context` hook during shortcode rendering.
+*
+* When wp_get_attachment_image() is called during shortcode rendering, we need to make clear
+* that the context is a shortcode and not part of the theme's template rendering logic.
+*
+* @since 6.3.0
+* @access private
+*
+* @return string The filtered context value for wp_get_attachment_images when doing shortcodes.
+*/
+function _filter_do_shortcode_context() {
+	return 'do_shortcode';
+}
+/**
+* Retrieves 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.
 	if ( empty( $tagnames ) ) {
 		$tagnames = array_keys( $shortcode_tags );
 	}
 	$tagregexp = implode( '|', array_map( 'preg_quote', $tagnames ) );
-	// WARNING! Do not change this regex without changing do_shortcode_tag() and strip_shortcode_tag().
+	/*
-	// Also, see shortcode_unautop() and shortcode.js.
+	 * WARNING! Do not change this regex without changing do_shortcode_tag() and strip_shortcode_tag().
+	 * Also, see shortcode_unautop() and shortcode.js.
+	 */
 	// phpcs:disable Squiz.Strings.ConcatenationSpacing.PaddingFound -- don't remove regex indentation
 	return '\\['                             // Opening bracket.
 		. '(\\[?)'                           // 1: Optional second opening bracket for escaping shortcodes: [[tag]].
 		. "($tagregexp)"                     // 2: Shortcode name.
 		.             ')*+'
 		.         ')'
 		.         '\\[\\/\\2\\]'             // Closing shortcode tag.
 		.     ')?'
 		. ')'
-		. '(\\]?)';                          // 6: Optional second closing brocket for escaping shortcodes: [[tag]].
+		. '(\\]?)';                          // 6: Optional second closing bracket for escaping shortcodes: [[tag]].
 	// phpcs:enable
 }
 /**
 * Regular Expression callable for do_shortcode() for calling shortcode hook.
 * @since 2.5.0
 * @access private
 *
 * @global array $shortcode_tags
 *
-* @param array $m Regular expression match array.
+* @param array $m {
-* @return string|false Shortcode output on success, false on failure.
+*     Regular expression match array.
+*
+*     @type string $0 Entire matched shortcode text.
+*     @type string $1 Optional second opening bracket for escaping shortcodes.
+*     @type string $2 Shortcode name.
+*     @type string $3 Shortcode arguments list.
+*     @type string $4 Optional self closing slash.
+*     @type string $5 Content of a shortcode when it wraps some content.
+*     @type string $6 Optional second closing bracket for escaping shortcodes.
+* }
+* @return string Shortcode output.
 */
 function do_shortcode_tag( $m ) {
 	global $shortcode_tags;
 	// Allow [[foo]] syntax for escaping a tag.
 	 *
 	 * Returning a non-false value from filter will short-circuit the
 	 * shortcode generation process, returning that value instead.
 	 *
 	 * @since 4.7.0
+	 * @since 6.5.0 The `$attr` parameter is always an array.
 	 *
-	 * @param false|string $return      Short-circuit return value. Either false or the value to replace the shortcode with.
+	 * @param false|string $output Short-circuit return value. Either false or the value to replace the shortcode with.
-	 * @param string       $tag         Shortcode name.
+	 * @param string       $tag    Shortcode name.
-	 * @param array|string $attr        Shortcode attributes array or empty string.
+	 * @param array        $attr   Shortcode attributes array, can be empty if the original arguments string cannot be parsed.
-	 * @param array        $m           Regular expression match array.
+	 * @param array        $m      Regular expression match array.
 	 */
 	$return = apply_filters( 'pre_do_shortcode_tag', false, $tag, $attr, $m );
 	if ( false !== $return ) {
 		return $return;
 	}
 	/**
 	 * Filters the output created by a shortcode callback.
 	 *
 	 * @since 4.7.0
+	 * @since 6.5.0 The `$attr` parameter is always an array.
 	 *
-	 * @param string       $output Shortcode output.
+	 * @param string $output Shortcode output.
-	 * @param string       $tag    Shortcode name.
+	 * @param string $tag    Shortcode name.
-	 * @param array|string $attr   Shortcode attributes array or empty string.
+	 * @param array  $attr   Shortcode attributes array, can be empty if the original arguments string cannot be parsed.
-	 * @param array        $m      Regular expression match array.
+	 * @param array  $m      Regular expression match array.
 	 */
 	return apply_filters( 'do_shortcode_tag', $output, $tag, $attr, $m );
 }
 /**
-* Search only inside HTML elements for shortcodes and process them.
+* Searches 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.
 	foreach ( $textarr as &$element ) {
 		if ( '' === $element || '<' !== $element[0] ) {
 			continue;
 		}
-		$noopen  = false === strpos( $element, '[' );
+		$noopen  = ! str_contains( $element, '[' );
-		$noclose = false === strpos( $element, ']' );
+		$noclose = ! str_contains( $element, ']' );
 		if ( $noopen || $noclose ) {
 			// This element does not contain shortcodes.
 			if ( $noopen xor $noclose ) {
 				// Need to encode stray '[' or ']' chars.
 				$element = strtr( $element, $trans );
 			}
 			continue;
 		}
-		if ( $ignore_html || '<!--' === substr( $element, 0, 4 ) || '<![CDATA[' === substr( $element, 0, 9 ) ) {
+		if ( $ignore_html || str_starts_with( $element, '<!--' ) || str_starts_with( $element, '<![CDATA[' ) ) {
 			// Encode all '[' and ']' chars.
 			$element = strtr( $element, $trans );
 			continue;
 		}
 			// Some plugins are doing things like [name] <[email]>.
 			if ( 1 === preg_match( '%^<\s*\[\[?[^\[\]]+\]%', $element ) ) {
 				$element = preg_replace_callback( "/$pattern/", 'do_shortcode_tag', $element );
 			}
-			// Looks like we found some crazy unfiltered HTML. Skipping it for sanity.
+			// Looks like we found some unexpected unfiltered HTML. Skipping it for confidence.
 			$element = strtr( $element, $trans );
 			continue;
 		}
 		// Get element name.
 				 * was written by an administrator, so we should avoid changing the output
 				 * and we do not need to run KSES here.
 				 */
 				$attr = preg_replace_callback( "/$pattern/", 'do_shortcode_tag', $attr );
 			} else {
-				// $attr like 'name = "[shortcode]"' or "name = '[shortcode]'".
+				/*
-				// We do not know if $content was unfiltered. Assume KSES ran before shortcodes.
+				 * $attr like 'name = "[shortcode]"' or "name = '[shortcode]'".
+				 * We do not know if $content was unfiltered. Assume KSES ran before shortcodes.
+				 */
 				$count    = 0;
 				$new_attr = preg_replace_callback( "/$pattern/", 'do_shortcode_tag', $attr, -1, $count );
 				if ( $count > 0 ) {
 					// Sanitize the shortcode output using KSES.
 					$new_attr = wp_kses_one_attr( $new_attr, $elname );
 	return $content;
 }
 /**
-* Remove placeholders added by do_shortcodes_in_html_tags().
+* Removes placeholders added by do_shortcodes_in_html_tags().
 *
 * @since 4.2.3
 *
 * @param string $content Content to search for placeholders.
 * @return string Content with placeholders removed.
 	return $content;
 }
 /**
-* Retrieve the shortcode attributes regex.
+* Retrieves the shortcode attributes regex.
 *
 * @since 4.4.0
 *
-* @return string The shortcode attribute regular expression
+* @return string The shortcode attribute regular expression.
 */
 function get_shortcode_atts_regex() {
 	return '/([\w-]+)\s*=\s*"([^"]*)"(?:\s|$)|([\w-]+)\s*=\s*\'([^\']*)\'(?:\s|$)|([\w-]+)\s*=\s*([^\s\'"]+)(?:\s|$)|"([^"]*)"(?:\s|$)|\'([^\']*)\'(?:\s|$)|(\S+)(?:\s|$)/';
 }
 /**
-* Retrieve all attributes from the shortcodes tag.
+* Retrieves 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.0
-*
+* @since 6.5.0 The function now always returns an array,
-* @param string $text
+*              even if the original arguments string cannot be parsed or is empty.
-* @return array|string List of attribute values.
+*
-*                      Returns empty array if '""' === trim( $text ).
+* @param string $text Shortcode arguments list.
-*                      Returns empty string if '' === trim( $text ).
+* @return array Array of attribute values keyed by attribute name.
-*                      All other matches are checked for not empty().
+*               Returns empty array if there are no attributes
+*               or if the original arguments string cannot be parsed.
 */
 function shortcode_parse_atts( $text ) {
 	$atts    = array();
 	$pattern = get_shortcode_atts_regex();
 	$text    = preg_replace( "/[\x{00a0}\x{200b}]+/u", ' ', $text );
 			}
 		}
 		// Reject any unclosed HTML elements.
 		foreach ( $atts as &$value ) {
-			if ( false !== strpos( $value, '<' ) ) {
+			if ( str_contains( $value, '<' ) ) {
 				if ( 1 !== preg_match( '/^[^<]*+(?:<[^>]*+>[^<]*+)*+$/', $value ) ) {
 					$value = '';
 				}
 			}
 		}
-	} else {
-		$atts = ltrim( $text );
 	}
 	return $atts;
 }
 /**
-* Combine user attributes with known attributes and fill in defaults when needed.
+* Combines 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.
 *
 	return $out;
 }
 /**
-* Remove all shortcode tags from the given content.
+* Removes all shortcode tags from the given content.
 *
 * @since 2.5.0
 *
 * @global array $shortcode_tags
 *
 * @return string Content without shortcode tags.
 */
 function strip_shortcodes( $content ) {
 	global $shortcode_tags;
-	if ( false === strpos( $content, '[' ) ) {
+	if ( ! str_contains( $content, '[' ) ) {
 		return $content;
 	}
 	if ( empty( $shortcode_tags ) || ! is_array( $shortcode_tags ) ) {
 		return $content;

changeset 21	48c4eec2b7e6
parent 18	be944660c56a