Upstream
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Docs: Standardize filter docs in root folder files to use third-person singular verbs per the inline documentation standards for PHP. 

Fixes #36913.

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


git-svn-id: http://core.svn.wordpress.org/trunk@37503 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2016-05-23 16:44:27 +00:00
parent 11d6f0712e
commit f82641ad0e
7 changed files with 32 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
wp-comments-post.php
View File

@ -42,7 +42,7 @@ do_action( 'set_comment_cookies', $comment, $user );
$location = empty( $_POST['redirect_to'] ) ? get_comment_link( $comment ) : $_POST['redirect_to'] . '#comment-' . $comment->comment_ID;
/**
* Filter the location URI to send the commenter after posting.
* Filters the location URI to send the commenter after posting.
*
* @since 2.0.5
*

2
wp-includes/version.php
View File

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

4
wp-links-opml.php
View File

@ -46,7 +46,7 @@ else
foreach ( (array)$cats as $cat ) :
/**
* Filter the OPML outline link category name.
* Filters the OPML outline link category name.
*
* @since 2.2.0
*
@ -60,7 +60,7 @@ foreach ( (array)$cats as $cat ) :
$bookmarks = get_bookmarks(array("category" => $cat->term_id));
foreach ( (array)$bookmarks as $bookmark ) :
/**
* Filter the OPML outline link title text.
* Filters the OPML outline link title text.
*
* @since 2.2.0
*

33
wp-login.php
View File

@ -45,7 +45,7 @@ function login_header( $title = 'Log In', $message = '', $wp_error = '' ) {
// Shake it!
$shake_error_codes = array( 'empty_password', 'empty_email', 'invalid_email', 'invalidcombo', 'empty_username', 'invalid_username', 'incorrect_password' );
/**
* Filter the error codes array for shaking the login form.
* Filters the error codes array for shaking the login form.
*
* @since 3.0.0
*
@ -106,15 +106,16 @@ function login_header( $title = 'Log In', $message = '', $wp_error = '' ) {
}
/**
* Filter link URL of the header logo above login form.
* Filters link URL of the header logo above login form.
*
* @since 2.1.0
*
* @param string $login_header_url Login header logo URL.
*/
$login_header_url = apply_filters( 'login_headerurl', $login_header_url );
/**
* Filter the title attribute of the header logo above login form.
* Filters the title attribute of the header logo above login form.
*
* @since 2.1.0
*
@ -139,7 +140,7 @@ function login_header( $title = 'Log In', $message = '', $wp_error = '' ) {
$classes[] =' locale-' . sanitize_html_class( strtolower( str_replace( '_', '-', get_locale() ) ) );
/**
* Filter the login page body classes.
* Filters the login page body classes.
*
* @since 3.5.0
*
@ -166,7 +167,7 @@ function login_header( $title = 'Log In', $message = '', $wp_error = '' ) {
unset( $login_header_url, $login_header_title );
/**
* Filter the message to display above the login form.
* Filters the message to display above the login form.
*
* @since 2.1.0
*
@ -196,7 +197,7 @@ function login_header( $title = 'Log In', $message = '', $wp_error = '' ) {
}
if ( ! empty( $errors ) ) {
/**
* Filter the error messages displayed above the login form.
* Filters the error messages displayed above the login form.
*
* @since 2.1.0
*
@ -206,7 +207,7 @@ function login_header( $title = 'Log In', $message = '', $wp_error = '' ) {
}
if ( ! empty( $messages ) ) {
/**
* Filter instructional messages displayed above the login form.
* Filters instructional messages displayed above the login form.
*
* @since 2.5.0
*
@ -349,7 +350,7 @@ function retrieve_password() {
$title = sprintf( __('[%s] Password Reset'), $blogname );
/**
* Filter the subject of the password reset email.
* Filters the subject of the password reset email.
*
* @since 2.8.0
* @since 4.4.0 Added the `$user_login` and `$user_data` parameters.
@ -361,7 +362,7 @@ function retrieve_password() {
$title = apply_filters( 'retrieve_password_title', $title, $user_login, $user_data );
/**
* Filter the message body of the password reset mail.
* Filters the message body of the password reset mail.
*
* @since 2.8.0
* @since 4.1.0 Added `$user_login` and `$user_data` parameters.
@ -444,7 +445,7 @@ case 'postpass' :
$hasher = new PasswordHash( 8, true );
/**
* Filter the life span of the post password cookie.
* Filters the life span of the post password cookie.
*
* By default, the cookie expires 10 days from creation. To turn this
* into a session cookie, return 0.
@ -480,7 +481,7 @@ case 'logout' :
}
/**
* Filter the log out redirect URL.
* Filters the log out redirect URL.
*
* @since 4.2.0
*
@ -514,7 +515,7 @@ case 'retrievepassword' :
$lostpassword_redirect = ! empty( $_REQUEST['redirect_to'] ) ? $_REQUEST['redirect_to'] : '';
/**
* Filter the URL redirected to after submitting the lostpassword/retrievepassword form.
* Filters the URL redirected to after submitting the lostpassword/retrievepassword form.
*
* @since 3.0.0
*
@ -683,7 +684,7 @@ break;
case 'register' :
if ( is_multisite() ) {
/**
* Filter the Multisite sign up URL.
* Filters the Multisite sign up URL.
*
* @since 3.0.0
*
@ -713,7 +714,7 @@ case 'register' :
$registration_redirect = ! empty( $_REQUEST['redirect_to'] ) ? $_REQUEST['redirect_to'] : '';
/**
* Filter the registration redirect URL.
* Filters the registration redirect URL.
*
* @since 3.0.0
*
@ -804,7 +805,7 @@ default:
$requested_redirect_to = isset( $_REQUEST['redirect_to'] ) ? $_REQUEST['redirect_to'] : '';
/**
* Filter the login redirect URL.
* Filters the login redirect URL.
*
* @since 3.0.0
*
@ -871,7 +872,7 @@ default:
}
/**
* Filter the login page errors.
* Filters the login page errors.
*
* @since 3.6.0
*

4
wp-mail.php
View File

@ -163,7 +163,7 @@ for ( $i = 1; $i <= $count; $i++ ) {
$content = trim($content);
/**
* Filter the original content of the email.
* Filters the original content of the email.
*
* Give Post-By-Email extending plugins full access to the content, either
* the raw content, or the content of the last quoted-printable section.
@ -189,7 +189,7 @@ for ( $i = 1; $i <= $count; $i++ ) {
$content = trim($content);
/**
* Filter the content of the post submitted by email before saving.
* Filters the content of the post submitted by email before saving.
*
* @since 1.2.0
*

15
wp-signup.php
View File

@ -275,7 +275,7 @@ function signup_another_blog( $blogname = '', $blog_title = '', $errors = '' ) {
);
/**
* Filter the default site sign-up variables.
* Filters the default site sign-up variables.
*
* @since 3.0.0
*
@ -386,7 +386,7 @@ function validate_another_blog_signup() {
}
/**
* Filter the new site meta variables.
* Filters the new site meta variables.
*
* @since MU
* @deprecated 3.0.0 Use the 'add_signup_meta' filter instead.
@ -396,7 +396,7 @@ function validate_another_blog_signup() {
$meta_defaults = apply_filters( 'signup_create_blog_meta', $blog_meta_defaults );
/**
* Filter the new default site meta variables.
* Filters the new default site meta variables.
*
* @since 3.0.0
*
@ -494,7 +494,7 @@ function signup_user( $user_name = '', $user_email = '', $errors = '' ) {
);
/**
* Filter the default user variables used on the user sign-up form.
* Filters the default user variables used on the user sign-up form.
*
* @since 3.0.0
*
@ -616,7 +616,7 @@ function signup_blog($user_name = '', $user_email = '', $blogname = '', $blog_ti
);
/**
* Filter the default site creation variables for the site sign-up form.
* Filters the default site creation variables for the site sign-up form.
*
* @since 3.0.0
*
@ -758,7 +758,7 @@ function confirm_blog_signup( $domain, $path, $blog_title, $user_name = '', $use
*/
function signup_get_available_languages() {
/**
* Filter the list of available languages for front-end site signups.
* Filters the list of available languages for front-end site signups.
*
* Passing an empty array to this hook will disable output of the setting on the
* signup form, and the default language will be used when creating the site.
@ -782,8 +782,9 @@ function signup_get_available_languages() {
// Main
$active_signup = get_site_option( 'registration', 'none' );
/**
* Filter the type of site sign-up.
* Filters the type of site sign-up.
*
* @since 3.0.0
*

2
xmlrpc.php
View File

@ -71,7 +71,7 @@ include_once(ABSPATH . WPINC . '/class-wp-xmlrpc-server.php');
$post_default_title = "";
/**
* Filter the class used for handling XML-RPC requests.
* Filters the class used for handling XML-RPC requests.
*
* @since 3.1.0
*