WP_Site_Health_Auto_Updates::test_all_files_writable(): array|false

Compatibility

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

Return value

array|false

The test results if at least some of WordPress core files are writeable, or if a list of the checksums could not be retrieved from WordPress.org.
False if the core files are not writeable.

Performance profile

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

Expensive

Reaches an outbound HTTP request via wp_remote_get().

Scaling

Scales with input

The body loops, so the work grows with how much data it finds.

Instructions

17–76

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

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

• hookthird-party callbacksapply_filters()one call below WP_Site_Health_Auto_Updates::test_all_files_writable()
• httpoutbound HTTP requestwp_remote_get()one call below WP_Site_Health_Auto_Updates::test_all_files_writable()

Further down the call graph this can also reach query, option, cache, serialize 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 · 10 distinct outcomes

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

Uses · 6

• WP_Filesystem()Initializes and connects the WordPress Filesystem Abstraction classes.
• get_core_checksums()Gets and caches the checksums for the given version of WordPress.
• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• __()Retrieves the translation of $text.
• str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
• Automatic_Upgrader_Skin::__construct()

Used by · 1

• WP_Site_Health_Auto_Updates::run_tests()Runs tests to determine if auto-updates can run.

Source code

View on Trac ↗View on GitHub ↗

328	public function test_all_files_writable() {329		global $wp_filesystem;330 331		require ABSPATH . WPINC . '/version.php'; // $wp_version; // x.y.z332 333		$skin    = new Automatic_Upgrader_Skin();334		$success = $skin->request_filesystem_credentials( false, ABSPATH );335 336		if ( ! $success ) {337			return false;338		}339 340		WP_Filesystem();341 342		if ( 'direct' !== $wp_filesystem->method ) {343			return false;344		}345 346		// Make sure the `get_core_checksums()` function is available during our REST API call.347		if ( ! function_exists( 'get_core_checksums' ) ) {348			require_once ABSPATH . 'wp-admin/includes/update.php';349		}350 351		$checksums = get_core_checksums( $wp_version, 'en_US' );352		$dev       = ( str_contains( $wp_version, '-' ) );353		// Get the last stable version's files and test against that.354		if ( ! $checksums && $dev ) {355			$checksums = get_core_checksums( (float) $wp_version - 0.1, 'en_US' );356		}357 358		// There aren't always checksums for development releases, so just skip the test if we still can't find any.359		if ( ! $checksums && $dev ) {360			return false;361		}362 363		if ( ! $checksums ) {364			$description = sprintf(365				/* translators: %s: WordPress version. */366				__( "Couldn't retrieve a list of the checksums for WordPress %s." ),367				$wp_version368			);369			$description .= ' ' . __( 'This could mean that connections are failing to WordPress.org.' );370			return array(371				'description' => $description,372				'severity'    => 'warning',373			);374		}375 376		$unwritable_files = array();377		foreach ( array_keys( $checksums ) as $file ) {378			if ( str_starts_with( $file, 'wp-content' ) ) {379				continue;380			}381			if ( ! file_exists( ABSPATH . $file ) ) {382				continue;383			}384			if ( ! is_writable( ABSPATH . $file ) ) {385				$unwritable_files[] = $file;386			}387		}388 389		if ( $unwritable_files ) {390			if ( count( $unwritable_files ) > 20 ) {391				$unwritable_files   = array_slice( $unwritable_files, 0, 20 );392				$unwritable_files[] = '...';393			}394			return array(395				'description' => __( 'Some files are not writable by WordPress:' ) . ' <ul><li>' . implode( '</li><li>', $unwritable_files ) . '</li></ul>',396				'severity'    => 'fail',397			);398		} else {399			return array(400				'description' => __( 'All of your WordPress files are writable.' ),401				'severity'    => 'pass',402			);403		}404	}

Changelog

Introduced in 5.2.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-admin/includes/class-wp-site-health-auto-updates.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.