wppaste
WordPress

wpdb::parse_db_host( string $host ): array|false

Since
4.9.0
Source
wp-includes/class-wpdb.php:2071
Parses the DB_HOST setting to interpret it for mysqli_real_connect().

Description

mysqli_real_connect() doesn't support the host param including a port or socket like mysql_connect() does. This duplicates how mysql_connect() detects a port and/or socket file.

Compatibility

WordPress
since 4.9.0
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

$hoststring
The DB_HOST setting to parse.

Return value

array|false
Array containing the host, the port, the socket and whether it is an IPv6 address, in that order. False if the host couldn't be parsed.
  • $0string

    Host name.
  • $1string|null

    Port.
  • $2string|null

    Socket.
  • $3bool

    Whether it is an IPv6 address.

Performance profile

How much work a call to wpdb::parse_db_host() 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
Trivial

Touches nothing outside its own arguments.

Scaling
Constant

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

Instructions
22–48

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
1

1 place in core call this, so the cost is paid more often than your own code shows.

What one call costs · 2 distinct outcomes

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

WhenInstructionsCalls it makes
always22–42substr_count(), preg_match()
$result === 1 && !empty($matches)40–48substr_count(), preg_match(), absint()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev5122–4751 fewer instruction than PHP 8.5
8.55222–485
8.45222–48510 fewer instructions than PHP 8.3
8.36225–585
8.26225–585
8.16225–5851 fewer instruction than PHP 7.4
7.46325–595

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 · 1

  • absint()Converts a value to non-negative integer.

Used by · 1

Source code

	public function parse_db_host( $host ) {		$socket  = null;		$is_ipv6 = false; 		// First peel off the socket parameter from the right, if it exists.		$socket_pos = strpos( $host, ':/' );		if ( false !== $socket_pos ) {			$socket = substr( $host, $socket_pos + 1 );			$host   = substr( $host, 0, $socket_pos );		} 		/*		 * We need to check for an IPv6 address first.		 * An IPv6 address will always contain at least two colons.		 */		if ( substr_count( $host, ':' ) > 1 ) {			$pattern = '#^(?:\[)?(?P<host>[0-9a-fA-F:]+)(?:\]:(?P<port>[\d]+))?#';			$is_ipv6 = true;		} else {			// We seem to be dealing with an IPv4 address.			$pattern = '#^(?P<host>[^:/]*)(?::(?P<port>[\d]+))?#';		} 		$matches = array();		$result  = preg_match( $pattern, $host, $matches ); 		if ( 1 !== $result ) {			// Couldn't parse the address, bail.			return false;		} 		$host = ! empty( $matches['host'] ) ? $matches['host'] : '';		// MySQLi port cannot be a string; must be null or an integer.		$port = ! empty( $matches['port'] ) ? absint( $matches['port'] ) : null; 		return array( $host, $port, $socket, $is_ipv6 );	}

Changelog

Introduced in 4.9.0. 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 6.8.8 tag, from src/wp-includes/class-wpdb.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.