Ensure inline code is markdown-escaped as such, HTML tags are removed from summaries, and that code snippets in descriptions are properly indented.

Affects DocBlocks for the following core elements in wp-includes/formatting.php:
* Markdown-indent code snippets in the description for `wptexturize()`
* Backtick-escape inline code in a parameter description for `_wptexturize_pushpop_element()`
* Backtick-escape inline code in the description for `shortcode_unautop()`
* Backtick-escape HTML tags in the description for `convert_chars()`
* Markdown-indent a code snippet in the description for `_split_str_by_whitespace()`
* Backtick-escape an `<img>` tag in the description for `translate_smiley()`
* Add markdown formatting to the description for `links_add_target()`
* Backtick-escape HTML tags in the description for `wp_strip_all_tags()`

Props rarst.
See #30473.

Built from https://develop.svn.wordpress.org/trunk@30540


git-svn-id: http://core.svn.wordpress.org/trunk@30529 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2014-11-24 05:30:25 +00:00
parent cc68de7006
commit 39da8dd15e
2 changed files with 25 additions and 27 deletions

View File

@ -11,13 +11,13 @@
* Replaces common plain text characters into formatted entities * Replaces common plain text characters into formatted entities
* *
* As an example, * As an example,
* <code> *
* 'cause today's effort makes it worth tomorrow's "holiday"... * 'cause today's effort makes it worth tomorrow's "holiday" ...
* </code> *
* Becomes: * Becomes:
* <code> *
* &#8217;cause today&#8217;s effort makes it worth tomorrow&#8217;s &#8220;holiday&#8221;&#8230; * &#8217;cause today&#8217;s effort makes it worth tomorrow&#8217;s &#8220;holiday&#8221; &#8230;
* </code> *
* Code within certain html blocks are skipped. * Code within certain html blocks are skipped.
* *
* @since 0.71 * @since 0.71
@ -312,7 +312,7 @@ function wptexturize($text, $reset = false) {
* @since 2.9.0 * @since 2.9.0
* @access private * @access private
* *
* @param string $text Text to check. Must be a tag like <html> or [shortcode]. * @param string $text Text to check. Must be a tag like `<html>` or `[shortcode]`.
* @param array $stack List of open tag elements. * @param array $stack List of open tag elements.
* @param array $disabled_elements The tag names to match against. Spaces are not allowed in tag names. * @param array $disabled_elements The tag names to match against. Spaces are not allowed in tag names.
*/ */
@ -480,7 +480,7 @@ function _autop_newline_preservation_helper( $matches ) {
/** /**
* Don't auto-p wrap shortcodes that stand alone * Don't auto-p wrap shortcodes that stand alone
* *
* Ensures that shortcodes are not wrapped in <<p>>...<</p>>. * Ensures that shortcodes are not wrapped in `<p>...</p>`.
* *
* @since 2.9.0 * @since 2.9.0
* *
@ -1366,7 +1366,7 @@ function sanitize_html_class( $class, $fallback = '' ) {
/** /**
* Converts a number of characters from a string. * Converts a number of characters from a string.
* *
* Metadata tags <<title>> and <<category>> are removed, <<br>> and <<hr>> are * Metadata tags `<title>` and `<category>` are removed, `<br>` and `<hr>` are
* converted into correct XHTML and Unicode characters are converted to the * converted into correct XHTML and Unicode characters are converted to the
* valid range. * valid range.
* *
@ -1935,7 +1935,6 @@ function make_clickable( $text ) {
* *
* Input string must have no null characters (or eventual transformations on output chunks must not care about null characters) * Input string must have no null characters (or eventual transformations on output chunks must not care about null characters)
* *
* <code>
* _split_str_by_whitespace( "1234 67890 1234 67890a cd 1234 890 123456789 1234567890a 45678 1 3 5 7 90 ", 10 ) == * _split_str_by_whitespace( "1234 67890 1234 67890a cd 1234 890 123456789 1234567890a 45678 1 3 5 7 90 ", 10 ) ==
* array ( * array (
* 0 => '1234 67890 ', // 11 characters: Perfect split * 0 => '1234 67890 ', // 11 characters: Perfect split
@ -1947,7 +1946,6 @@ function make_clickable( $text ) {
* 6 => ' 45678 ', // 11 characters: Perfect split * 6 => ' 45678 ', // 11 characters: Perfect split
* 7 => '1 3 5 7 9', // 9 characters: End of $string * 7 => '1 3 5 7 9', // 9 characters: End of $string
* ); * );
* </code>
* *
* @since 3.4.0 * @since 3.4.0
* @access private * @access private
@ -2021,7 +2019,7 @@ function wp_rel_nofollow_callback( $matches ) {
* *
* Callback handler for {@link convert_smilies()}. * Callback handler for {@link convert_smilies()}.
* Looks up one smiley code in the $wpsmiliestrans global array and returns an * Looks up one smiley code in the $wpsmiliestrans global array and returns an
* <img> string for that smiley. * `<img>` string for that smiley.
* *
* @global array $wpsmiliestrans * @global array $wpsmiliestrans
* @since 2.8.0 * @since 2.8.0
@ -3703,10 +3701,10 @@ function _links_add_base($m) {
/** /**
* Adds a Target attribute to all links in passed content. * Adds a Target attribute to all links in passed content.
* *
* This function by default only applies to <a> tags, however this can be * This function by default only applies to `<a>` tags, however this can be
* modified by the 3rd param. * modified by the 3rd param.
* *
* <b>NOTE:</b> Any current target attributed will be stripped and replaced. * *NOTE:* Any current target attributed will be stripped and replaced.
* *
* @since 2.7.0 * @since 2.7.0
* *
@ -3757,7 +3755,7 @@ function normalize_whitespace( $str ) {
* Properly strip all HTML tags including script and style * Properly strip all HTML tags including script and style
* *
* This differs from strip_tags() because it removes the contents of * This differs from strip_tags() because it removes the contents of
* the <script> and <style> tags. E.g. strip_tags( '<script>something</script>' ) * the `<script>` and `<style>` tags. E.g. `strip_tags( '<script>something</script>' )`
* will return 'something'. wp_strip_all_tags will return '' * will return 'something'. wp_strip_all_tags will return ''
* *
* @since 2.9.0 * @since 2.9.0

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.1-beta2-30539'; $wp_version = '4.1-beta2-30540';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.