WP_Filesystem_ftpsockets

Properties · 1

$ftpftppublic

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

View on Trac ↗View on GitHub ↗

16class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {17 18	/**19	 * @since 2.5.020	 * @var ftp21	 */22	public $ftp;23 24	/**25	 * Constructor.26	 *27	 * @since 2.5.028	 *29	 * @param array $opt30	 */31	public function __construct( $opt = '' ) {32		$this->method = 'ftpsockets';33		$this->errors = new WP_Error();34 35		// Check if possible to use ftp functions.36		if ( ! require_once ABSPATH . 'wp-admin/includes/class-ftp.php' ) {37			return;38		}39 40		$this->ftp = new ftp();41 42		if ( empty( $opt['port'] ) ) {43			$this->options['port'] = 21;44		} else {45			$this->options['port'] = (int) $opt['port'];46		}47 48		if ( empty( $opt['hostname'] ) ) {49			$this->errors->add( 'empty_hostname', __( 'FTP hostname is required' ) );50		} else {51			$this->options['hostname'] = $opt['hostname'];52		}53 54		// Check if the options provided are OK.55		if ( empty( $opt['username'] ) ) {56			$this->errors->add( 'empty_username', __( 'FTP username is required' ) );57		} else {58			$this->options['username'] = $opt['username'];59		}60 61		if ( empty( $opt['password'] ) ) {62			$this->errors->add( 'empty_password', __( 'FTP password is required' ) );63		} else {64			$this->options['password'] = $opt['password'];65		}66	}67 68	/**69	 * Connects filesystem.70	 *71	 * @since 2.5.072	 *73	 * @return bool True on success, false on failure.74	 */75	public function connect() {76		if ( ! $this->ftp ) {77			return false;78		}79 80		$this->ftp->setTimeout( FS_CONNECT_TIMEOUT );81 82		if ( ! $this->ftp->SetServer( $this->options['hostname'], $this->options['port'] ) ) {83			$this->errors->add(84				'connect',85				sprintf(86					/* translators: %s: hostname:port */87					__( 'Failed to connect to FTP Server %s' ),88					$this->options['hostname'] . ':' . $this->options['port']89				)90			);91 92			return false;93		}94 95		if ( ! $this->ftp->connect() ) {

History

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