WP_Automatic_Updater::has_fatal_error(): 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.

Return value

bool

Whether a fatal error was detected.

Performance profile

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

Constant

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

Instructions

9–147

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

Plugin surface

1 hook

Third-party callbacks on 'https_local_ssl_verify' 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

• transienttransientset_transient()called directly
• hookthird-party callbacksapply_filters()called directly
• httpoutbound HTTP requestwp_remote_get()called directly
• serializeserialisationjson_decode()called directly
• filesystemfilesystem accessfile_exists()called directly
• cacheobject cachewp_cache_set()one call below WP_Automatic_Updater::has_fatal_error()
• optionoption read or writeget_option()one call below WP_Automatic_Updater::has_fatal_error()

Further down the call graph this can also reach query. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 25 distinct outcomes

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

Hooks and filters fired · 1

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

1. 1
   apply_filters( https_local_ssl_verify )filterline 1806 (+45 into the body)

   Filters whether SSL should be verified for local HTTP API requests.

Uses · 9

• set_transient()Sets/updates the value of a transient.
• wp_unslash()Removes slashes from a string or recursively removes slashes from strings within an array.
• add_query_arg()Retrieves a modified URL query string.
• home_url()Retrieves the URL for the current site where the front end is accessible.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_remote_get()Performs an HTTP request using the GET method and returns its response.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_remote_retrieve_body()Retrieves only the body from the raw response.
• delete_transient()Deletes a transient.

Used by · 1

• WP_Automatic_Updater::update()Updates an item, if appropriate.

Source code

View on Trac ↗View on GitHub ↗

1761	protected function has_fatal_error() {1762		global $upgrading;1763 1764		$maintenance_file = ABSPATH . '.maintenance';1765		if ( ! file_exists( $maintenance_file ) ) {1766			return false;1767		}1768 1769		require $maintenance_file;1770		if ( ! is_int( $upgrading ) ) {1771			return false;1772		}1773 1774		$scrape_key   = md5( $upgrading );1775		$scrape_nonce = (string) $upgrading;1776		$transient    = 'scrape_key_' . $scrape_key;1777		set_transient( $transient, $scrape_nonce, 30 );1778 1779		$cookies       = wp_unslash( $_COOKIE );1780		$scrape_params = array(1781			'wp_scrape_key'   => $scrape_key,1782			'wp_scrape_nonce' => $scrape_nonce,1783		);1784		$headers       = array(1785			'Cache-Control' => 'no-cache',1786		);1787 1788		// Include Basic auth in the loopback request.1789		if ( isset( $_SERVER['PHP_AUTH_USER'] ) && isset( $_SERVER['PHP_AUTH_PW'] ) ) {1790			$headers['Authorization'] = 'Basic ' . base64_encode( wp_unslash( $_SERVER['PHP_AUTH_USER'] ) . ':' . wp_unslash( $_SERVER['PHP_AUTH_PW'] ) );1791		}1792 1793		// Time to wait for loopback request to finish.1794		$timeout = 50; // 50 seconds.1795 1796		$is_debug = WP_DEBUG && WP_DEBUG_LOG;1797		if ( $is_debug ) {1798			error_log( '    Scraping home page...' );1799		}1800 1801		$needle_start = "###### wp_scraping_result_start:$scrape_key ######";1802		$needle_end   = "###### wp_scraping_result_end:$scrape_key ######";1803		$url          = add_query_arg( $scrape_params, home_url( '/' ) );1804 1805		/** This filter is documented in wp-includes/class-wp-http-streams.php */1806		$sslverify = apply_filters( 'https_local_ssl_verify', false, $url );1807		$response  = wp_remote_get( $url, compact( 'cookies', 'headers', 'timeout', 'sslverify' ) );1808 1809		if ( is_wp_error( $response ) ) {1810			if ( $is_debug ) {1811				error_log( 'Loopback request failed: ' . $response->get_error_message() );1812			}1813			return true;1814		}1815 1816		// If this outputs `true` in the log, it means there were no fatal errors detected.1817		if ( $is_debug ) {1818			error_log( var_export( substr( $response['body'], strpos( $response['body'], '###### wp_scraping_result_start:' ) ), true ) );1819		}1820 1821		$body                   = wp_remote_retrieve_body( $response );1822		$scrape_result_position = strpos( $body, $needle_start );1823		$result                 = null;1824 1825		if ( false !== $scrape_result_position ) {1826			$error_output = substr( $body, $scrape_result_position + strlen( $needle_start ) );1827			$error_output = substr( $error_output, 0, strpos( $error_output, $needle_end ) );1828			$result       = json_decode( trim( $error_output ), true );1829		}1830 1831		delete_transient( $transient );1832 1833		// Only fatal errors will result in a 'type' key.1834		return isset( $result['type'] );1835	}

Changelog

Introduced in 6.6.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/class-wp-automatic-updater.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.