wppaste
WordPress

filter_SSL( string $url ): string

Since
2.8.5
Source
wp-includes/ms-functions.php:2467
Formats a URL to use https.

Description

Useful as a filter.

Compatibility

WordPress
since 2.8.5
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$urlstring
URL.

Return value

string
URL with https as the scheme.

Performance profile

How much work a call to filter_SSL() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class
Moderate

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
7–15

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 19.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

  • optionoption read or writeget_option()one call below filter_SSL()
  • hookthird-party callbacksapply_filters()one call below filter_SSL()

Further down the call graph this can also reach cache, serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 4 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost filter_SSL() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
is_string($url) && !force_ssl_content()7force_ssl_content()
!is_string($url)7get_bloginfo()
is_string($url) && force_ssl_content() && !is_ssl()10force_ssl_content(), is_ssl()
is_string($url) && force_ssl_content() && is_ssl()15force_ssl_content(), is_ssl(), set_url_scheme()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 19 instructions, 7–15 executed per call, 3 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 4

Source code

View on Trac View on GitHub 

function filter_SSL( $url ) {  // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid	if ( ! is_string( $url ) ) {		return get_bloginfo( 'url' ); // Return home site URL with proper scheme.	} 	if ( force_ssl_content() && is_ssl() ) {		$url = set_url_scheme( $url, 'https' );	} 	return $url;}

Changelog

Introduced in 2.8.5. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/ms-functions.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.