函数文档

get_site_by_path()

💡 云策文档标注

概述

get_site_by_path() 函数用于根据域名和路径检索最匹配的站点对象,主要用于多站点引导过程中匹配请求的站点地址。它不保证返回精确匹配,而是通过分解域名和路径片段来查询最接近的可能性。

关键要点

  • 函数返回 WP_Site 对象或 false,用于多站点环境中的站点识别。
  • 参数包括 $domain(域名)、$path(路径)和可选的 $segments(路径段数),默认 null 表示使用完整路径。
  • 内部逻辑包括路径分段处理、域名处理(支持 www 和非 www 变体)以及通过 get_sites() 进行查询。
  • 提供两个过滤器钩子:site_by_path_segments_count 用于调整路径段数,pre_get_site_by_path 用于短路默认逻辑。
  • 自 WordPress 3.9.0 引入,4.7.0 更新为始终返回 WP_Site 对象。

代码示例

function get_site_by_path( $domain, $path, $segments = null ) {
    $path_segments = array_filter( explode( '/', trim( $path, '/' ) ) );
    $segments = apply_filters( 'site_by_path_segments_count', $segments, $domain, $path );
    if ( null !== $segments && count( $path_segments ) > $segments ) {
        $path_segments = array_slice( $path_segments, 0, $segments );
    }
    $paths = array();
    while ( count( $path_segments ) ) {
        $paths[] = '/' . implode( '/', $path_segments ) . '/';
        array_pop( $path_segments );
    }
    $paths[] = '/';
    $pre = apply_filters( 'pre_get_site_by_path', null, $domain, $path, $segments, $paths );
    if ( null !== $pre ) {
        if ( false !== $pre && ! $pre instanceof WP_Site ) {
            $pre = new WP_Site( $pre );
        }
        return $pre;
    }
    $domains = array( $domain );
    if ( str_starts_with( $domain, 'www.' ) ) {
        $domains[] = substr( $domain, 4 );
    }
    $args = array(
        'number'                 => 1,
        'update_site_meta_cache' => false,
    );
    if ( count( $domains ) > 1 ) {
        $args['domain__in']               = $domains;
        $args['orderby']['domain_length'] = 'DESC';
    } else {
        $args['domain'] = array_shift( $domains );
    }
    if ( count( $paths ) > 1 ) {
        $args['path__in']               = $paths;
        $args['orderby']['path_length'] = 'DESC';
    } else {
        $args['path'] = array_shift( $paths );
    }
    $result = get_sites( $args );
    $site   = array_shift( $result );
    if ( $site ) {
        return $site;
    }
    return false;
}

注意事项

  • 函数设计用于多站点引导,可能不适用于所有精确匹配场景。
  • 使用过滤器钩子可以自定义路径段数或短路查询逻辑,但需注意返回类型处理。
  • 域名处理支持 www 前缀的变体,查询时优先匹配较长域名。
  • 路径查询基于分解的片段,从完整路径逐步缩短以找到最匹配项。

📄 原文内容

Retrieves the closest matching site object by its domain and path.

Description

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

Parameters

$domainstringrequired
Domain to check.
$pathstringrequired
Path to check.
$segmentsint|nulloptional
Path segments to use. Defaults to null, or the full path.

Default:null

Return

WP_Site|false Site object if successful. False when no site is found.

Source

function get_site_by_path( $domain, $path, $segments = null ) {
	$path_segments = array_filter( explode( '/', trim( $path, '/' ) ) );

	/**
	 * Filters the number of path segments to consider when searching for a site.
	 *
	 * @since 3.9.0
	 *
	 * @param int|null $segments The number of path segments to consider. WordPress by default looks at
	 *                           one path segment following the network path. The function default of
	 *                           null only makes sense when you know the requested path should match a site.
	 * @param string   $domain   The requested domain.
	 * @param string   $path     The requested path, in full.
	 */
	$segments = apply_filters( 'site_by_path_segments_count', $segments, $domain, $path );

	if ( null !== $segments && count( $path_segments ) > $segments ) {
		$path_segments = array_slice( $path_segments, 0, $segments );
	}

	$paths = array();

	while ( count( $path_segments ) ) {
		$paths[] = '/' . implode( '/', $path_segments ) . '/';
		array_pop( $path_segments );
	}

	$paths[] = '/';

	/**
	 * 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.
	 *
	 * @since 3.9.0
	 *
	 * @param null|false|WP_Site $site     Site value to return by path. Default null
	 *                                     to continue retrieving the site.
	 * @param string             $domain   The requested domain.
	 * @param string             $path     The requested path, in full.
	 * @param int|null           $segments The suggested number of paths to consult.
	 *                                     Default null, meaning the entire path was to be consulted.
	 * @param string[]           $paths    The paths to search for, based on $path and $segments.
	 */
	$pre = apply_filters( 'pre_get_site_by_path', null, $domain, $path, $segments, $paths );
	if ( null !== $pre ) {
		if ( false !== $pre && ! $pre instanceof WP_Site ) {
			$pre = new WP_Site( $pre );
		}
		return $pre;
	}

	/*
	 * @todo
	 * Caching, etc. Consider alternative optimization routes,
	 * perhaps as an opt-in for plugins, rather than using the pre_* filter.
	 * For example: The segments filter can expand or ignore paths.
	 * If persistent caching is enabled, we could query the DB for a path <> '/'
	 * then cache whether we can just always ignore paths.
	 */

	/*
	 * Either www or non-www is supported, not both. If a www domain is requested,
	 * query for both to provide the proper redirect.
	 */
	$domains = array( $domain );
	if ( str_starts_with( $domain, 'www.' ) ) {
		$domains[] = substr( $domain, 4 );
	}

	$args = array(
		'number'                 => 1,
		'update_site_meta_cache' => false,
	);

	if ( count( $domains ) > 1 ) {
		$args['domain__in']               = $domains;
		$args['orderby']['domain_length'] = 'DESC';
	} else {
		$args['domain'] = array_shift( $domains );
	}

	if ( count( $paths ) > 1 ) {
		$args['path__in']               = $paths;
		$args['orderby']['path_length'] = 'DESC';
	} else {
		$args['path'] = array_shift( $paths );
	}

	$result = get_sites( $args );
	$site   = array_shift( $result );

	if ( $site ) {
		return $site;
	}

	return false;
}

Hooks

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.

apply_filters( ‘site_by_path_segments_count’, int|null $segments, string $domain, string $path )

Filters the number of path segments to consider when searching for a site.

Changelog

Version Description
4.7.0 Updated to always return a WP_Site object.
3.9.0 Introduced.