PHP Array Sum Function Explained: How to Calculate the Sum of an Array in PHP

As a developer, you know that PHP is a powerful language that allows you to create dynamic websites with ease. One of the most common tasks in web development is working with arrays. And when it comes to working with arrays in PHP, one of the most useful functions is the array_sum() function. In this article, we will provide a comprehensive guide on how to use the array_sum() function in PHP, including real-world examples and best practices.

What is the Array Sum Function in PHP?

The array_sum() function in PHP is a built-in function that calculates and returns the sum of all the values in an array. It is a simple yet powerful function that can save you a lot of time and effort when working with arrays. The function takes a single parameter, which is the array you want to calculate the sum of.

Here's the basic syntax of the array_sum() function:

PHP array_sum syntax

array_sum(array $array): int|float

As you can see, the function takes an array as its parameter and returns an int|float value, which is the sum of all the values in the array.

How to Use the Array Sum Function in PHP

Using the array_sum() function in PHP is quite straightforward. All you need to do is pass an array to the function, and it will return the sum of all the values in the array.

Here's an example:

PHP example of array_sum function usage

<‌?php

$numbers = array(1, 2, 3, 4, 5);
$sum = array_sum($numbers);

echo "The sum of the numbers is: " . $sum;

?>

Try it Yourself »

In this example, we define an array called $numbers containing five integers. We pass it to array_sum(), which returns the total. Finally, we display the result using echo.

Note: array_sum() automatically casts values to numbers. Strings containing numeric characters are converted to numbers, while non-numeric strings are treated as 0.

The output of this code will be:

---

The sum of the numbers is: 15

Real-World Examples of Using the Array Sum Function in PHP

Now that you know how to use the array_sum() function in PHP, let's take a look at some real-world examples of how this function can be used in web development.

Example 1: Calculating the Total Price of Items in a Shopping Cart

Suppose you are building an e-commerce website and you want to calculate the total price of all the items in a shopping cart. You can use the array_sum() function to easily calculate the total price.

Here's an example:

PHP Example 1: Calculating the Total Price using array_sum function

<‌?php

$cart = array(
    array("name" => "Product 1", "price" => 10),
    array("name" => "Product 2", "price" => 20),
    array("name" => "Product 3", "price" => 30)
);

$prices = array_column($cart, "price");
$total_price = array_sum($prices);

echo "The total price of the items in the cart is: $" . $total_price;

?>

Try it Yourself »

Here, we define a $cart array with product details. We extract the prices using array_column(), sum them with array_sum(), and display the result.

The output of this code will be:

---

The total price of the items in the cart is: $60

Example 2: Calculating the Average Score

In this example, we define a $scores array with five student grades. We calculate the average by dividing the sum of the scores by the count of items, then display the result.

PHP calculate average using array_sum

<‌?php

$scores = array(80, 90, 70, 85, 95);
$average_score = array_sum($scores) / count($scores);

echo "The average score of the students is: " . $average_score;

?>

Try it Yourself »

The output of this code will be:

---

The average score of the students is: 84

Best Practices for Using the Array Sum Function in PHP

While the array_sum() function in PHP is quite simple to use, there are a few best practices you should keep in mind to ensure that you use it correctly and efficiently.

1. Check that the Input is an Array

Before you use the array_sum() function, it's important to ensure the input is actually an array. In PHP 8+, passing a non-array value throws a TypeError instead of a warning.

To check if a variable is an array, you can use the is_array() function. Here's an example:

PHP check if the input is an array

if (is_array($numbers)) {
    $sum = array_sum($numbers);
} else {
    // handle the error
}

We verify the variable with is_array() before calling array_sum(). If it's not an array, we handle the error appropriately.

2. Handle Empty Arrays

If you pass an empty array to the array_sum() function, it will return a value of 0. While this might be the correct value in some cases, it's important to handle empty arrays in a way that makes sense for your application.

For example, if you're calculating the average score of students in a class and there are no students, you might want to display a message indicating that there are no scores to average.

PHP Handle Empty Arrays while using array_sum

if (empty($scores)) {
    echo "There are no scores to average.";
} else {
    $average_score = array_sum($scores) / count($scores);
    echo "The average score of the students is: " . $average_score;
}

We check if $scores is empty using empty(). If it is, we show a message; otherwise, we calculate and display the average.

Conclusion

The array_sum() function in PHP is a simple yet powerful function that can save you a lot of time and effort when working with arrays. It allows you to easily calculate the sum of all the values in an array, which can be useful in a wide range of applications.

In this article, we provided a comprehensive guide on how to use the array_sum() function in PHP, including real-world examples and best practices. By following these guidelines, you can ensure that you use the function correctly and efficiently, and create more reliable PHP applications.

Practice

What is the purpose of the array_sum() function in PHP?

It calculates the product of the values in an arrayIt calculates the sum of the values in an arrayIt sorts the values in an arrayIt negates the values in an array