pre_get_site_by_path WordPress Filter Hook
The pre_get_site_by_path hook is triggered before WordPress attempts to retrieve a site object by its path. This hook can be used to modify the path before WordPress attempts to look up the site, allowing for custom site retrieval rules.
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
- $site
(null|false|WP_Site)Site value to return by path. Default null to continue retrieving the site.
- $domain
(string)The requested domain.
- $path
(string)The requested path, in full.
- $segments
(int|null)The suggested number of paths to consult. Default null, meaning the entire path was to be consulted.
- $paths
(string[])The paths to search for, based on $path and $segments.
Source
File: wp-includes/ms-load.php
Changelog
Version | Description |
---|---|
3.9.0 | Introduced. |