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

Props stevenlinx.
Fixes #38152.

Built from https://develop.svn.wordpress.org/trunk@38781


git-svn-id: http://core.svn.wordpress.org/trunk@38724 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Jeremy Felt 2016-10-12 01:10:29 +00:00
parent 61c95f84f6
commit a9290f631b
2 changed files with 9 additions and 2 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 3.9.0
* @since 4.7.0 Updated to always return a `WP_Site` object. * @since 4.7.0 Updated to always return a `WP_Site` object.

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.7-alpha-38780'; $wp_version = '4.7-alpha-38781';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.