From 06c32bb17c33f484c8e1caf3ffdd8612c52c722f Mon Sep 17 00:00:00 2001
From: Felix Arntz <flixos90@git.wordpress.org>
Date: Tue, 26 Sep 2017 00:11:56 +0000
Subject: [PATCH] Multisite: Fix documentation issues for `domain_exists()`.

Props stevenlinx.
Fixes #41619.


git-svn-id: https://develop.svn.wordpress.org/trunk@41596 602fd350-edb4-49c9-b593-d223f7449a82
---
 src/wp-includes/ms-functions.php | 18 +++++++++++-------
 1 file changed, 11 insertions(+), 7 deletions(-)

diff --git a/src/wp-includes/ms-functions.php b/src/wp-includes/ms-functions.php
index a2e71ba32f..7bfd9f968e 100644
--- a/src/wp-includes/ms-functions.php
+++ b/src/wp-includes/ms-functions.php
@@ -1341,19 +1341,20 @@ Disable these notifications: %3$s'), $user->user_login, wp_unslash( $_SERVER['RE
 }
 
 /**
- * Check whether a blogname is already taken.
+ * Checks whether a site name is already taken.
+ *
+ * The name is the site's subdomain or the site's subdirectory
+ * path depending on the network settings.
  *
  * Used during the new site registration process to ensure
- * that each blogname is unique.
+ * that each site name is unique.
  *
  * @since MU (3.0.0)
  *
- * @global wpdb $wpdb WordPress database abstraction object.
- *
  * @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.
- * @return int
+ * @return int|null The site ID if the site name exists, null otherwise.
  */
 function domain_exists( $domain, $path, $network_id = 1 ) {
 	$path = trailingslashit( $path );
@@ -1367,11 +1368,14 @@ function domain_exists( $domain, $path, $network_id = 1 ) {
 	$result = array_shift( $result );
 
 	/**
-	 * Filters whether a blogname is taken.
+	 * Filters whether a site name is taken.
+	 *
+	 * The name is the site's subdomain or the site's subdirectory
+	 * path depending on the network settings.
 	 *
 	 * @since 3.5.0
 	 *
-	 * @param int|null $result     The blog_id if the blogname exists, null otherwise.
+	 * @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.