iis7_add_rewrite_rule( string $filename, string $rewrite_rule ): bool

Compatibility

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

Parameters

$filenamestring

The file path to the configuration file.

$rewrite_rulestring

The XML fragment with URL Rewrite rule.

Return value

bool

Performance profile

How much work a call to iis7_add_rewrite_rule() 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

Heavy

Reads or writes the filesystem via file_exists().

Scaling

Constant

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

Instructions

5–115

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

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 it touches

• filesystemfilesystem accessfile_exists()called directly
• sqldatabase query->query()called directly

What one call costs · 15 distinct outcomes

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

Uses · 3

• saveDomDocument()Saves the XML document into a file.
• DOMDocument::__construct()
• DOMXPath::__construct()

Used by · 1

• iis7_save_url_rewrite_rules()Updates the IIS web.config file with the current rules if it is writable.

Source code

View on Trac ↗View on GitHub ↗

894function iis7_add_rewrite_rule( $filename, $rewrite_rule ) {895	if ( ! class_exists( 'DOMDocument', false ) ) {896		return false;897	}898 899	// If configuration file does not exist then we create one.900	if ( ! file_exists( $filename ) ) {901		$fp = fopen( $filename, 'w' );902		fwrite( $fp, '<configuration/>' );903		fclose( $fp );904	}905 906	$doc                     = new DOMDocument();907	$doc->preserveWhiteSpace = false;908 909	if ( $doc->load( $filename ) === false ) {910		return false;911	}912 913	$xpath = new DOMXPath( $doc );914 915	// First check if the rule already exists as in that case there is no need to re-add it.916	$wordpress_rules = $xpath->query( '/configuration/system.webServer/rewrite/rules/rule[starts-with(@name,\'wordpress\')] | /configuration/system.webServer/rewrite/rules/rule[starts-with(@name,\'WordPress\')]' );917 918	if ( $wordpress_rules->length > 0 ) {919		return true;920	}921 922	// Check the XPath to the rewrite rule and create XML nodes if they do not exist.923	$xml_nodes = $xpath->query( '/configuration/system.webServer/rewrite/rules' );924 925	if ( $xml_nodes->length > 0 ) {926		$rules_node = $xml_nodes->item( 0 );927	} else {928		$rules_node = $doc->createElement( 'rules' );929 930		$xml_nodes = $xpath->query( '/configuration/system.webServer/rewrite' );931 932		if ( $xml_nodes->length > 0 ) {933			$rewrite_node = $xml_nodes->item( 0 );934			$rewrite_node->appendChild( $rules_node );935		} else {936			$rewrite_node = $doc->createElement( 'rewrite' );937			$rewrite_node->appendChild( $rules_node );938 939			$xml_nodes = $xpath->query( '/configuration/system.webServer' );940 941			if ( $xml_nodes->length > 0 ) {942				$system_web_server_node = $xml_nodes->item( 0 );943				$system_web_server_node->appendChild( $rewrite_node );944			} else {945				$system_web_server_node = $doc->createElement( 'system.webServer' );946				$system_web_server_node->appendChild( $rewrite_node );947 948				$xml_nodes = $xpath->query( '/configuration' );949 950				if ( $xml_nodes->length > 0 ) {951					$config_node = $xml_nodes->item( 0 );952					$config_node->appendChild( $system_web_server_node );953				} else {954					$config_node = $doc->createElement( 'configuration' );955					$doc->appendChild( $config_node );956					$config_node->appendChild( $system_web_server_node );957				}958			}959		}960	}961 962	$rule_fragment = $doc->createDocumentFragment();963	$rule_fragment->appendXML( $rewrite_rule );964	$rules_node->appendChild( $rule_fragment );965 966	$doc->encoding     = 'UTF-8';967	$doc->formatOutput = true;968	saveDomDocument( $doc, $filename );969 970	return true;971}

Changelog

Introduced in 2.8.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.9.7 tag, from src/wp-admin/includes/misc.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.