handbook/internal-api/wp-cli-utils-parse-ssh-url.md
github-actions[bot] c22aa665e6 Regenerate handbook
2025-12-17 18:56:32 +00:00

2.1 KiB

WP_CLI\Utils\parse_ssh_url()

Parse a SSH url for its host, port, and path.


Usage

WP_CLI\Utils\parse_ssh_url( $url, $component = -1 )
$url (string)
$component (int)
@return (mixed)

Notes

Similar to parse_url(), but adds support for defined SSH aliases.

host OR host/path/to/wordpress OR host:port/path/to/wordpress

Internal API documentation is generated from the WP-CLI codebase on every release. To suggest improvements, please submit a pull request.