Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-06-24 05:45:02 +02:00
Code Issues Projects Releases Wiki Activity

Docs: Standardize filter docs in wp-includes/functions.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@37510


git-svn-id: http://core.svn.wordpress.org/trunk@37478 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2016-05-22 18:36:27 +00:00
parent 5ac8c4158c
commit bc20a9288f
2 changed files with 34 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
wp-includes/functions.php
View File

@ -145,7 +145,7 @@ function date_i18n( $dateformatstring, $unixtimestamp = false, $gmt = false ) {
$j = @$datefunc( $dateformatstring, $i );
/**
* Filter the date formatted based on the locale.
* Filters the date formatted based on the locale.
*
* @since 2.8.0
*
@ -225,7 +225,7 @@ function number_format_i18n( $number, $decimals = 0 ) {
}
/**
* Filter the number formatted based on the locale.
* Filters the number formatted based on the locale.
*
* @since 2.8.0
*
@ -583,7 +583,7 @@ function do_enclose( $content, $post_ID ) {
}
/**
* Filter the list of enclosure links before querying the database.
* Filters the list of enclosure links before querying the database.
*
* Allows for the addition and/or removal of potential enclosures to save
* to postmeta before checking the database for existing enclosures.
@ -881,7 +881,7 @@ function wp_removable_query_args() {
);
/**
* Filter the list of query variables to remove.
* Filters the list of query variables to remove.
*
* @since 4.2.0
*
@ -1069,7 +1069,7 @@ function status_header( $code, $description = '' ) {
if ( function_exists( 'apply_filters' ) )
/**
* Filter an HTTP status header.
* Filters an HTTP status header.
*
* @since 2.2.0
*
@ -1102,7 +1102,7 @@ function wp_get_nocache_headers() {
if ( function_exists('apply_filters') ) {
/**
* Filter the cache-controlling headers.
* Filters the cache-controlling headers.
*
* @since 2.8.0
*
@ -1323,7 +1323,7 @@ function do_robots() {
}
/**
* Filter the robots.txt output.
* Filters the robots.txt output.
*
* @since 3.0.0
*
@ -1864,7 +1864,7 @@ function wp_upload_dir( $time = null, $create_dir = true, $refresh_cache = false
}
/**
* Filter the uploads directory data.
* Filters the uploads directory data.
*
* @since 2.0.0
*
@ -2056,7 +2056,7 @@ function wp_unique_filename( $dir, $filename, $unique_filename_callback = null )
}
/**
* Filter the result when generating a unique file name.
* Filters the result when generating a unique file name.
*
* @since 4.5.0
*
@ -2121,7 +2121,7 @@ function wp_upload_bits( $name, $deprecated, $bits, $time = null ) {
return $upload;
/**
* Filter whether to treat the upload bits as an error.
* Filters whether to treat the upload bits as an error.
*
* Passing a non-array to the filter will effectively short-circuit preparing
* the upload bits, returning that value instead.
@ -2258,7 +2258,7 @@ function wp_check_filetype_and_ext( $file, $filename, $mimes = null ) {
// If getimagesize() knows what kind of image it really is and if the real MIME doesn't match the claimed MIME
if ( !empty($imgstats['mime']) && $imgstats['mime'] != $type ) {
/**
* Filter the list mapping image mime types to their respective extensions.
* Filters the list mapping image mime types to their respective extensions.
*
* @since 3.0.0
*
@ -2291,7 +2291,7 @@ function wp_check_filetype_and_ext( $file, $filename, $mimes = null ) {
}
/**
* Filter the "real" file type of the given file.
* Filters the "real" file type of the given file.
*
* @since 3.0.0
*
@ -2315,7 +2315,7 @@ function wp_check_filetype_and_ext( $file, $filename, $mimes = null ) {
*/
function wp_get_mime_types() {
/**
* Filter the list of mime types and file extensions.
* Filters the list of mime types and file extensions.
*
* This filter should be used to add, not remove, mime types. To remove
* mime types, use the 'upload_mimes' filter.
@ -2438,7 +2438,7 @@ function wp_get_mime_types() {
function wp_get_ext_types() {
/**
* Filter file type based on the extension name.
* Filters file type based on the extension name.
*
* @since 2.5.0
*
@ -2480,7 +2480,7 @@ function get_allowed_mime_types( $user = null ) {
unset( $t['htm|html'] );
/**
* Filter list of allowed mime types and file extensions.
* Filters list of allowed mime types and file extensions.
*
* @since 2.0.0
*
@ -2560,7 +2560,7 @@ function wp_die( $message = '', $title = '', $args = array() ) {
if ( defined( 'DOING_AJAX' ) && DOING_AJAX ) {
/**
* Filter callback for killing WordPress execution for AJAX requests.
* Filters callback for killing WordPress execution for AJAX requests.
*
* @since 3.4.0
*
@ -2569,7 +2569,7 @@ function wp_die( $message = '', $title = '', $args = array() ) {
$function = apply_filters( 'wp_die_ajax_handler', '_ajax_wp_die_handler' );
} elseif ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST ) {
/**
* Filter callback for killing WordPress execution for XML-RPC requests.
* Filters callback for killing WordPress execution for XML-RPC requests.
*
* @since 3.4.0
*
@ -2578,7 +2578,7 @@ function wp_die( $message = '', $title = '', $args = array() ) {
$function = apply_filters( 'wp_die_xmlrpc_handler', '_xmlrpc_wp_die_handler' );
} else {
/**
* Filter callback for killing WordPress execution for all non-AJAX, non-XML-RPC requests.
* Filters callback for killing WordPress execution for all non-AJAX, non-XML-RPC requests.
*
* @since 3.0.0
*
@ -3513,7 +3513,7 @@ function wp_list_pluck( $list, $field, $index_key = null ) {
*/
function wp_maybe_load_widgets() {
/**
* Filter whether to load the Widgets library.
* Filters whether to load the Widgets library.
*
* Passing a falsey value to the filter will effectively short-circuit
* the Widgets library from loading.
@ -3659,7 +3659,7 @@ function _deprecated_function( $function, $version, $replacement = null ) {
do_action( 'deprecated_function_run', $function, $replacement, $version );
/**
* Filter whether to trigger an error for deprecated functions.
* Filters whether to trigger an error for deprecated functions.
*
* @since 2.5.0
*
@ -3715,7 +3715,7 @@ function _deprecated_constructor( $class, $version, $parent_class = '' ) {
do_action( 'deprecated_constructor_run', $class, $version, $parent_class );
/**
* Filter whether to trigger an error for deprecated functions.
* Filters whether to trigger an error for deprecated functions.
*
* `WP_DEBUG` must be true in addition to the filter evaluating to true.
*
@ -3782,7 +3782,7 @@ function _deprecated_file( $file, $version, $replacement = null, $message = '' )
do_action( 'deprecated_file_included', $file, $replacement, $version, $message );
/**
* Filter whether to trigger an error for deprecated files.
* Filters whether to trigger an error for deprecated files.
*
* @since 2.5.0
*
@ -3843,7 +3843,7 @@ function _deprecated_argument( $function, $version, $message = null ) {
do_action( 'deprecated_argument_run', $function, $message, $version );
/**
* Filter whether to trigger an error for deprecated arguments.
* Filters whether to trigger an error for deprecated arguments.
*
* @since 3.0.0
*
@ -3894,7 +3894,7 @@ function _doing_it_wrong( $function, $message, $version ) {
do_action( 'doing_it_wrong_run', $function, $message, $version );
/**
* Filter whether to trigger an error for _doing_it_wrong() calls.
* Filters whether to trigger an error for _doing_it_wrong() calls.
*
* @since 3.1.0
*
@ -3989,7 +3989,7 @@ function iis7_supports_permalinks() {
}
/**
* Filter whether IIS 7+ supports pretty permalinks.
* Filters whether IIS 7+ supports pretty permalinks.
*
* @since 2.8.0
*
@ -4246,7 +4246,7 @@ function get_main_network_id() {
}
/**
* Filter the main network ID.
* Filters the main network ID.
*
* @since 4.3.0
*
@ -4272,7 +4272,7 @@ function global_terms_enabled() {
if ( is_null( $global_terms ) ) {
/**
* Filter whether global terms are enabled.
* Filters whether global terms are enabled.
*
* Passing a non-null value to the filter will effectively short-circuit the function,
* returning the value of the 'global_terms_enabled' site option instead.
@ -4590,7 +4590,7 @@ function get_file_data( $file, $default_headers, $context = '' ) {
$file_data = str_replace( "\r", "\n", $file_data );
/**
* Filter extra file headers by context.
* Filters extra file headers by context.
*
* The dynamic portion of the hook name, `$context`, refers to
* the context where extra headers might be loaded.
@ -4839,7 +4839,7 @@ function wp_allowed_protocols() {
$protocols = array( 'http', 'https', 'ftp', 'ftps', 'mailto', 'news', 'irc', 'gopher', 'nntp', 'feed', 'telnet', 'mms', 'rtsp', 'svn', 'tel', 'fax', 'xmpp', 'webcal' );
/**
* Filter the list of protocols allowed in HTML attributes.
* Filters the list of protocols allowed in HTML attributes.
*
* @since 3.0.0
*
@ -4976,7 +4976,7 @@ function wp_is_stream( $path ) {
*/
function wp_checkdate( $month, $day, $year, $source_date ) {
/**
* Filter whether the given date is valid for the Gregorian calendar.
* Filters whether the given date is valid for the Gregorian calendar.
*
* @since 3.5.0
*
@ -5009,7 +5009,7 @@ function wp_auth_check_load() {
$show = ! in_array( $screen->id, $hidden );
/**
* Filter whether to load the authentication check.
* Filters whether to load the authentication check.
*
* Passing a falsey value to the filter will effectively short-circuit
* loading the authentication check.
@ -5039,7 +5039,7 @@ function wp_auth_check_html() {
$same_domain = ( strpos( $login_url, $current_domain ) === 0 );
/**
* Filter whether the authentication check originated at the same domain.
* Filters whether the authentication check originated at the same domain.
*
* @since 3.6.0
*
@ -5226,7 +5226,7 @@ function wp_validate_boolean( $var ) {
*/
function wp_delete_file( $file ) {
/**
* Filter the path of the file to delete.
* Filters the path of the file to delete.
*
* @since 2.1.0
*

2
wp-includes/version.php
View File

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