How to Deal With Undefined Offset Error in PHP

Before discovering how to avoid the PHP undefined offset error, let’s see what it is. An undefined offset occurs when you attempt to access an array index that does not exist. This triggers a warning in PHP known as an undefined offset error.

Let’s see an example:

php undefined offset error

<?php

// Declare and initialize an array
// $students = ['Ann', 'Jennifer', 'Mary']
$students = [
    0 => 'Ann',
    1 => 'Jennifer',
    2 => 'Mary',
];

echo $students[0];

// ERROR: Undefined offset: 5
echo $students[5];

// ERROR: Undefined index: key
echo $students['key'];

?>

<div class="alert alert-info flex not-prose"> <span class="hidden md:block">Watch a video course </span> Learn object oriented PHP</div>

Below, we will show you several methods to avoid the undefined offset error.

Using the isset() Function

This function checks if a variable is set and is not null. Note that isset() returns false for null values, so if you need to distinguish between a missing key and a key with a null value, use array_key_exists() instead.

The example of using the isset function to avoid undefined offset error is as follows:

isset function to avoid undefined offset error

<?php

// Declare and initialize an array
// $students = ['Ann', 'Jennifer', 'Mary']
$students = [
    0 => 'Ann',
    1 => 'Jennifer',
    2 => 'Mary',
];

if (isset($students[5])) {
    echo $students[5];
} else {
    echo "Index not present";
}

?>

isset function to avoid undefined offset error, output

Index not present

Using the Null Coalescing Operator (??)

Introduced in PHP 7, the null coalescing operator provides a concise way to handle undefined offsets. It returns the left-hand operand if it exists and is not null; otherwise, it returns the right-hand operand.

php null coalescing operator to avoid undefined offset error

<?php

// Declare and initialize an array
$students = [
    0 => 'Ann',
    1 => 'Jennifer',
    2 => 'Mary',
];

// Safely access index 5, defaulting to "Index not present"
echo $students[5] ?? "Index not present";

?>

php null coalescing operator to avoid undefined offset error, output

Index not present

Using the array_key_exists() Function

This function checks whether a specific key exists in an array, regardless of whether its value is null. It works with both numeric and associative arrays.

The <kbd class="highlighted">array_key_exists</kbd> function is used for testing if a particular key exists in an array or not.

Here is an example:

php array_key_exists function to avoid undefined offset error

<?php
// PHP program to illustrate the use
// of array_key_exists() function

function Exists($index, $array)
{
    if (array_key_exists($index, $array)) {
        echo "Key Found";
    } else {
        echo "Key not Found";
    }
}

$array = [
    "john" => 25,
    "david" => 10,
    "jack" => 20,
];

$index = "jack";

print_r(Exists($index, $array));

?>

php array_key_exists function to avoid undefined offset error, output

Key Found