PHP 함수: 정의, 반환값, 매개변수, 타입

PHP 함수는 function 키워드, 이름, 매개변수 목록, 본문으로 정의하며, return이 호출한 쪽에 값을 돌려보냅니다. function add(int $a, int $b): int { return $a + $b; }로 정의하고, add(2, 3)으로 호출하면 5를 반환합니다.

<?php
function greet(string $name): string
{
    return "Hello, $name";
}

function add(int $a, int $b): int
{
    return $a + $b;
}

echo greet('Ada'), "\n";
echo add(2, 3), "\n";
echo add(add(1, 2), 10), "\n";

매개변수 앞의 string과 int는 타입 선언이고, 괄호 뒤의 : string은 반환 타입입니다. 둘 다 선택 사항이지만 실수를 일찍 잡아내고 함수가 무엇을 기대하는지 문서화해 줍니다.

반환값과 여러 값 반환하기

return은 함수를 즉시 끝냅니다. return이 없거나 그냥 return;만 있는 함수는 null을 반환합니다. 효과만을 위해 호출하는 함수라면 : void를 선언하세요. 함수는 값을 하나 반환하지만, 그 값이 배열일 수 있으며 호출하는 쪽에서 구조 분해합니다.

<?php
function grade(int $score): string
{
    if ($score >= 90) {
        return 'A';
    }
    return $score >= 75 ? 'B' : 'C';   // reached only below 90
}

function stats(array $numbers): array
{
    return [
        'min' => min($numbers),
        'max' => max($numbers),
        'avg' => array_sum($numbers) / count($numbers),
    ];
}

function logLine(string $msg): void
{
    echo "[log] $msg\n";
}

echo grade(95), grade(80), grade(40), "\n";

['min' => $min, 'max' => $max, 'avg' => $avg] = stats([4, 8, 15, 16, 23, 42]);
echo "min $min, max $max, average $avg\n";

[$quotient, $remainder] = [intdiv(17, 5), 17 % 5];
echo "17 / 5 = $quotient remainder $remainder\n";

var_dump(logLine('saved'));   // a void function returns null

[...] =의 다른 형태는 배열 구조 분해를 참고하세요.

기본 매개변수와 이름 있는 인수

= value가 붙은 매개변수는 선택 사항이라 호출할 때 생략할 수 있습니다. 선택적 매개변수는 필수 매개변수 뒤에 옵니다. PHP 8.0부터는 이름 있는 인수로 어떤 매개변수든 이름으로 넘길 수 있어서 필요 없는 선택적 매개변수를 건너뛸 수 있습니다.

<?php
function makeTag(string $text, string $tag = 'p', ?string $class = null, bool $escape = true): string
{
    $body = $escape ? htmlspecialchars($text) : $text;
    $attr = $class !== null ? " class=\"$class\"" : '';
    return "<$tag$attr>$body</$tag>";
}

echo makeTag('Hello'), "\n";
echo makeTag('Title', 'h1'), "\n";

// Named arguments: skip $tag and $class, set only $escape
echo makeTag('<b>bold</b>', escape: false), "\n";
echo makeTag(class: 'note', text: 'Order does not matter'), "\n";

이름 있는 인수는 내장 함수 호출도 읽기 쉽게 만듭니다: str_pad('7', 3, '0', pad_type: STR_PAD_LEFT). 매개변수 이름이 함수의 공개 인터페이스 일부가 되므로, 매개변수 이름을 바꾸면 이름을 쓰는 호출이 깨질 수 있습니다.

참조 전달

보통 PHP는 각 인수의 복사본을 넘기므로 함수가 호출한 쪽의 변수를 바꿀 수 없습니다. 매개변수 앞의 &는 변수 자체를 넘깁니다. sort() 같은 내장 함수가 이 방식으로 동작합니다.

<?php
function addOne(int $n): void
{
    $n++;          // changes the copy only
}

function addOneRef(int &$n): void
{
    $n++;          // changes the caller's variable
}

