【PHP8.x】ReflectionParameter::getDefaultValue()メソッドの使い方

getDefaultValueメソッドは、ReflectionParameterクラスに属し、メソッドや関数の引数に設定されたデフォルト値を取得するメソッドです。

このメソッドは、指定された引数が任意（オプション）であり、かつデフォルト値が明示的に設定されている場合にその値を返します。例えば、function example(string $param = 'default') のように定義された関数の $param 引数に対してこのメソッドを使用すると、文字列 'default' が返されます。

もし対象の引数が必須の引数であり、デフォルト値が設定されていない場合、このメソッドを呼び出すと ReflectionException がスローされますので注意が必要です。そのため、デフォルト値が存在するかどうかを事前に確認したい場合は、ReflectionParameter::isDefaultValueAvailable() メソッドを利用することをお勧めします。

戻り値の型は mixed であり、これは設定されたデフォルト値が文字列、数値、配列、オブジェクトなど、どのようなデータ型であってもその値がそのまま返されることを意味します。このメソッドは、主に実行時にプログラムの構造を検査し、引数のデフォルト値を動的に知る必要があるリフレクション処理において活用されます。

Copy
1<?php
2
3function myParameterExample(string $name = 'Guest') {}
4
5$reflectionFunction = new ReflectionFunction('myParameterExample');
6$reflectionParameter = $reflectionFunction->getParameters()[0];
7
8$defaultValue = $reflectionParameter->getDefaultValue();
9
10?>

引数なし

引数はありません

mixed

このメソッドは、対象のパラメータにデフォルト値が設定されている場合に、そのデフォルト値を返します。デフォルト値が設定されていない場合は、falseを返します。