WP_Filesystem_ftpsockets::get_contents() – Reads entire file into a string.

You appear to be a bot. Output may be restricted

Description

Reads entire file into a string.

Usage

$string|false = WP_Filesystem_ftpsockets::get_contents( $file );

Parameters

$file
( string ) required – Name of the file to read.

Returns

string|false Read data on success, false if no temporary file could be opened, or if the file couldn't be retrieved.

Source

File name: wordpress/wp-admin/includes/class-wp-filesystem-ftpsockets.php
Lines:

1 to 38 of 38
  public function get_contents( $file ) {
    if ( ! $this->WP_Filesystem_ftpsockets::exists( $file ) ) {
      return false;
    }

    $tempfile   = wp_tempnam( $file );
    $temphandle = fopen( $tempfile, 'w+' );

    if ( ! $temphandle ) {
      unlink( $tempfile );
      return false;
    }

    mbstring_binary_safe_encoding();

    if ( ! $this->ftp->fget( $temphandle, $file ) ) {
      fclose( $temphandle );
      unlink( $tempfile );

      reset_mbstring_encoding();

      return ''; // Blank document. File does exist, it's just blank.
    }

    reset_mbstring_encoding();

    fseek( $temphandle, 0 ); // Skip back to the start of the file being written to.
    $contents = '';

    while ( ! feof( $temphandle ) ) {
      $contents .= fread( $temphandle, 8 * KB_IN_BYTES );
    }

    fclose( $temphandle );
    unlink( $tempfile );

    return $contents;
  }
 

 View on GitHub View on Trac