wppaste
WordPress

WP_Filesystem_Direct::get_contents( string $file ): string|false

Since
2.5.0
Source
wp-admin/includes/class-wp-filesystem-direct.php:38
Reads entire file into a string.

Parameters

$filestring
Name of the file to read.

Return

string|false
Read data on success, false on failure.

Cost profile

Measured from the compiled opcodes, not from a stopwatch. Every number here is identical on any machine that runs the same PHP version, and every function in core is ranked by these figures.

Cost class
Trivial

Reads or writes the filesystem via file_get_contents().

Scaling
Constant

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

Instructions
7

Executed per call on PHP 8.4. The body compiles to 7.

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

  • filesystemfilesystem accessfile_get_contents()called directly

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 WP_Filesystem_Direct::get_contents() can have, taken from its control-flow graph on PHP 8.4.

WhenInstructionsCalls it makes
always7file_get_contents()

Across PHP versions

PHPCompiledExecutedBranchesNotes
7.4770Compiles to the same instructions
8.1770Compiles to the same instructions
8.2770Compiles to the same instructions
8.3770Compiles to the same instructions
8.4770Compiles to the same instructions

Oldest PHP that compiles this body: 7.4. An instruction is not a fixed amount of time, so a version with the same count is not necessarily the same speed; what the count rules out is a difference in the work itself.

Source

	public function get_contents( $file ) {		return @file_get_contents( $file );	}

History

Introduced in 2.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 6.8.8 tag, from src/wp-admin/includes/class-wp-filesystem-direct.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.