ftp_base::get( $remotefile, $localfile = NULL, $rest = 0 )

Compatibility

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

Parameters

$remotefile

$localfileoptional

Default: NULL

$restoptional

Default: 0

Performance profile

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

Constant

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

Instructions

27–89

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

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

• filesystemfilesystem accessfile_exists()called directly

What one call costs · 74 distinct outcomes

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

Uses · 9

• ftp_base::SendMSG()
• ftp_base::PushError()
• ftp_base::_data_prepare()
• ftp_base::restore()
• ftp_base::_exec()
• ftp_base::_data_close()
• ftp_base::_checkCode()
• ftp_base::_data_read()
• ftp_base::_readmsg()

Used by · 1

• ftp_base::mget()

Source code

View on Trac ↗View on GitHub ↗

560	function get($remotefile, $localfile=NULL, $rest=0) {561		if(is_null($localfile)) $localfile=$remotefile;562		if (@file_exists($localfile)) $this->SendMSG("Warning : local file will be overwritten");563		$fp = @fopen($localfile, "w");564		if (!$fp) {565			$this->PushError("get","cannot open local file", "Cannot create \"".$localfile."\"");566			return FALSE;567		}568		if($this->_can_restore and $rest!=0) fseek($fp, $rest);569		$pi=pathinfo($remotefile);570		if($this->_type==FTP_ASCII or ($this->_type==FTP_AUTOASCII and in_array(strtoupper($pi["extension"]), $this->AutoAsciiExt))) $mode=FTP_ASCII;571		else $mode=FTP_BINARY;572		if(!$this->_data_prepare($mode)) {573			fclose($fp);574			return FALSE;575		}576		if($this->_can_restore and $rest!=0) $this->restore($rest);577		if(!$this->_exec("RETR ".$remotefile, "get")) {578			$this->_data_close();579			fclose($fp);580			return FALSE;581		}582		if(!$this->_checkCode()) {583			$this->_data_close();584			fclose($fp);585			return FALSE;586		}587		$out=$this->_data_read($mode, $fp);588		fclose($fp);589		$this->_data_close();590		if(!$this->_readmsg()) return FALSE;591		if(!$this->_checkCode()) return FALSE;592		return $out;593	}

Changelog

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-ftp.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.