WP_CLI

SynopsisParser::parse()public staticWP-CLI 1.0

Method of the class: SynopsisParser{}

No Hooks.

Return

Array. List of parameters

Usage

$result = SynopsisParser::parse( $synopsis );
$synopsis(string) (required)
A synopsis

SynopsisParser::parse() code WP-CLI 2.8.0-alpha

public static function parse( $synopsis ) {
	$tokens = array_filter( preg_split( '/[\s\t]+/', $synopsis ) );

	$params = [];
	foreach ( $tokens as $token ) {
		$param = self::classify_token( $token );

		// Some types of parameters shouldn't be mandatory
		if ( isset( $param['optional'] ) && ! $param['optional'] ) {
			if ( 'flag' === $param['type'] || ( 'assoc' === $param['type'] && $param['value']['optional'] ) ) {
				$param['type'] = 'unknown';
			}
		}

		$param['token'] = $token;
		$params[]       = $param;
	}

	return $params;
}