WP_Filesystem_FTPext

Compatibility

Present in every tracked release (6.7.7 to 7.1.0).

Properties · 2

$linkFTP\Connection|resource|falsepublic

$optionsarraypublic

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 ↗

24class WP_Filesystem_FTPext extends WP_Filesystem_Base {25 26	/**27	 * @since 2.5.028	 * @var FTP\Connection|resource|false29	 */30	public $link;31 32	/**33	 * @since 7.1.034	 * @var array35	 * @phpstan-var Options36	 */37	public $options;38 39	/**40	 * Constructor.41	 *42	 * @since 2.5.043	 *44	 * @param array $opt {45	 *     Array of connection options.46	 *47	 *     @type string $hostname        Required. FTP server hostname.48	 *     @type string $username        Required. FTP username.49	 *     @type string $password        Required. FTP password.50	 *     @type int    $port            Optional. FTP server port. Default 21.51	 *     @type string $connection_type Optional. Connection type. Use 'ftps' to enable SSL.52	 * }53	 * @phpstan-param array{54	 *     hostname: non-empty-string,55	 *     username: non-empty-string,56	 *     password: string,57	 *     port?: non-negative-int,58	 *     connection_type?: 'ftps',59	 * }|null $opt60	 */61	public function __construct( $opt = null ) {62		$this->method  = 'ftpext';63		$this->errors  = new WP_Error();64		$this->options = array(65			'port'     => 21,66			'hostname' => '',67			'username' => '',68			'password' => '',69			'ssl'      => false,70		);71 72		// Check if possible to use ftp functions.73		if ( ! extension_loaded( 'ftp' ) ) {74			$this->errors->add( 'no_ftp_ext', __( 'The ftp PHP extension is not available' ) );75			return;76		}77 78		// This class uses the timeout on a per-connection basis, others use it on a per-action basis.79		if ( ! defined( 'FS_TIMEOUT' ) ) {80			define( 'FS_TIMEOUT', 4 * MINUTE_IN_SECONDS );81		}82 83		if ( ! is_array( $opt ) ) {84			$opt = array();85		}86 87		if ( ! empty( $opt['port'] ) ) {88			$this->options['port'] = $opt['port'];89		}90 91		if ( empty( $opt['hostname'] ) ) {92			$this->errors->add( 'empty_hostname', __( 'FTP hostname is required' ) );93		} else {94			$this->options['hostname'] = $opt['hostname'];95		}96 97		// Check if the options provided are OK.98		if ( empty( $opt['username'] ) ) {99			$this->errors->add( 'empty_username', __( 'FTP username is required' ) );100		} else {101			$this->options['username'] = $opt['username'];102		}103

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