Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-12-31 13:37:51 +01:00
Code Issues Projects Releases Wiki Activity

Docs: Standardize filter docs in wp-includes/formatting.php to use third-person singular verbs per the inline documentation standards for PHP.

Browse Source 
See #36913.

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


git-svn-id: http://core.svn.wordpress.org/trunk@37483 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2016-05-22 18:45:28 +00:00
parent fe3129f470
commit 03b342f22d
2 changed files with 39 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

76
wp-includes/formatting.php
View File

@ -66,7 +66,7 @@ function wptexturize( $text, $reset = false ) {
// Set up static variables. Run once only.
if ( $reset || ! isset( $static_characters ) ) {
/**
* Filter whether to skip running wptexturize().
* Filters whether to skip running wptexturize().
*
* Passing false to the filter will effectively short-circuit wptexturize().
* returning the original text passed to the function instead.
@ -195,7 +195,7 @@ function wptexturize( $text, $reset = false ) {
// Must do this every time in case plugins use these filters in a context sensitive manner
/**
* Filter the list of HTML elements not to texturize.
* Filters the list of HTML elements not to texturize.
*
* @since 2.8.0
*
@ -203,7 +203,7 @@ function wptexturize( $text, $reset = false ) {
*/
$no_texturize_tags = apply_filters( 'no_texturize_tags', $default_no_texturize_tags );
/**
* Filter the list of shortcodes not to texturize.
* Filters the list of shortcodes not to texturize.
*
* @since 2.8.0
*
@ -1375,7 +1375,7 @@ function sanitize_file_name( $filename ) {
$filename_raw = $filename;
$special_chars = array("?", "[", "]", "/", "\\", "=", "<", ">", ":", ";", ",", "'", "\"", "&", "$", "#", "*", "(", ")", "|", "~", "`", "!", "{", "}", "%", "+", chr(0));
/**
* Filter the list of characters to remove from a filename.
* Filters the list of characters to remove from a filename.
*
* @since 2.8.0
*
@ -1395,7 +1395,7 @@ function sanitize_file_name( $filename ) {
// Return if only one extension
if ( count( $parts ) <= 2 ) {
/**
* Filter a sanitized filename string.
* Filters a sanitized filename string.
*
* @since 2.8.0
*
@ -1466,7 +1466,7 @@ function sanitize_user( $username, $strict = false ) {
$username = preg_replace( '|\s+|', ' ', $username );
/**
* Filter a sanitized username string.
* Filters a sanitized username string.
*
* @since 2.0.1
*
@ -1493,7 +1493,7 @@ function sanitize_key( $key ) {
$key = preg_replace( '/[^a-z0-9_\-]/', '', $key );
/**
* Filter a sanitized key string.
* Filters a sanitized key string.
*
* @since 3.0.0
*
@ -1524,7 +1524,7 @@ function sanitize_title( $title, $fallback_title = '', $context = 'save' ) {
$title = remove_accents($title);
/**
* Filter a sanitized title string.
* Filters a sanitized title string.
*
* @since 1.2.0
*
@ -1669,7 +1669,7 @@ function sanitize_html_class( $class, $fallback = '' ) {
return sanitize_html_class( $fallback );
}
/**
* Filter a sanitized HTML class string.
* Filters a sanitized HTML class string.
*
* @since 2.8.0
*
@ -1918,7 +1918,7 @@ function force_balance_tags( $text ) {
*/
function format_to_edit( $content, $rich_text = false ) {
/**
* Filter the text to be formatted for editing.
* Filters the text to be formatted for editing.
*
* @since 1.2.0
*
@ -2395,7 +2395,7 @@ function translate_smiley( $matches ) {
}
/**
* Filter the Smiley image URL before it's used in the image element.
* Filters the Smiley image URL before it's used in the image element.
*
* @since 2.9.0
*
@ -2478,7 +2478,7 @@ function is_email( $email, $deprecated = false ) {
// Test for the minimum length the email can be
if ( strlen( $email ) < 3 ) {
/**
* Filter whether an email address is valid.
* Filters whether an email address is valid.
*
* This filter is evaluated under several different contexts, such as 'email_too_short',
* 'email_no_at', 'local_invalid_chars', 'domain_period_sequence', 'domain_period_limits',
@ -2715,7 +2715,7 @@ function sanitize_email( $email ) {
// Test for the minimum length the email can be
if ( strlen( $email ) < 3 ) {
/**
* Filter a sanitized email address.
* Filters a sanitized email address.
*
* This filter is evaluated under several contexts, including 'email_too_short',
* 'email_no_at', 'local_invalid_chars', 'domain_period_sequence', 'domain_period_limits',
@ -2858,7 +2858,7 @@ function human_time_diff( $from, $to = '' ) {
}
/**
* Filter the human readable difference between two timestamps.
* Filters the human readable difference between two timestamps.
*
* @since 4.0.0
*
@ -2897,7 +2897,7 @@ function wp_trim_excerpt( $text = '' ) {
$text = str_replace(']]>', ']]&gt;', $text);
/**
* Filter the number of words in an excerpt.
* Filters the number of words in an excerpt.
*
* @since 2.7.0
*
@ -2905,7 +2905,7 @@ function wp_trim_excerpt( $text = '' ) {
*/
$excerpt_length = apply_filters( 'excerpt_length', 55 );
/**
* Filter the string in the "more" link displayed after a trimmed excerpt.
* Filters the string in the "more" link displayed after a trimmed excerpt.
*
* @since 2.9.0
*
@ -2915,7 +2915,7 @@ function wp_trim_excerpt( $text = '' ) {
$text = wp_trim_words( $text, $excerpt_length, $excerpt_more );
}
/**
* Filter the trimmed excerpt string.
* Filters the trimmed excerpt string.
*
* @since 2.8.0
*
@ -2971,7 +2971,7 @@ function wp_trim_words( $text, $num_words = 55, $more = null ) {
}
/**
* Filter the text content after words have been trimmed.
* Filters the text content after words have been trimmed.
*
* @since 3.3.0
*
@ -2994,7 +2994,7 @@ function wp_trim_words( $text, $num_words = 55, $more = null ) {
function ent2ncr( $text ) {
/**
* Filter text before named entities are converted into numbered entities.
* Filters text before named entities are converted into numbered entities.
*
* A non-null string must be returned for the filter to be evaluated.
*
@ -3293,7 +3293,7 @@ function format_for_editor( $text, $default_editor = null ) {
}
/**
* Filter the text after it is formatted for the editor.
* Filters the text after it is formatted for the editor.
*
* @since 4.3.0
*
@ -3446,7 +3446,7 @@ function esc_url( $url, $protocols = null, $_context = 'display' ) {
}
/**
* Filter a string cleaned and escaped for output as a URL.
* Filters a string cleaned and escaped for output as a URL.
*
* @since 2.3.0
*
@ -3505,7 +3505,7 @@ function esc_js( $text ) {
$safe_text = str_replace( "\r", '', $safe_text );
$safe_text = str_replace( "\n", '\\n', addslashes( $safe_text ) );
/**
* Filter a string cleaned and escaped for output in JavaScript.
* Filters a string cleaned and escaped for output in JavaScript.
*
* Text passed to esc_js() is stripped of invalid or special characters,
* and properly slashed for output.
@ -3530,7 +3530,7 @@ function esc_html( $text ) {
$safe_text = wp_check_invalid_utf8( $text );
$safe_text = _wp_specialchars( $safe_text, ENT_QUOTES );
/**
* Filter a string cleaned and escaped for output in HTML.
* Filters a string cleaned and escaped for output in HTML.
*
* Text passed to esc_html() is stripped of invalid or special characters
* before output.
@ -3555,7 +3555,7 @@ function esc_attr( $text ) {
$safe_text = wp_check_invalid_utf8( $text );
$safe_text = _wp_specialchars( $safe_text, ENT_QUOTES );
/**
* Filter a string cleaned and escaped for output in an HTML attribute.
* Filters a string cleaned and escaped for output in an HTML attribute.
*
* Text passed to esc_attr() is stripped of invalid or special characters
* before output.
@ -3579,7 +3579,7 @@ function esc_attr( $text ) {
function esc_textarea( $text ) {
$safe_text = htmlspecialchars( $text, ENT_QUOTES, get_option( 'blog_charset' ) );
/**
* Filter a string cleaned and escaped for output in a textarea element.
* Filters a string cleaned and escaped for output in a textarea element.
*
* @since 3.1.0
*
@ -3600,7 +3600,7 @@ function esc_textarea( $text ) {
function tag_escape( $tag_name ) {
$safe_tag = strtolower( preg_replace('/[^a-zA-Z0-9_:]/', '', $tag_name) );
/**
* Filter a string cleaned and escaped for output as an HTML tag.
* Filters a string cleaned and escaped for output as an HTML tag.
*
* @since 2.8.0
*
@ -3872,7 +3872,7 @@ function sanitize_option( $option, $value ) {
}
/**
* Filter an option value following sanitization.
* Filters an option value following sanitization.
*
* @since 2.3.0
* @since 4.3.0 Added the `$original_value` parameter.
@ -3928,7 +3928,7 @@ function wp_parse_str( $string, &$array ) {
if ( get_magic_quotes_gpc() )
$array = stripslashes_deep( $array );
/**
* Filter the array of variables derived from a parsed string.
* Filters the array of variables derived from a parsed string.
*
* @since 2.3.0
*
@ -4013,7 +4013,7 @@ function wp_sprintf( $pattern ) {
}
/**
* Filter a fragment from the pattern passed to wp_sprintf().
* Filters a fragment from the pattern passed to wp_sprintf().
*
* If the fragment is unchanged, then sprintf() will be run on the fragment.
*
@ -4059,7 +4059,7 @@ function wp_sprintf_l( $pattern, $args ) {
return '';
/**
* Filter the translated delimiters used by wp_sprintf_l().
* Filters the translated delimiters used by wp_sprintf_l().
* Placeholders (%s) are included to assist translators and then
* removed before the array of strings reaches the filter.
*
@ -4282,7 +4282,7 @@ function sanitize_text_field( $str ) {
}
/**
* Filter a sanitized text field string.
* Filters a sanitized text field string.
*
* @since 2.9.0
*
@ -4344,7 +4344,7 @@ function capital_P_dangit( $text ) {
function sanitize_mime_type( $mime_type ) {
$sani_mime_type = preg_replace( '/[^-+*.a-zA-Z0-9\/]/', '', $mime_type );
/**
* Filter a mime type following sanitization.
* Filters a mime type following sanitization.
*
* @since 3.1.3
*
@ -4371,7 +4371,7 @@ function sanitize_trackback_urls( $to_ping ) {
$urls_to_ping = array_map( 'esc_url_raw', $urls_to_ping );
$urls_to_ping = implode( "\n", $urls_to_ping );
/**
* Filter a list of trackback URLs following sanitization.
* Filters a list of trackback URLs following sanitization.
*
* The string returned here consists of a space or carriage return-delimited list
* of trackback URLs.
@ -4464,7 +4464,7 @@ function wp_spaces_regexp() {
if ( empty( $spaces ) ) {
/**
* Filter the regexp for common whitespace characters.
* Filters the regexp for common whitespace characters.
*
* This string is substituted for the \s sequence as needed in regular
* expressions. For websites not written in English, different characters
@ -4546,7 +4546,7 @@ function _print_emoji_detection_script() {
$settings = array(
/**
* Filter the URL where emoji png images are hosted.
* Filters the URL where emoji png images are hosted.
*
* @since 4.2.0
*
@ -4555,7 +4555,7 @@ function _print_emoji_detection_script() {
'baseUrl' => apply_filters( 'emoji_url', 'https://s.w.org/images/core/emoji/72x72/' ),
/**
* Filter the extension of the emoji png files.
* Filters the extension of the emoji png files.
*
* @since 4.2.0
*
@ -4564,7 +4564,7 @@ function _print_emoji_detection_script() {
'ext' => apply_filters( 'emoji_ext', '.png' ),
/**
* Filter the URL where emoji SVG images are hosted.
* Filters the URL where emoji SVG images are hosted.
*
* @since 4.6.0
*
@ -4573,7 +4573,7 @@ function _print_emoji_detection_script() {
'svgUrl' => apply_filters( 'emoji_svg_url', 'https://s.w.org/images/core/emoji/svg/' ),
/**
* Filter the extension of the emoji SVG files.
* Filters the extension of the emoji SVG files.
*
* @since 4.6.0
*

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
*
* @global string $wp_version
*/
$wp_version = '4.6-alpha-37514';
$wp_version = '4.6-alpha-37515';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.