WP_Filesystem_ftpsockets

Compatibility

Present in every tracked release (6.7.7 to 7.1.0).

Properties · 2

$ftpftppublic

$optionsarraypublic

Methods · 27

• __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.
• dirlist()Gets details for files in a directory or a specific file.
• __destruct()Destructor.

Source code

View on Trac ↗View on GitHub ↗

23class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {24 25	/**26	 * @since 2.5.027	 * @var ftp28	 */29	public $ftp;30 31	/**32	 * @since 7.1.033	 * @var array34	 * @phpstan-var Options35	 */36	public $options;37 38	/**39	 * Constructor.40	 *41	 * @since 2.5.042	 *43	 * @param array $opt {44	 *     Array of connection options.45	 *46	 *     @type string $hostname Required. FTP server hostname.47	 *     @type string $username Required. FTP username.48	 *     @type string $password Required. FTP password.49	 *     @type int $port Optional. FTP server port. Default 21.50	 * }51	 * @phpstan-param array{52	 *     hostname: non-empty-string,53	 *     username: non-empty-string,54	 *     password: string,55	 *     port?: non-negative-int,56	 * }|null $opt57	 */58	public function __construct( $opt = null ) {59		$this->method  = 'ftpsockets';60		$this->errors  = new WP_Error();61		$this->options = array(62			'port'     => 21,63			'hostname' => '',64			'username' => '',65			'password' => '',66		);67 68		// Check if possible to use ftp functions.69		if ( ! require_once ABSPATH . 'wp-admin/includes/class-ftp.php' ) {70			return;71		}72 73		$this->ftp = new ftp();74 75		if ( ! is_array( $opt ) ) {76			$opt = array();77		}78 79		if ( ! empty( $opt['port'] ) ) {80			$this->options['port'] = (int) $opt['port'];81		}82 83		if ( empty( $opt['hostname'] ) ) {84			$this->errors->add( 'empty_hostname', __( 'FTP hostname is required' ) );85		} else {86			$this->options['hostname'] = $opt['hostname'];87		}88 89		// Check if the options provided are OK.90		if ( empty( $opt['username'] ) ) {91			$this->errors->add( 'empty_username', __( 'FTP username is required' ) );92		} else {93			$this->options['username'] = $opt['username'];94		}95 96		if ( empty( $opt['password'] ) ) {97			$this->errors->add( 'empty_password', __( 'FTP password is required' ) );98		} else {99			$this->options['password'] = $opt['password'];100		}101	}102

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