$a = 5;
addOne($a);
echo $a, "\n";

addOneRef($a);
echo $a, "\n";

function addItem(array &$cart, string $item): void
{
    $cart[] = $item;
}

$cart = [];
addItem($cart, 'apple');
addItem($cart, 'pear');
print_r($cart);

인수를 바꾸는 것보다 새 값을 반환하는 편이 보통 더 명확합니다. 함수가 정말로 무언가를 그 자리에서 수정하기 위한 것일 때 참조를 쓰세요.

타입 선언과 strict_types

기본적으로 PHP는 가능하면 인수를 선언된 타입으로 변환합니다. add("5", 3)은 "5"를 5로 바꿉니다. 파일 맨 위에 declare(strict_types=1);을 두면 그 파일에서 하는 호출에 대해 이 변환을 끄므로, 잘못된 타입은 변환되는 대신 TypeError를 던집니다.

<?php
declare(strict_types=1);
// This throws a TypeError on purpose: "5" is a string, not an int

function add(int $a, int $b): int
{
    return $a + $b;
}

echo add(2, 3), "\n";
echo add("5", 3), "\n";

declare 줄이 없으면 같은 호출이 8을 출력합니다. "five"처럼 숫자가 아닌 문자열은 두 모드 모두에서 TypeError를 던집니다.

매개변수와 반환값에 선언할 수 있는 타입입니다.

<?php
// ?string: a string or null
function findUser(int $id): ?string
{
    $users = [1 => 'Ada', 2 => 'Linus'];
    return $users[$id] ?? null;
}

// int|float: a union type (PHP 8.0)
function half(int|float $n): float
{
    return $n / 2;
}

// mixed: anything at all
function describe(mixed $value): string
{
    return get_debug_type($value);
}

var_dump(findUser(1), findUser(9));
var_dump(half(5), half(2.5));
echo describe([1, 2]), ' ', describe(null), ' ', describe(1.5), "\n";

never는 항상 예외를 던지거나 종료하는 함수의 반환 타입입니다. 클래스와 인터페이스 이름도 타입으로 쓸 수 있습니다.

...$args로 가변 개수 인수 받기

...$numbers는 개수에 상관없이 인수를 배열로 모읍니다. 호출하는 쪽의 같은 ...은 배열을 개별 인수로 펼칩니다.

<?php
function sum(int ...$numbers): int
{
    return array_sum($numbers);
}

echo sum(), "\n";
echo sum(1, 2, 3), "\n";

$values = [10, 20, 30];
echo sum(...$values), "\n";          // spread an array

function logMessage(string $level, string ...$parts): string
{
    return strtoupper($level) . ': ' . implode(' ', $parts);
}

echo logMessage('info', 'user', 'Ada', 'logged in'), "\n";

함수 안에서 바깥 변수 쓰기

함수에는 자체 스코프가 있습니다. 바깥에서 정의한 변수는 안에서 보이지 않으며, JavaScript에서 온 사람들은 이 점에 놀랍니다.

<?php
$taxRate = 0.2;

function priceWithTax(float $price): float
{
    return $price * (1 + $taxRate);   // $taxRate is undefined here
}

Warning: Undefined variable $taxRate in /path/to/index.php on line 6

그리고 함수는 세금이 빠진 가격을 반환합니다. 대신 값을 매개변수로 넘기세요. 그러면 함수가 무엇에 의존하는지 분명해지고 테스트하기 쉬워집니다.

<?php
$taxRate = 0.2;

function priceWithTax(float $price, float $taxRate): float
{
    return $price * (1 + $taxRate);
}

echo priceWithTax(100, $taxRate), "\n";
echo priceWithTax(100, 0.1), "\n";

global 키워드도 동작하지만 의존성을 숨깁니다. 변수 스코프에서 다룹니다. array_map()의 콜백처럼 다른 함수에 넘기는 짧은 함수는 use로 바깥 변수를 가져올 수 있는 익명 함수를 참고하세요.