IntenseWebs/WordPress
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Docs: Document default values for optional parameters in various DocBlocks.

Browse Source 
Props paulkevan, costdev, audrasjb, SergeyBiryukov.
See #56792.
Built from https://develop.svn.wordpress.org/trunk@55398


git-svn-id: http://core.svn.wordpress.org/trunk@54931 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov
2023-02-21 16:39:19 +00:00
parent 9b806a3114
commit 77dfc892fe
17 changed files with 110 additions and 78 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
wp-includes/ms-functions.php
View File

@@ -330,7 +330,7 @@ function get_blog_permalink( $blog_id, $post_id ) {
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param string $domain Website domain.
* @param string $path Optional. Not required for subdomain installations.
* @param string $path Optional. Not required for subdomain installations. Default '/'.
* @return int 0 if no blog found, otherwise the ID of the matching blog.
*/
function get_blog_id_from_url( $domain, $path = '/' ) {
@@ -606,6 +606,7 @@ function wpmu_validate_user_signup( $user_name, $user_email ) {
* @param string $blogname The blog name provided by the user. Must be unique.
* @param string $blog_title The blog title provided by the user.
* @param WP_User|string $user Optional. The user object to check against the new site name.
* Default empty string.
* @return array {
* Array of domain, path, blog name, blog title, user and error messages.
*
@@ -1354,6 +1355,7 @@ function wpmu_create_user( $user_name, $password, $email ) {
* updated. Otherwise, keys and values will be used to set options for
* the new site. Default empty array.
* @param int $network_id Optional. Network ID. Only relevant on multi-network installations.
* Default 1.
* @return int|WP_Error Returns WP_Error object on failure, the new site ID on success.
*/
function wpmu_create_blog( $domain, $path, $title, $user_id, $options = array(), $network_id = 1 ) {
@@ -1539,7 +1541,8 @@ Disable these notifications: %3$s'
*
* @param string $domain The domain to be checked.
* @param string $path The path to be checked.
* @param int $network_id Optional. Network ID. Relevant only on multi-network installations.
* @param int $network_id Optional. Network ID. Only relevant on multi-network installations.
* Default 1.
* @return int|null The site ID if the site name exists, null otherwise.
*/
function domain_exists( $domain, $path, $network_id = 1 ) {
@@ -1566,7 +1569,7 @@ function domain_exists( $domain, $path, $network_id = 1 ) {
* @param int|null $result The site ID if the site name exists, null otherwise.
* @param string $domain Domain to be checked.
* @param string $path Path to be checked.
* @param int $network_id Network ID. Relevant only on multi-network installations.
* @param int $network_id Network ID. Only relevant on multi-network installations.
*/
return apply_filters( 'domain_exists', $result, $domain, $path, $network_id );
}