insert_with_markers( string $filename, string $marker, array|string $insertion ): bool

Description

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

Filename to alter.

$markerstring

The marker to alter.

$insertionarray|string

The new content to insert.

Return value

bool

True on write success, false on failure.

Performance profile

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

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

12–135

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

Plugin surface

1 hook

Third-party callbacks on 'insert_with_markers_inline_instructions' run inside this call, and their cost is not bounded by anything here.

Called by

1

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

What it touches

• hookthird-party callbacksapply_filters()called directly
• filesystemfilesystem accessfile_exists()called directly
• optionnetwork optionget_site_option()one call below insert_with_markers()

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 · 50 distinct outcomes

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

Hooks and filters fired · 1

One hook fires while insert_with_markers() runs, in this order:

1. 1
   apply_filters( insert_with_markers_inline_instructions )filterline 164 (+50 into the body)

   Filters the inline instructions inserted before the dynamically generated content.

Uses · 6

• switch_to_locale()Switches the translations according to the given locale.
• get_locale()Retrieves the current locale.
• __()Retrieves the translation of $text.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• restore_previous_locale()Restores the translations according to the previous locale.
• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.

Used by · 1

• save_mod_rewrite_rules()Updates the htaccess file with the current rules if it is writable.

Source code

View on Trac ↗View on GitHub ↗

114function insert_with_markers( $filename, $marker, $insertion ) {115	if ( ! file_exists( $filename ) ) {116		if ( ! is_writable( dirname( $filename ) ) ) {117			return false;118		}119 120		if ( ! touch( $filename ) ) {121			return false;122		}123 124		// Make sure the file is created with a minimum set of permissions.125		$perms = fileperms( $filename );126 127		if ( $perms ) {128			chmod( $filename, $perms | 0644 );129		}130	} elseif ( ! is_writable( $filename ) ) {131		return false;132	}133 134	if ( ! is_array( $insertion ) ) {135		$insertion = explode( "\n", $insertion );136	}137 138	$switched_locale = switch_to_locale( get_locale() );139 140	$instructions = sprintf(141		/* translators: 1: Marker. */142		__(143			'The directives (lines) between "BEGIN %1$s" and "END %1$s" are144dynamically generated, and should only be modified via WordPress filters.145Any changes to the directives between these markers will be overwritten.'146		),147		$marker148	);149 150	$instructions = explode( "\n", $instructions );151 152	foreach ( $instructions as $line => $text ) {153		$instructions[ $line ] = '# ' . $text;154	}155 156	/**157	 * Filters the inline instructions inserted before the dynamically generated content.158	 *159	 * @since 5.3.0160	 *161	 * @param string[] $instructions Array of lines with inline instructions.162	 * @param string   $marker       The marker being inserted.163	 */164	$instructions = apply_filters( 'insert_with_markers_inline_instructions', $instructions, $marker );165 166	if ( $switched_locale ) {167		restore_previous_locale();168	}169 170	$insertion = array_merge( $instructions, $insertion );171 172	$start_marker = "# BEGIN {$marker}";173	$end_marker   = "# END {$marker}";174 175	$fp = fopen( $filename, 'r+' );176 177	if ( ! $fp ) {178		return false;179	}180 181	// Attempt to get a lock. If the filesystem supports locking, this will block until the lock is acquired.182	flock( $fp, LOCK_EX );183 184	$lines = array();185 186	while ( ! feof( $fp ) ) {187		$lines[] = rtrim( fgets( $fp ), "\r\n" );188	}189 190	// Split out the existing file into the preceding lines, and those that appear after the marker.191	$pre_lines        = array();192	$post_lines       = array();193	$existing_lines   = array();

Changelog

Introduced in 1.5.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 7.1.0 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.