Changeset 38781

Timestamp:

10/12/2016 01:09:29 AM (3 years ago)

Author:

jeremyfelt

Message:

Multisite: Clarify that get_site_by_path() does not return exact matches.

Props stevenlinx.
Fixes #38152.

File:

• trunk/src/wp-includes/ms-load.php (modified) (1 diff)

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

@@ -135 +135 @@
 
 /**
- * Retrieve a site object by its domain and path.
+ * Retrieves the closest matching site object by its domain and path.
+ * 
+ * This will not necessarily return an exact match for a domain and path. Instead, it
+ * breaks the domain and path into pieces that are then used to match the closest
+ * possibility from a query.
+ *
+ * The intent of this method is to match a site object during bootstrap for a
+ * requested site address
  *
  * @since 3.9.0