W3cubDocs

/WordPress

force_ssl_admin( string|bool $force = null )

Whether to force SSL used for the Administration Screens.

Parameters

$force

(string|bool) (Optional) Whether to force SSL in admin screens.

Default value: null

Return

(bool) True if forced, false if not forced.

More Information

Determine whether the administration panel should be viewed over SSL. This function relies on the FORCE_SSL_ADMIN constant that is set in the wp-config.php file if you’re using your site over SSL.

The force parameter will change the return value of this function until it is reset.

Source

File: wp-includes/functions.php 

function force_ssl_admin( $force = null ) {
	static $forced = false;

	if ( ! is_null( $force ) ) {
		$old_forced = $forced;
		$forced     = $force;
		return $old_forced;
	}

	return $forced;
}

Used By

Used By Description
wp-includes/rest-api.php: get_rest_url()

Retrieves the URL to a REST endpoint on a site.
wp-includes/pluggable.php: auth_redirect()

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

Whether SSL login should be forced.
wp-includes/default-constants.php: wp_ssl_constants()

Defines SSL-related WordPress constants.
wp-includes/link-template.php: set_url_scheme()

Sets the scheme for a URL.

Changelog

Version Description
2.6.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/force_ssl_admin