WP_Filesystem_FTPext

Compatibility

Present in every tracked release (6.7.7 to 7.1.0).

Properties · 1

$linkFTP\Connection|resource|falsepublic

Methods · 28

• __construct()Constructor.
• connect()Connects filesystem.
• get_contents()Reads entire file into a string.
• get_contents_array()Reads entire file into an array.
• put_contents()Writes a string to a file.
• cwd()Gets the current working directory.
• chdir()Changes current directory.
• chmod()Changes filesystem permissions.
• owner()Gets the file owner.
• getchmod()Gets the permissions of the specified file or filepath in their octal format.
• group()Gets the file's group.
• copy()Copies a file.
• move()Moves a file or directory.
• delete()Deletes a file or directory.
• exists()Checks if a file or directory exists.
• is_file()Checks if resource is a file.
• is_dir()Checks if resource is a directory.
• is_readable()Checks if a file is readable.
• is_writable()Checks if a file or directory is writable.
• atime()Gets the file's last access time.
• mtime()Gets the file modification time.
• size()Gets the file size (in bytes).
• touch()Sets the access and modification times of a file.
• mkdir()Creates a directory.
• rmdir()Deletes a directory.
• parselisting()Parses an individual entry from the FTP LIST command output.
• dirlist()Gets details for files in a directory or a specific file.
• __destruct()Destructor.

Source code

View on Trac ↗View on GitHub ↗

16class WP_Filesystem_FTPext extends WP_Filesystem_Base {17 18	/**19	 * @since 2.5.020	 * @var FTP\Connection|resource|false21	 */22	public $link;23 24	/**25	 * Constructor.26	 *27	 * @since 2.5.028	 *29	 * @param array $opt30	 */31	public function __construct( $opt = '' ) {32		$this->method = 'ftpext';33		$this->errors = new WP_Error();34 35		// Check if possible to use ftp functions.36		if ( ! extension_loaded( 'ftp' ) ) {37			$this->errors->add( 'no_ftp_ext', __( 'The ftp PHP extension is not available' ) );38			return;39		}40 41		// This class uses the timeout on a per-connection basis, others use it on a per-action basis.42		if ( ! defined( 'FS_TIMEOUT' ) ) {43			define( 'FS_TIMEOUT', 4 * MINUTE_IN_SECONDS );44		}45 46		if ( empty( $opt['port'] ) ) {47			$this->options['port'] = 21;48		} else {49			$this->options['port'] = $opt['port'];50		}51 52		if ( empty( $opt['hostname'] ) ) {53			$this->errors->add( 'empty_hostname', __( 'FTP hostname is required' ) );54		} else {55			$this->options['hostname'] = $opt['hostname'];56		}57 58		// Check if the options provided are OK.59		if ( empty( $opt['username'] ) ) {60			$this->errors->add( 'empty_username', __( 'FTP username is required' ) );61		} else {62			$this->options['username'] = $opt['username'];63		}64 65		if ( empty( $opt['password'] ) ) {66			$this->errors->add( 'empty_password', __( 'FTP password is required' ) );67		} else {68			$this->options['password'] = $opt['password'];69		}70 71		$this->options['ssl'] = false;72 73		if ( isset( $opt['connection_type'] ) && 'ftps' === $opt['connection_type'] ) {74			$this->options['ssl'] = true;75		}76	}77 78	/**79	 * Connects filesystem.80	 *81	 * @since 2.5.082	 *83	 * @return bool True on success, false on failure.84	 */85	public function connect() {86		if ( isset( $this->options['ssl'] ) && $this->options['ssl'] && function_exists( 'ftp_ssl_connect' ) ) {87			$this->link = @ftp_ssl_connect( $this->options['hostname'], $this->options['port'], FS_CONNECT_TIMEOUT );88		} else {89			$this->link = @ftp_connect( $this->options['hostname'], $this->options['port'], FS_CONNECT_TIMEOUT );90		}91 92		if ( ! $this->link ) {93			$this->errors->add(94				'connect',95				sprintf(

Changelog

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 7.0.4 tag, from src/wp-admin/includes/class-wp-filesystem-ftpext.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.