ftp_base::put( $localfile, $remotefile = 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

$localfile

$remotefileoptional

Default: NULL

$restoptional

Default: 0

Performance profile

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

17–84

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

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 · 38 distinct outcomes

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

Uses · 8

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

Used by · 1

• ftp_base::mput()

Source code

View on Trac ↗View on GitHub ↗

619	function put($localfile, $remotefile=NULL, $rest=0) {620		if(is_null($remotefile)) $remotefile=$localfile;621		if (!file_exists($localfile)) {622			$this->PushError("put","cannot open local file", "No such file or directory \"".$localfile."\"");623			return FALSE;624		}625		$fp = @fopen($localfile, "r");626 627		if (!$fp) {628			$this->PushError("put","cannot open local file", "Cannot read file \"".$localfile."\"");629			return FALSE;630		}631		if($this->_can_restore and $rest!=0) fseek($fp, $rest);632		$pi=pathinfo($localfile);633		if($this->_type==FTP_ASCII or ($this->_type==FTP_AUTOASCII and in_array(strtoupper($pi["extension"]), $this->AutoAsciiExt))) $mode=FTP_ASCII;634		else $mode=FTP_BINARY;635		if(!$this->_data_prepare($mode)) {636			fclose($fp);637			return FALSE;638		}639		if($this->_can_restore and $rest!=0) $this->restore($rest);640		if(!$this->_exec("STOR ".$remotefile, "put")) {641			$this->_data_close();642			fclose($fp);643			return FALSE;644		}645		if(!$this->_checkCode()) {646			$this->_data_close();647			fclose($fp);648			return FALSE;649		}650		$ret=$this->_data_write($mode, $fp);651		fclose($fp);652		$this->_data_close();653		if(!$this->_readmsg()) return FALSE;654		if(!$this->_checkCode()) return FALSE;655		return $ret;656	}

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.