Home/ Manual/ reflection / reflectionparameter/ ReflectionParameter::getDefaultValue

ReflectionParameter::getDefaultValue

PHP function Edit on GitHub ✎

(PHP 5 >= 5.0.3, PHP 7, PHP 8)

Gets default parameter value

Description

ReflectionParameter::getDefaultValue(): mixed

Gets the default value of the parameter for any user-defined or internal function or method. If the parameter is not optional a ReflectionException will be thrown.

Parameters Parameters

Return Values

The parameters default value.

Changelog

Version	Description
8.0.0	This method now allows getting the default value of parameters of built-in functions and built-in class methods. Previously, a `ReflectionException` was thrown.

Examples

Getting default values of function parameters

php

<?php
function foo($test, $bar = 'baz')
{
    echo $test . $bar;
}

$function = new ReflectionFunction('foo');

foreach ($function->getParameters() as $param) {
    echo 'Name: ' . $param->getName() . PHP_EOL;
    if ($param->isOptional()) {
        echo 'Default value: ' . $param->getDefaultValue() . PHP_EOL;
    }
    echo PHP_EOL;
}
?>

The above example will output:

output

Name: test

Name: bar
Default value: baz