Docs: In various @return tags, list the expected type first, instead of false.

Follow-up to [46696].

See #48303.

git-svn-id: https://develop.svn.wordpress.org/trunk@47060 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov
2020-01-11 18:30:58 +00:00
parent f9e52f8cd3
commit 4c2ee4e9ff
47 changed files with 200 additions and 177 deletions
+5 -5
View File
@@ -95,7 +95,7 @@ do_action( 'before_signup_form' );
*
* @param string $blogname The new site name.
* @param string $blog_title The new site title.
* @param string|WP_Error $errors A WP_Error object containing existing errors. Defaults to empty string.
* @param WP_Error|string $errors A WP_Error object containing existing errors. Defaults to empty string.
*/
function show_blog_form( $blogname = '', $blog_title = '', $errors = '' ) {
if ( ! is_wp_error( $errors ) ) {
@@ -246,7 +246,7 @@ function validate_blog_form() {
*
* @param string $user_name The entered username.
* @param string $user_email The entered email address.
* @param string|WP_Error $errors A WP_Error object containing existing errors. Defaults to empty string.
* @param WP_Error|string $errors A WP_Error object containing existing errors. Defaults to empty string.
*/
function show_user_form( $user_name = '', $user_email = '', $errors = '' ) {
if ( ! is_wp_error( $errors ) ) {
@@ -304,7 +304,7 @@ function validate_user_form() {
*
* @param string $blogname The new site name
* @param string $blog_title The new site title.
* @param string|WP_Error $errors A WP_Error object containing existing errors. Defaults to empty string.
* @param WP_Error|string $errors A WP_Error object containing existing errors. Defaults to empty string.
*/
function signup_another_blog( $blogname = '', $blog_title = '', $errors = '' ) {
$current_user = wp_get_current_user();
@@ -553,7 +553,7 @@ function confirm_another_blog_signup( $domain, $path, $blog_title, $user_name, $
*
* @param string $user_name The username.
* @param string $user_email The user's email.
* @param string|WP_Error $errors A WP_Error object containing existing errors. Defaults to empty string.
* @param WP_Error|string $errors A WP_Error object containing existing errors. Defaults to empty string.
*/
function signup_user( $user_name = '', $user_email = '', $errors = '' ) {
global $active_signup;
@@ -691,7 +691,7 @@ function confirm_user_signup( $user_name, $user_email ) {
* @param string $user_email The user's email address.
* @param string $blogname The site name.
* @param string $blog_title The site title.
* @param string|WP_Error $errors A WP_Error object containing existing errors. Defaults to empty string.
* @param WP_Error|string $errors A WP_Error object containing existing errors. Defaults to empty string.
*/
function signup_blog( $user_name = '', $user_email = '', $blogname = '', $blog_title = '', $errors = '' ) {
if ( ! is_wp_error( $errors ) ) {