Changeset 41596

Timestamp:

09/26/2017 12:11:56 AM (8 years ago)

Author:

flixos90

Message:

Multisite: Fix documentation issues for domain_exists().

Props stevenlinx.
Fixes #41619.

File:

• trunk/src/wp-includes/ms-functions.php (modified) (2 diffs)

trunk/src/wp-includes/ms-functions.php

@@ -1342 +1342 @@
 
 /**
- * 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.
- *
- * @since MU (3.0.0)
- *
- * @global wpdb $wpdb WordPress database abstraction object.
+ * that each site name is unique.
+ *
+ * @since MU (3.0.0)
  *
  * @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 ) {
@@ -1368 +1369 @@
 
     /**
-     * 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.