云策 WordPress 开发者社区

函数文档

is_ssl()

查看官方原文 ↗
💡 云策文档标注

概述

is_ssl() 函数用于检测当前页面是否使用 SSL（HTTPS）。它通过检查 $_SERVER['HTTPS'] 或服务器端口 443 来判断，返回布尔值 true 或 false。

关键要点

  • 函数返回 true 如果页面使用 SSL，否则返回 false。
  • 检测机制基于 $_SERVER['HTTPS'] 是否为 'on' 或 '1'，或 $_SERVER['SERVER_PORT'] 是否为 443。
  • 在某些负载均衡器或反向代理环境下（如 Network Solutions），is_ssl() 可能失效，需要额外配置。
  • 对于支持 HTTP_X_FORWARDED_PROTO 的环境，可通过修改 wp-config.php 文件来修复。
  • 函数自 WordPress 2.6.0 引入，4.6.0 版本从 functions.php 移至 load.php。

代码示例

if (isset($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https')
    $_SERVER['HTTPS'] = 'on';

注意事项

  • 在负载均衡器后使用时，is_ssl() 可能无法正确检测 SSL，需根据环境调整配置。
  • 如果无法修改 $_SERVER 变量（如 Azure App Services），可能需要直接修改 is_ssl() 函数或使用替代函数。
  • 用户贡献笔记提供了针对 Cloudflare 和其他代理的扩展检测函数示例。
📄 原文内容

Determines if SSL is used.

Return

bool True if SSL, otherwise false.

More Information

Returns true if the page is using SSL (checks if HTTPS or on Port 443).

NB: this won’t work for websites behind some load balancers, especially Network Solutions hosted websites. To body up a fix, save this gist into the plugins folder and enable it. For details, read WordPress is_ssl() doesn’t work behind some load balancers.

Websites behind load balancers or reverse proxies that support HTTP_X_FORWARDED_PROTO can be fixed by adding the following code to the wp-config.php file, above the require_once call:

if (isset($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https')
$_SERVER['HTTPS'] = 'on';

Source

function is_ssl() {
	if ( isset( $_SERVER['HTTPS'] ) ) {
		if ( 'on' === strtolower( $_SERVER['HTTPS'] ) ) {
			return true;
		}

		if ( '1' === (string) $_SERVER['HTTPS'] ) {
			return true;
		}
	} elseif ( isset( $_SERVER['SERVER_PORT'] ) && ( '443' === (string) $_SERVER['SERVER_PORT'] ) ) {
		return true;
	}

	return false;
}

View all references View on Trac View on GitHub

Used by Description
WP_Debug_Data::get_wp_core()wp-admin/includes/class-wp-debug-data.php

Gets the WordPress core section of the debug data.
wp_is_application_passwords_supported()wp-includes/user.php

Checks if Application Passwords is supported.
WP_Recovery_Mode::redirect_protected()wp-includes/class-wp-recovery-mode.php

Redirects the current request to allow recovering multiple errors in one go.
WP_Recovery_Mode_Cookie_Service::set_cookie()wp-includes/class-wp-recovery-mode-cookie-service.php

Sets the recovery mode cookie.
WP_Site_Health::get_test_https_status()wp-admin/includes/class-wp-site-health.php

Tests if the site is serving content over HTTPS.
WP_Customize_Manager::get_allowed_urls()wp-includes/class-wp-customize-manager.php

Gets URLs allowed to be previewed.
ms_load_current_site_and_network()wp-includes/ms-load.php

Identifies the network and site of a requested domain and path and populates the corresponding network and site global objects as part of the multisite bootstrap process.
get_rest_url()wp-includes/rest-api.php

Retrieves the URL to a REST endpoint on a site.
wp_calculate_image_srcset()wp-includes/media.php

A helper function to calculate the image sources to include in a ‘srcset’ attribute.
wp_admin_bar_customize_menu()wp-includes/admin-bar.php

Adds the “Customize” link to the Toolbar.
wp_ajax_parse_embed()wp-admin/includes/ajax-actions.php

Applies Ajax handlers to a string.
wp_dashboard_browser_nag()wp-admin/includes/dashboard.php

Displays the browser update nag.
wp_parse_auth_cookie()wp-includes/pluggable.php

Parses a cookie into its components.
wp_set_auth_cookie()wp-includes/pluggable.php

Sets the authentication cookies for a given user ID.
auth_redirect()wp-includes/pluggable.php

Checks if a user is logged in, if not it redirects them to the login page.
wp_login_form()wp-includes/general-template.php

Provides a simple login form for use anywhere within WordPress.
wp_auth_check_html()wp-includes/functions.php

Outputs the HTML that shows the wp-login dialog when the user is no longer logged in.
wp_guess_url()wp-includes/functions.php

Guesses the URL for the site.
set_url_scheme()wp-includes/link-template.php

Sets the scheme for a URL.
network_home_url()wp-includes/link-template.php

Retrieves the home URL for the current network.
get_home_url()wp-includes/link-template.php

Retrieves the URL for a given site where the front end is accessible.
wp_signon()wp-includes/user.php

Authenticates and logs a user in with ‘remember’ capability.
wp_get_attachment_url()wp-includes/post.php

Retrieves the URL for an attachment.
redirect_canonical()wp-includes/canonical.php

Redirects incoming links to the proper URL based on the site url.
filter_SSL()wp-includes/ms-functions.php

Formats a URL to use https.

Show 20 moreShow less

Changelog

Version Description
4.6.0 Moved from functions.php to load.php.
2.6.0 Introduced.

User Contributed Notes

  1. Skip to note 3 content


    Codex


    You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this note

    With load balancers

    It won’t work for websites behind some load balancers, especially Network Solutions hosted websites. To bodgy up a fix, save this gist into the plugins folder and enable it. For details, read “WordPress is_ssl() doesn’t work behind some load balancers.”

    Websites behind load balancers or reverse proxies that support HTTP_X_FORWARDED_PROTO can be fixed by adding the following code to the wp-config.php file, above the require_once call:

    if (isset($_SERVER['HTTP_X_FORWARDED_PROTO']) && $_SERVER['HTTP_X_FORWARDED_PROTO'] == 'https')
    $_SERVER['HTTPS'] = 'on';

  2. Skip to note 4 content


    Nawawi Jamili


    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

    if behind web proxy/balancer, can use this function.

    function wpdocs_maybe_is_ssl() {
    // cloudflare
    if ( ! empty( $_SERVER['HTTP_CF_VISITOR'] ) ) {
        $cfo = json_decode( $_SERVER['HTTP_CF_VISITOR'] );
        if ( isset( $cfo->scheme ) && 'https' === $cfo->scheme ) {
            return true;
        }
    }

    // other proxy
    if ( ! empty( $_SERVER['HTTP_X_FORWARDED_PROTO'] ) && 'https' === $_SERVER['HTTP_X_FORWARDED_PROTO'] ) {
        return true;
    }

    return function_exists( 'is_ssl' ) ? is_ssl() : false;
}