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

Props stevenlinx.
Fixes #38152.


git-svn-id: https://develop.svn.wordpress.org/trunk@38781 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Jeremy Felt 2016-10-12 01:09:29 +00:00
parent 23bf03c3be
commit 1d2db9eade
1 changed files with 8 additions and 1 deletions

View File

@ -134,7 +134,14 @@ function get_network_by_path( $domain, $path, $segments = null ) {
}
/**
* 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
* @since 4.7.0 Updated to always return a `WP_Site` object.