vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-10-05 23:27:04 +00:00
Code Issues Actions Packages 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.

Browse Source 
Fixes #36913.


git-svn-id: https://develop.svn.wordpress.org/trunk@37535 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes
2016-05-23 16:43:20 +00:00
parent 08a0225d5c
commit a1ee08a6db
6 changed files with 31 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/wp-login.php
+17 -16
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
*