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

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

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

基本的な使い方

isGeneratorメソッドは、ReflectionFunctionクラスに属し、指定された関数がジェネレーター関数であるかどうかを判定するメソッドです。PHP 8以降で利用可能です。

ReflectionFunctionクラスは、PHPの関数に関する詳細な情報をプログラムから取得するための機能を提供します。その機能の一つとして、このisGeneratorメソッドがあります。ジェネレーター関数とは、yieldキーワードを使用して値を一つずつ生成し、呼び出し元に返す特殊な関数です。通常の関数が一度にすべての処理を終えて結果を返すのに対し、ジェネレーター関数は必要に応じて値を逐次的に生成するため、特に大量のデータを扱う際にメモリ使用量を抑え、処理効率を高めることができます。

isGeneratorメソッドは、対象となるReflectionFunctionオブジェクトが表す関数がジェネレーター関数であればtrueを、そうでなければfalseをブール値で返します。このメソッドを利用することで、例えば、動的にロードした関数がジェネレーターであるかどうかをプログラム的に確認し、その結果に基づいて適切な処理の分岐を行うといった応用が可能です。これにより、コードの柔軟性と堅牢性を向上させることができます。

構文(syntax)


1<?php
2function myGenerator() {
3    yield 1;
4}
5
6$reflectionFunction = new ReflectionFunction('myGenerator');
7$isGenerator = $reflectionFunction->isGenerator();
8?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

bool

このメソッドは、対象となる関数がジェネレーター関数である場合に true を、そうでない場合に false を返します。