WP_Filesystem_ftpsockets::connect(): bool

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Return value

bool

True on success, false on failure.

Performance profile

How much work a call to WP_Filesystem_ftpsockets::connect() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

7–62

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 117.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What one call costs · 10 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Filesystem_ftpsockets::connect() can have, taken from its control-flow graph on PHP 8.5.

Uses · 1

• __()Retrieves the translation of $text.

Source code

View on Trac ↗View on GitHub ↗

110	public function connect() {111		/*112		 * Bail if the constructor recorded a configuration error. Connection and113		 * authentication errors are excluded so that a failed connection attempt114		 * can be retried on the same instance.115		 */116		if ( $this->errors->has_errors() && ! array_intersect( array( 'connect', 'auth' ), $this->errors->get_error_codes() ) ) {117			return false;118		}119 120		if ( ! $this->ftp ) {121			return false;122		}123 124		$this->ftp->SetTimeout( FS_CONNECT_TIMEOUT );125 126		if ( ! $this->ftp->SetServer( $this->options['hostname'], $this->options['port'] ) ) {127			$this->errors->add(128				'connect',129				sprintf(130					/* translators: %s: hostname:port */131					__( 'Failed to connect to FTP Server %s' ),132					$this->options['hostname'] . ':' . $this->options['port']133				)134			);135 136			return false;137		}138 139		if ( ! $this->ftp->connect() ) {140			$this->errors->add(141				'connect',142				sprintf(143					/* translators: %s: hostname:port */144					__( 'Failed to connect to FTP Server %s' ),145					$this->options['hostname'] . ':' . $this->options['port']146				)147			);148 149			return false;150		}151 152		if ( ! $this->ftp->login( $this->options['username'], $this->options['password'] ) ) {153			$this->errors->add(154				'auth',155				sprintf(156					/* translators: %s: Username. */157					__( 'Username/Password incorrect for %s' ),158					$this->options['username']159				)160			);161 162			return false;163		}164 165		$this->ftp->SetType( FTP_BINARY );166		$this->ftp->Passive( true );167		$this->ftp->SetTimeout( FS_TIMEOUT );168 169		return true;170	}

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.