vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-07-01 15:50:09 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Docs: Various docblock improvements related to user and site signup functionality.

Browse Source 
See #50768


git-svn-id: https://develop.svn.wordpress.org/trunk@49078 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
John Blackbourn
2020-09-30 21:52:27 +00:00
parent 19513ff6a0
commit 02c419aca1
4 changed files with 30 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
src/wp-includes/ms-functions.php
View File

@@ -1575,7 +1575,7 @@ function domain_exists( $domain, $path, $network_id = 1 ) {
}
/**
* Notify a user that their blog activation has been successful.
* Notifies the site administrator that their site activation was successful.
*
* Filter {@see 'wpmu_welcome_notification'} to disable or bypass.
*
@@ -1584,26 +1584,26 @@ function domain_exists( $domain, $path, $network_id = 1 ) {
*
* @since MU (3.0.0)
*
* @param int $blog_id Blog ID.
* @param int $blog_id Site ID.
* @param int $user_id User ID.
* @param string $password User password.
* @param string $password User password, or "N/A" if the user account is not new.
* @param string $title Site title.
* @param array $meta Optional. Signup meta data. By default, contains the requested privacy setting and lang_id.
* @return bool
* @return bool Whether the email notification was sent.
*/
function wpmu_welcome_notification( $blog_id, $user_id, $password, $title, $meta = array() ) {
$current_network = get_network();
/**
* Filters whether to bypass the welcome email after site activation.
* Filters whether to bypass the welcome email sent to the site administrator after site activation.
*
* Returning false disables the welcome email.
*
* @since MU (3.0.0)
*
* @param int|bool $blog_id Blog ID.
* @param int $user_id User ID.
* @param string $password User password.
* @param int|bool $blog_id Site ID.
* @param int $user_id User ID of the site administrator.
* @param string $password User password, or "N/A" if the user account is not new.
* @param string $title Site title.
* @param array $meta Signup meta data. By default, contains the requested privacy setting and lang_id.
*/
@@ -1645,16 +1645,16 @@ We hope you enjoy your new site. Thanks!
$welcome_email = str_replace( 'PASSWORD', $password, $welcome_email );
/**
* Filters the content of the welcome email after site activation.
* Filters the content of the welcome email sent to the site administrator after site activation.
*
* Content should be formatted for transmission via wp_mail().
*
* @since MU (3.0.0)
*
* @param string $welcome_email Message body of the email.
* @param int $blog_id Blog ID.
* @param int $user_id User ID.
* @param string $password User password.
* @param int $blog_id Site ID.
* @param int $user_id User ID of the site administrator.
* @param string $password User password, or "N/A" if the user account is not new.
* @param string $title Site title.
* @param array $meta Signup meta data. By default, contains the requested privacy setting and lang_id.
*/
@@ -1678,7 +1678,7 @@ We hope you enjoy your new site. Thanks!
$subject = __( 'New %1$s Site: %2$s' );
/**
* Filters the subject of the welcome email after site activation.
* Filters the subject of the welcome email sent to the site administrator after site activation.
*
* @since MU (3.0.0)
*