get_site_by_path


get_site_by_path ( $domain, $path, $segments = null )

Parameters:
  • (string) $domain Domain to check.
  • (string) $path Path to check.
  • (int|null) $segments Path segments to use. Defaults to null, or the full path.
Returns:
  • (WP_Site|false) Site object if successful. False when no site is found.
Defined at:
Change Log:
  • 4: .

Description

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

Related Functions

get_page_by_path, get_category_by_path, get_network_by_path, get_site_option, get_sitestats

Top Google Results

User discussions

wpseek mobile