返回命令行参数的值。

原型

get_cli_args( string $param, bool $required = false )

描述

未设置必需参数时退出。

参数

$param (string) (Required)

$required (bool) (Optional)

返回值

(mixed)  

源文件

路径:wp-admin/includes/class-wp-importer.php

<?php
...
function get_cli_args( $param, $required = false ) {
	$args = $_SERVER['argv'];
	$out = array();
	$last_arg = null;
	$return = null;
	$il = sizeof( $args );
	for ( $i = 1, $il; $i < $il; $i++ ) {
		if ( (bool) preg_match( "/^--(.+)/", $args[$i], $match ) ) {
			$parts = explode( "=", $match[1] );
			$key = preg_replace( "/[^a-z0-9]+/", "", $parts[0] );
			if ( isset( $parts[1] ) ) {
				$out[$key] = $parts[1];
			} else {
				$out[$key] = true;
			}
			$last_arg = $key;
		} elseif ( (bool) preg_match( "/^-([a-zA-Z0-9]+)/", $args[$i], $match ) ) {
			for ( $j = 0, $jl = strlen( $match[1] ); $j < $jl; $j++ ) {
				$key = $match[1]{$j};
				$out[$key] = true;
			}
			$last_arg = $key;
		} elseif ( $last_arg !== null ) {
			$out[$last_arg] = $args[$i];
		}
	}
	// Check array for specified param
	if ( isset( $out[$param] ) ) {
		// Set return value
		$return = $out[$param];
	}
	// Check for missing required param
	if ( !isset( $out[$param] ) && $required ) {
		// Display message and exit
		echo ""$param" parameter is required but was not specifiedn";
		exit();
	}
	return $return;
}
...
?>

其他

英文文档:https://developer.wordpress.org/reference/functions/get_cli_args/