Функция network_home_url()

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

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

Функция возвращает строку. Это ссылка на главный URL, к которой может быть добавлен дополнительный путь.

Синтаксис функции

network_home_url( $path = '', $scheme = null );

Параметры

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

По умолчанию этот параметр равен null, и будет использоваться протокол, определяемый функцией is_ssl().

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

Пример 1: Получение ссылки на главную страницу сети

echo network_home_url();
// Вывод: http://www.example.com (в зависимости от ваших настроек)

Этот код вернёт URL главной страницы вашей сети сайтов.

Код функции

Ниже представлен код функции network_home_url(), который находится в файле wp-includes/link-template.php.

function network_home_url( $path = '', $scheme = null ) {
if ( ! is_multisite() ) {
return home_url( $path, $scheme );
}

$current_network = get_network();
$orig_scheme     = $scheme;

if ( ! in_array( $scheme, array( 'http', 'https', 'relative' ), true ) ) {
    $scheme = is_ssl() ? 'https' : 'http';
}

if ( 'relative' === $scheme ) {
    $url = $current_network->path;
} else {
    $url = set_url_scheme( 'http://' . $current_network->domain . $current_network->path, $scheme );
}

if ( $path && is_string( $path ) ) {
    $url .= ltrim( $path, '/' );
}

/**
 * Ф��льтр для изменения главного URL сети.
 *
 * @since 3.0.0
 *
 * @param string      $url         Полный главный URL сети, включая протокол и путь.
 * @param string      $path        Путь относительно главного URL сети. По умолчанию пустая строка.
 * @param string|null $orig_scheme  Протокол для формирования URL. Принимает 'http', 'https', 'relative' или null.
 */
return apply_filters( 'network_home_url', $url, $path, $orig_scheme );

}

Заключение

Функция network_home_url() — это мощный инструмент для работы с многоуровневыми сайтами в WordPress. Она позволяет легко формировать корректные URL-адреса для главных страниц сетей. Понимание этой функции и её параметров поможет вам лучше управлять вашей сетью сайтов.