* WordPress FTP Sockets Filesystem.
* WordPress Filesystem Class for implementing FTP Sockets.
* @see WP_Filesystem_Base
class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
public function __construct( $opt = '' ) {
$this->method = 'ftpsockets';
$this->errors = new WP_Error();
// Check if possible to use ftp functions.
if ( ! require_once ABSPATH . 'wp-admin/includes/class-ftp.php' ) {
if ( empty( $opt['port'] ) ) {
$this->options['port'] = 21;
$this->options['port'] = (int) $opt['port'];
if ( empty( $opt['hostname'] ) ) {
$this->errors->add( 'empty_hostname', __( 'FTP hostname is required' ) );
$this->options['hostname'] = $opt['hostname'];
// Check if the options provided are OK.
if ( empty( $opt['username'] ) ) {
$this->errors->add( 'empty_username', __( 'FTP username is required' ) );
$this->options['username'] = $opt['username'];
if ( empty( $opt['password'] ) ) {
$this->errors->add( 'empty_password', __( 'FTP password is required' ) );
$this->options['password'] = $opt['password'];
* @return bool True on success, false on failure.
public function connect() {
$this->ftp->SetTimeout( FS_CONNECT_TIMEOUT );
if ( ! $this->ftp->SetServer( $this->options['hostname'], $this->options['port'] ) ) {
/* translators: %s: hostname:port */
__( 'Failed to connect to FTP Server %s' ),
$this->options['hostname'] . ':' . $this->options['port']
if ( ! $this->ftp->connect() ) {
/* translators: %s: hostname:port */
__( 'Failed to connect to FTP Server %s' ),
$this->options['hostname'] . ':' . $this->options['port']
if ( ! $this->ftp->login( $this->options['username'], $this->options['password'] ) ) {
/* translators: %s: Username. */
__( 'Username/Password incorrect for %s' ),
$this->options['username']
$this->ftp->SetType( FTP_BINARY );
$this->ftp->Passive( true );
$this->ftp->SetTimeout( FS_TIMEOUT );
* Reads entire file into a string.
* @param string $file Name of the file to read.
* @return string|false Read data on success, false if no temporary file could be opened,
* or if the file couldn't be retrieved.
public function get_contents( $file ) {
if ( ! $this->exists( $file ) ) {
$tempfile = wp_tempnam( $file );
$temphandle = fopen( $tempfile, 'w+' );
mbstring_binary_safe_encoding();
if ( ! $this->ftp->fget( $temphandle, $file ) ) {
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.
while ( ! feof( $temphandle ) ) {
$contents .= fread( $temphandle, 8 * KB_IN_BYTES );
* Reads entire file into an array.
* @param string $file Path to the file.
* @return array|false File contents in an array on success, false on failure.
public function get_contents_array( $file ) {
return explode( "\n", $this->get_contents( $file ) );
* Writes a string to a file.
* @param string $file Remote path to the file where to write the data.
* @param string $contents The data to write.
* @param int|false $mode Optional. The file permissions as octal number, usually 0644.
* @return bool True on success, false on failure.
public function put_contents( $file, $contents, $mode = false ) {
$tempfile = wp_tempnam( $file );
$temphandle = @fopen( $tempfile, 'w+' );
// The FTP class uses string functions internally during file download/upload.
mbstring_binary_safe_encoding();
$bytes_written = fwrite( $temphandle, $contents );
if ( false === $bytes_written || strlen( $contents ) !== $bytes_written ) {
reset_mbstring_encoding();
fseek( $temphandle, 0 ); // Skip back to the start of the file being written to.
$ret = $this->ftp->fput( $file, $temphandle );
reset_mbstring_encoding();
$this->chmod( $file, $mode );
* Gets the current working directory.
* @return string|false The current working directory on success, false on failure.
$cwd = $this->ftp->pwd();
$cwd = trailingslashit( $cwd );
* Changes current directory.
* @param string $dir The new current directory.
* @return bool True on success, false on failure.
public function chdir( $dir ) {
return $this->ftp->chdir( $dir );
* Changes filesystem permissions.
* @param string $file Path to the file.
* @param int|false $mode Optional. The permissions as octal number, usually 0644 for files,
* 0755 for directories. Default false.
* @param bool $recursive Optional. If set to true, changes file permissions recursively.
* @return bool True on success, false on failure.
public function chmod( $file, $mode = false, $recursive = false ) {
if ( $this->is_file( $file ) ) {
} elseif ( $this->is_dir( $file ) ) {
// chmod any sub-objects if recursive.
if ( $recursive && $this->is_dir( $file ) ) {
$filelist = $this->dirlist( $file );
foreach ( (array) $filelist as $filename => $filemeta ) {
$this->chmod( $file . '/' . $filename, $mode, $recursive );
// chmod the file or directory.
return $this->ftp->chmod( $file, $mode );
* @param string $file Path to the file.
* @return string|false Username of the owner on success, false on failure.
public function owner( $file ) {
$dir = $this->dirlist( $file );
return $dir[ $file ]['owner'];
* Gets the permissions of the specified file or filepath in their octal format.
* @param string $file Path to the file.
* @return string Mode of the file (the last 3 digits).
public function getchmod( $file ) {
$dir = $this->dirlist( $file );
return $dir[ $file ]['permsn'];
* @param string $file Path to the file.
* @return string|false The group on success, false on failure.
public function group( $file ) {
$dir = $this->dirlist( $file );
return $dir[ $file ]['group'];
* @param string $source Path to the source file.
* @param string $destination Path to the destination file.
* @param bool $overwrite Optional. Whether to overwrite the destination file if it exists.
* @param int|false $mode Optional. The permissions as octal number, usually 0644 for files,
* 0755 for dirs. Default false.
* @return bool True on success, false on failure.
public function copy( $source, $destination, $overwrite = false, $mode = false ) {
if ( ! $overwrite && $this->exists( $destination ) ) {
$content = $this->get_contents( $source );
if ( false === $content ) {
return $this->put_contents( $destination, $content, $mode );
* Moves a file or directory.
* After moving files or directories, OPcache will need to be invalidated.
* If moving a directory fails, `copy_dir()` can be used for a recursive copy.
* Use `move_dir()` for moving directories with OPcache invalidation and a
* fallback to `copy_dir()`.
* @param string $source Path to the source file or directory.
* @param string $destination Path to the destination file or directory.
* @param bool $overwrite Optional. Whether to overwrite the destination if it exists.
* @return bool True on success, false on failure.
public function move( $source, $destination, $overwrite = false ) {
return $this->ftp->rename( $source, $destination );
* Deletes a file or directory.
* @param string $file Path to the file or directory.
* @param bool $recursive Optional. If set to true, deletes files and folders recursively.
* @param string|false $type Type of resource. 'f' for file, 'd' for directory.
* @return bool True on success, false on failure.
public function delete( $file, $recursive = false, $type = false ) {
if ( 'f' === $type || $this->is_file( $file ) ) {
return $this->ftp->delete( $file );
return $this->ftp->rmdir( $file );
return $this->ftp->mdel( $file );
* Checks if a file or directory exists.
* @since 6.3.0 Returns false for an empty path.
* @param string $path Path to file or directory.
* @return bool Whether $path exists or not.
public function exists( $path ) {
* Check for empty path. If ftp::nlist() receives an empty path,
* it checks the current working directory and may return true.
* See https://core.trac.wordpress.org/ticket/33058.
$list = $this->ftp->nlist( $path );
if ( empty( $list ) && $this->is_dir( $path ) ) {
return true; // File is an empty directory.
return ! empty( $list ); // Empty list = no file, so invert.
// Return $this->ftp->is_exists($file); has issues with ABOR+426 responses on the ncFTPd server.
* Checks if resource is a file.
* @param string $file File path.
* @return bool Whether $file is a file.
public function is_file( $file ) {
if ( $this->is_dir( $file ) ) {
if ( $this->exists( $file ) ) {
* Checks if resource is a directory.
* @param string $path Directory path.
* @return bool Whether $path is a directory.
public function is_dir( $path ) {
if ( $this->chdir( $path ) ) {
* Checks if a file is readable.
* @param string $file Path to file.
* @return bool Whether $file is readable.
public function is_readable( $file ) {
It is recommended that you Edit text format, this type of Fix handles quite a lot in one request
