A WordPress-centric search engine for devs and theme authors

pre_get_site_by_path › WordPress Filter Hooks

apply_filters( 'pre_get_site_by_path', null, $domain, $path, $segments, $paths )
Parameters: (5)
  • (null|false|WP_Site) $site Site value to return by path. Default null to continue retrieving the site.
    Required: Yes
  • (string) $domain The requested domain.
    Required: Yes
  • (string) $path The requested path, in full.
    Required: Yes
  • (int|null) $segments The suggested number of paths to consult. Default null, meaning the entire path was to be consulted.
    Required: Yes
  • (string[]) $paths The paths to search for, based on $path and $segments.
    Required: Yes
Defined at:

Determines a site by its domain and path.

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.


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