wppaste
WordPress

Cookie::path_matches( string $request_path ): boolean

Source
wp-includes/Requests/src/Cookie.php:234
Check if a cookie is valid for a given path

Description

From the path-match check in RFC 6265 section 5.1.4

Compatibility

WordPress
core
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

$request_pathstring
Path to check

Return value

boolean
Whether the cookie is valid for the given path

Performance profile

How much work a call to Cookie::path_matches() 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
7–32

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

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 one call costs · 1 distinct outcome

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

WhenInstructionsCalls it makes
always7–32none

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev377–328
8.5377–328
8.4377–3289 fewer instructions than PHP 8.3
8.3467–418
8.2467–418
8.1467–4182 fewer instructions than PHP 7.4
7.4487–438

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.

Source code

	public function path_matches($request_path) {		if (empty($request_path)) {			// Normalize empty path to root			$request_path = '/';		} 		if (!isset($this->attributes['path'])) {			// Cookies created manually; cookies created by Requests will set			// the path to the requested path			return true;		} 		if (is_scalar($request_path) === false) {			return false;		} 		$cookie_path = $this->attributes['path']; 		if ($cookie_path === $request_path) {			// The cookie-path and the request-path are identical.			return true;		} 		if (strlen($request_path) > strlen($cookie_path) && substr($request_path, 0, strlen($cookie_path)) === $cookie_path) {			if (substr($cookie_path, -1) === '/') {				// The cookie-path is a prefix of the request-path, and the last				// character of the cookie-path is %x2F ("/").				return true;			} 			if (substr($request_path, strlen($cookie_path), 1) === '/') {				// The cookie-path is a prefix of the request-path, and the				// first character of the request-path that is not included in				// the cookie-path is a %x2F ("/") character.				return true;			}		} 		return false;	}

Changelog

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/Requests/src/Cookie.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.