wppaste
WordPress

WP_Filesystem_FTPext::connect(): bool

Since
2.5.0
Source
wp-admin/includes/class-wp-filesystem-ftpext.php:122
Connects filesystem.

Compatibility

WordPress
since 2.5.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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_FTPext::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
13–87

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

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 · 25 distinct outcomes

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

WhenInstructionsCalls it makes
->has_errors() && !array_intersect()13->has_errors(), ->get_error_codes(), array_intersect()
!->has_errors()44–47->has_errors(), ftp_connect(), __(), sprintf(), ->add()
!->has_errors() && isset($value) && !function_exists()51->has_errors(), function_exists(), ftp_connect(), __(), sprintf(), ->add()
!->has_errors() && isset($value) && function_exists()52->has_errors(), function_exists(), ftp_ssl_connect(), __(), sprintf(), ->add()
->has_errors() && array_intersect()52–55->has_errors(), ->get_error_codes(), array_intersect(), ftp_connect(), __(), sprintf(), ->add()
!->has_errors() && !ftp_login()56–59->has_errors(), ftp_connect(), ftp_login(), __(), sprintf(), ->add()
->has_errors() && array_intersect() && isset($value) && !function_exists()59->has_errors(), ->get_error_codes(), array_intersect(), function_exists(), ftp_connect(), __(), sprintf(), ->add()
!->has_errors() && ftp_login()60–63->has_errors(), ftp_connect(), ftp_login(), ftp_pasv(), ftp_get_option()
->has_errors() && array_intersect() && isset($value) && function_exists()60->has_errors(), ->get_error_codes(), array_intersect(), function_exists(), ftp_ssl_connect(), __(), sprintf(), ->add()
!->has_errors() && isset($value) && !function_exists() && !ftp_login()63->has_errors(), function_exists(), ftp_connect(), ftp_login(), __(), sprintf(), ->add()
!->has_errors() && isset($value) && function_exists() && !ftp_login()64->has_errors(), function_exists(), ftp_ssl_connect(), ftp_login(), __(), sprintf(), ->add()
->has_errors() && array_intersect() && !ftp_login()64–67->has_errors(), ->get_error_codes(), array_intersect(), ftp_connect(), ftp_login(), __(), sprintf(), ->add()
13 further outcomes, up to 87 instructions
!->has_errors() && isset($value) && !function_exists() && ftp_login()67->has_errors(), function_exists(), ftp_connect(), ftp_login(), ftp_pasv(), ftp_get_option()
!->has_errors() && isset($value) && function_exists() && ftp_login()68->has_errors(), function_exists(), ftp_ssl_connect(), ftp_login(), ftp_pasv(), ftp_get_option()
->has_errors() && array_intersect() && ftp_login()68–71->has_errors(), ->get_error_codes(), array_intersect(), ftp_connect(), ftp_login(), ftp_pasv(), ftp_get_option()
!->has_errors() && ftp_login()71–74->has_errors(), ftp_connect(), ftp_login(), ftp_pasv(), ftp_get_option(), ftp_set_option()
->has_errors() && array_intersect() && isset($value) && !function_exists() && !ftp_login()71->has_errors(), ->get_error_codes(), array_intersect(), function_exists(), ftp_connect(), ftp_login(), __(), sprintf(), ->add()
->has_errors() && array_intersect() && isset($value) && function_exists() && !ftp_login()72->has_errors(), ->get_error_codes(), array_intersect(), function_exists(), ftp_ssl_connect(), ftp_login(), __(), sprintf(), ->add()
->has_errors() && array_intersect() && isset($value) && !function_exists() && ftp_login()75->has_errors(), ->get_error_codes(), array_intersect(), function_exists(), ftp_connect(), ftp_login(), ftp_pasv(), ftp_get_option()
->has_errors() && array_intersect() && isset($value) && function_exists() && ftp_login()76->has_errors(), ->get_error_codes(), array_intersect(), function_exists(), ftp_ssl_connect(), ftp_login(), ftp_pasv(), ftp_get_option()
!->has_errors() && isset($value) && !function_exists() && ftp_login()78->has_errors(), function_exists(), ftp_connect(), ftp_login(), ftp_pasv(), ftp_get_option(), ftp_set_option()
!->has_errors() && isset($value) && function_exists() && ftp_login()79->has_errors(), function_exists(), ftp_ssl_connect(), ftp_login(), ftp_pasv(), ftp_get_option(), ftp_set_option()
->has_errors() && array_intersect() && ftp_login()79–82->has_errors(), ->get_error_codes(), array_intersect(), ftp_connect(), ftp_login(), ftp_pasv(), ftp_get_option(), ftp_set_option()
->has_errors() && array_intersect() && isset($value) && !function_exists() && ftp_login()86->has_errors(), ->get_error_codes(), array_intersect(), function_exists(), ftp_connect(), ftp_login(), ftp_pasv(), ftp_get_option(), ftp_set_option()
->has_errors() && array_intersect() && isset($value) && function_exists() && ftp_login()87->has_errors(), ->get_error_codes(), array_intersect(), function_exists(), ftp_ssl_connect(), ftp_login(), ftp_pasv(), ftp_get_option(), ftp_set_option()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev13813–878
8.513813–878
8.413813–878
8.313813–878
8.213813–87816 more instructions than PHP 8.1
8.112213–737
7.412213–737

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 1

  • __()Retrieves the translation of $text.

Source code

View on Trac View on GitHub 

	public function connect() {		/*		 * Bail if the constructor recorded a configuration error. Connection and		 * authentication errors are excluded so that a failed connection attempt		 * can be retried on the same instance.		 */		if ( $this->errors->has_errors() && ! array_intersect( array( 'connect', 'auth' ), $this->errors->get_error_codes() ) ) {			return false;		} 		if ( isset( $this->options['ssl'] ) && $this->options['ssl'] && function_exists( 'ftp_ssl_connect' ) ) {			$this->link = @ftp_ssl_connect( $this->options['hostname'], $this->options['port'], FS_CONNECT_TIMEOUT );		} else {			$this->link = @ftp_connect( $this->options['hostname'], $this->options['port'], FS_CONNECT_TIMEOUT );		} 		if ( ! $this->link ) {			$this->errors->add(				'connect',				sprintf(					/* translators: %s: hostname:port */					__( 'Failed to connect to FTP Server %s' ),					$this->options['hostname'] . ':' . $this->options['port']				)			); 			return false;		} 		if ( ! @ftp_login( $this->link, $this->options['username'], $this->options['password'] ) ) {			$this->errors->add(				'auth',				sprintf(					/* translators: %s: Username. */					__( 'Username/Password incorrect for %s' ),					$this->options['username']				)			); 			return false;		} 		// Set the connection to use Passive FTP.		ftp_pasv( $this->link, true ); 		if ( @ftp_get_option( $this->link, FTP_TIMEOUT_SEC ) < FS_TIMEOUT ) {			@ftp_set_option( $this->link, FTP_TIMEOUT_SEC, FS_TIMEOUT );		} 		return true;	}

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.