On this page
apply_filters( 'pre_get_site_by_path', null|false|WP_Site $site, string $domain, string $path, int|null $segments, string[] $paths )
Determines a site by its domain and path.
Description
This allows one to short-circuit the default logic, perhaps by replacing it with a routine that is more optimal for your setup.
Return null to avoid the short-circuit. Return false if no site can be found at the requested domain and path. Otherwise, return a site object.
Parameters
$sitenull|false|WP_Site-
Site value to return by path. Default null to continue retrieving the site.
$domainstring-
The requested domain.
$pathstring-
The requested path, in full.
$segmentsint|null-
The suggested number of paths to consult.
Default null, meaning the entire path was to be consulted. $pathsstring[]-
The paths to search for, based on $path and $segments.
Source
File: wp-includes/ms-load.php. View all references
$pre = apply_filters( 'pre_get_site_by_path', null, $domain, $path, $segments, $paths );
Related
Used By
| Used By | Description |
|---|---|
| get_site_by_path() wp-includes/ms-load.php | Retrieves the closest matching site object by its domain and path. |
Changelog
| Version | Description |
|---|---|
| 3.9.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/hooks/pre_get_site_by_path