функция
since 3.0.0
get_home_url()
Проверено на WordPress 6.9, обновлено Источник: WordPress Developer Resources.
Сигнатура
get_home_url( int|null $blog_id = null, string $path = '', string|null $scheme = null ): string
Описание
Возвращает опцию «home» с подходящим протоколом. Протокол будет «https», если is_ssl() возвращает true; в противном случае он совпадёт с опцией «home».
Если $scheme равен «http» или «https», значение is_ssl() переопределяется.
Параметры
$blog_id
int|null
необязательный
= null
ID сайта. Значение по умолчанию null (текущий сайт).
$path
string
необязательный
= ''
Путь относительно домашнего URL.
$scheme
string|null
необязательный
= null
Схема, задающая контекст домашнего URL. Принимает 'http', 'https', 'relative', 'rest' или null.
Возвращаемое значение
string
Исходный код
wp-includes/link-template.php:3460
function get_home_url( $blog_id = null, $path = '', $scheme = null ) {
$orig_scheme = $scheme;
if ( empty( $blog_id ) || ! is_multisite() ) {
$url = get_option( 'home' );
} else {
switch_to_blog( $blog_id );
$url = get_option( 'home' );
restore_current_blog();
}
if ( ! in_array( $scheme, array( 'http', 'https', 'relative' ), true ) ) {
if ( is_ssl() ) {
$scheme = 'https';
} else {
$scheme = parse_url( $url, PHP_URL_SCHEME );
}
}
$url = set_url_scheme( $url, $scheme );
if ( $path && is_string( $path ) ) {
$url .= '/' . ltrim( $path, '/' );
}
/**
* Filters the home URL.
*
* @since 3.0.0
*
* @param string $url The complete home URL including scheme and path.
* @param string $path Path relative to the home URL. Blank string if no path is specified.
* @param string|null $orig_scheme Scheme to give the home URL context. Accepts 'http', 'https',
* 'relative', 'rest', or null.
* @param int|null $blog_id Site ID, or null for the current site.
*/
return apply_filters( 'home_url', $url, $path, $orig_scheme, $blog_id );
}
История изменений
| Версия | Описание |
|---|---|
| 3.0.0 | Introduced. |

