get_cli_args
Returns value of command line params.
Description
Exits when a required param is not set.
Parameters (2)
- 0. $param (string)
- The param.
- 1. $required — Optional. (bool) =>
false
- The required.
Usage
if ( !function_exists( 'get_cli_args' ) ) { require_once ABSPATH . '/wp-admin/includes/class-wp-importer.php'; } // The param. $param = ''; // The required. $required = false; // NOTICE! Understand what this does before running. $result = get_cli_args($param, $required);
Defined (1)
The function is defined in the following location(s).
- /wp-admin/includes/class-wp-importer.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 specified\n";
- exit();
- }
- return $return;
- }