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

getShortNameメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 2025年09月11日更新日: 2026年01月21日

基本的な使い方

getShortNameメソッドは、PHPのReflectionFunctionクラスが提供する機能の一つで、リフレクションによって取得された関数の「短い名前」つまり、名前空間を含まない純粋な関数名を取得するメソッドです。

ReflectionFunctionクラスは、PHPの実行時に、定義済みの関数に関する詳細な情報をプログラム的に調べたり操作したりするための強力なツールです。引数の数や型、戻り値の型、関数が定義されているファイルパスなど、様々なメタデータを取得できます。

getShortNameメソッドは、特に名前空間を持つ関数に対して有用です。PHP 5.3以降では名前空間の概念が導入され、関数はMyNamespace\myFunctionのように名前空間と結びついて定義されることがあります。このような場合、getName()メソッドではMyNamespace\myFunctionという完全修飾名が返されますが、getShortName()メソッドを呼び出すと、名前空間部分を取り除いたmyFunctionという、関数本来の短い名前のみを抽出して取得できます。

この機能は、アプリケーション内で関数のリストを表示する際や、デバッグ目的でログに関数名を出力する際など、完全な名前空間情報が不要で、より簡潔な関数名が必要となる場面で非常に役立ちます。例えば、特定の名前空間に属する関数群から、その機能を示す共通の名前部分だけを抽出し、ユーザーインターフェースに表示するといった用途に利用できます。これにより、複雑な名前空間の構造を意識することなく、関数の本質的な名前だけを効率的に扱うことが可能になります。

構文(syntax)


1<?php
2
3$reflectionFunction = new ReflectionFunction('function_name');
4$shortName = $reflectionFunction->getShortName();

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

このメソッドは、ReflectionFunctionオブジェクトが表す関数の短い名前を文字列で返します。

サンプルコード

PHP ReflectionFunction::getShortNameで関数名を取得する


1<?php
2
3namespace App\Utility;
4
5/**
6 * この関数はReflectionFunction::getShortNameのデモンストレーションに使用されます。
7 * 
8 * @param string $message 表示するメッセージ
9 * @return string 整形されたメッセージ
10 */
11function formatMessage(string $message): string
12{
13    return "[INFO] " . $message;
14}
15
16// ReflectionFunctionクラスのインスタンスを作成します。
17// 名前空間を持つ関数の場合、完全修飾名（FQDN）を指定する必要があります。
18$reflectionFunction = new \ReflectionFunction('App\\Utility\\formatMessage');
19
20// getShortName()メソッドを呼び出し、関数名を名前空間なしで取得します。
21// 例: 'App\Utility\formatMessage' から 'formatMessage' を取得します。
22$shortFunctionName = $reflectionFunction->getShortName();
23
24// 結果を出力します。
25echo "元の関数名 (完全修飾名): " . $reflectionFunction->getName() . PHP_EOL;
26echo "短縮された関数名 (getShortName): " . $shortFunctionName . PHP_EOL;
27
28// グローバルスコープの関数で試す場合：
29/**
30 * グローバルスコープのサンプル関数
31 * @return void
32 */
33function simpleGlobalFunction(): void
34{
35    // 何もしない
36}
37
38$reflectionGlobalFunction = new \ReflectionFunction('simpleGlobalFunction');
39$shortGlobalFunctionName = $reflectionGlobalFunction->getShortName();
40
41echo "グローバル関数の名前 (完全修飾名): " . $reflectionGlobalFunction->getName() . PHP_EOL;
42echo "グローバル関数の短縮名 (getShortName): " . $shortGlobalFunctionName . PHP_EOL;
43
44?>

PHPのReflectionFunction::getShortNameメソッドは、関数に関する情報を動的に取得する「リフレクション」機能の一つです。このメソッドは、指定した関数名から名前空間の部分を除いた、関数の「短い名前」を文字列として取得します。引数は不要で、短縮された関数名をstring型で返します。

サンプルコードでは、まずApp\Utility\formatMessageという名前空間を持つ関数を例に挙げています。ReflectionFunctionクラスのインスタンスを作成し、getShortName()メソッドを呼び出すと、名前空間が取り除かれたformatMessageという文字列が得られます。これにより、完全修飾名がApp\Utility\formatMessageである関数から、その名前空間に属する実際の関数名のみを抽出することができます。

一方、simpleGlobalFunctionのようにグローバルスコープ（名前空間を持たない）で定義された関数に対してgetShortName()を適用した場合、元の関数名と同じsimpleGlobalFunctionが結果として返されます。これは、元々名前空間がないため、短縮する必要がないためです。このメソッドは、特にログ出力やエラーメッセージなど、完全な関数名ではなく簡潔な名前が必要な場面で活用できます。

ReflectionFunctionをインスタンス化する際は、引数に関数の「完全修飾名」（FQDN）を文字列で正確に指定する必要があります。特に名前空間を持つ関数の場合、名前空間を含めずに指定するとエラーになるため注意が必要です。指定した関数が存在しない場合も例外が発生します。

getShortNameメソッドは、関数の名前空間情報を取り除き、純粋な関数名のみを文字列として返します。これはgetNameメソッドが名前空間を含む完全修飾名を返すのとは異なり、関数の「短い名前」だけが必要な場合に利用します。プログラムの実行時に動的に関数名を解析したり、出力表示を調整したりする際に便利な機能です。目的によってgetNameとgetShortNameを適切に使い分けましょう。