pre_get_site_by_path – Hook | Developer.WordPress.org

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.

$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.

$pre = apply_filters( 'pre_get_site_by_path', null, $domain, $path, $segments, $paths );

Used by	Description
get_site_by_path()`wp-includes/ms-load.php`	Retrieves the closest matching site object by its domain and path.

Version	Description
3.9.0	Introduced.

You must log in before being able to contribute a note or feedback.