force_ssl_admin( string|bool $force = null )

Whether to force SSL used for the Administration Screens.

Contents

Parameters Parameters

$force

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

Default value: null

Top ↑

Return Return

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

Top ↑

More Information 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.

Top ↑

Source 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;
}

Expand full source code Collapse full source code View on Trac View on GitHub

Top ↑

Top ↑

Used By Used By

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.

Top ↑

Changelog Changelog

Changelog
Version Description
2.6.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

  2. Skip to note 2 content
    You must log in to vote on the helpfulness of this noteVote results for this note: -1You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Changing the Return Value

    <?php
force_ssl_admin(true);
if ( force_ssl_admin() ) {
  echo 'Administration should be performed over SSL';
} else {
  echo 'This code will never execute';
}
force_ssl_admin(false);
if ( force_ssl_admin() ) {
  echo 'This code will never execute';
} else {
  echo 'Administration should NOT be performed over SSL';
}
?>

    Expand full source codeCollapse full source code

You must log in before being able to contribute a note or feedback.