HOME_URL() │ WP 3.0.0

Функция HOME_URL() возвращает URL (адрес) текущего сайта, который доступен на фронтенде (то есть пользователи могут его видеть).

Описание функции

Функция возвращает значение опции 'home' с указанным протоколом. Если используется SSL (защищенный протокол, значит адрес начинается с "https"), то протокол будет 'https'. В противном случае он будет соответствовать значению опции 'home'. Если значение параметра $scheme это 'http' или 'https', то проверка SSL будет проигнорирована.

Время выполнения

• 1 раз — 0.000047 сек (очень быстро)
• 50000 раз — 0.51 сек (очень быстро)

Возвращаемое значение

Функция возвращает строку — ссылку на домашний URL с добавленным (при необходимости) путем.

Использование функции

home_url( $path, $scheme );

Параметры

• $path (строка) — Путь, относительный к домашнему URL. По умолчанию: '' (пустая строка).
• $scheme (строка или null) — Протокол, позволяющий задать контекст для домашнего URL. Принимает значения 'http', 'https', 'relative', 'rest' или null. По умолчанию: null.

Примеры использования

Получение адреса сайта

echo home_url();                       // http://example.com
echo home_url('/');                    // http://example.com/
echo home_url('blog', 'relative');     // /blog
echo home_url('blog');                 // https://example.com/blog
echo home_url('/blog', 'https');       // https://example.com/blog
echo home_url('#hash', 'https');       // https://example.com/#hash
echo home_url('//foo.bar/foo');        // http://example.com/foo.bar/foo
echo home_url('http://foo.bar/foo');   // http://example.com/http://foo.bar/foo
echo home_url('/mypage?id=123');       // https://example.com/mypage?id=123

Примечание

Если ваша установка WordPress находи��ся в подкаталоге, например http://example.com/wp, то результаты будут следующими:

echo home_url(); // https://example.com
echo site_url(); // https://example.com/wp

Изменения

Функция была введена в версии 3.0.0.

Код функции HOME_URL

Функция определяется в файле wp-includes/link-template.php:

function home_url( $path = '', $scheme = null ) {
    return get_home_url( null, $path, $scheme );
}

Связанные функции

• admin_url()
• attachment_url_to_postid()
• build_query()
• comment_link()
• content_url()
• get_comments_link()
• get_home_url()
• site_url()

Другие ресурсы

Функция HOME_URL() полезна не только для получения адреса сайта, но и в различных сценариях разработки темы или плагинов для WordPress. Она позволяет создавать ссылки на страницы вашего сайта с правильным учетом текущего протокола и структуры URL.