How to Set Default Argument Values in PHP Functions

In PHP, setting default values for function arguments allows you to make parameters optional when calling a function. This article explains how to define default argument values in PHP, covers the essential rules for ordering parameters, and demonstrates how to use this feature with practical code examples.

Basic Syntax

To assign a default value to a function parameter, use the assignment operator (=) followed by the default value in the function’s declaration. If the caller does not provide a value for that argument, PHP will automatically use the assigned default.

function greet($name = "Guest") {
    return "Hello, $name!";
}

// Uses the default value
echo greet(); // Outputs: Hello, Guest!

// Overrides the default value
echo greet("Alice"); // Outputs: Hello, Alice!

Argument Ordering Rules

When defining functions with a mix of required and optional arguments, you must place the arguments with default values after any arguments that do not have default values. Placing optional arguments before required ones is deprecated in PHP 8.0 and will result in a deprecation warning or error.

Incorrect Way:

// This will trigger a deprecation warning in modern PHP
function createUser($role = "member", $username) {
    return "User $username is a $role.";
}

Correct Way:

function createUser($username, $role = "member") {
    return "User $username is a $role.";
}

// Correct usage
echo createUser("johndoe"); // Outputs: User johndoe is a member.

Using Null as a Default Value

You can set the default value of an argument to null. This is particularly useful when combined with type declarations to indicate that a parameter is optional and can accept either a specific type or nothing.

function setProfilePicture(string $username, ?string $imagePath = null) {
    if ($imagePath === null) {
        return "Using default avatar for $username.";
    }
    return "Setting $imagePath as profile picture for $username.";
}

echo setProfilePicture("alex"); // Outputs: Using default avatar for alex.

Allowed Default Values

In PHP, default values must be constant expressions. This means you can use scalar types (like strings, integers, floats, and booleans), arrays, null, and constant values. However, you cannot use dynamic evaluations, such as function calls or variable assignments, as default values.

// Allowed: Using an array as a default value
```php
function configureDatabase(array $options = ['host' => 'localhost', 'port' => 3306]) {
    return "Connecting to " . $options['host'];
}