Content · Web Development · PHP

PHP sodium_add() Function: Usage and Examples

sodium_add adds two equal-length little-endian binary integers in.

1 views Published Oct 17, 2026 Updated Oct 17, 2026 admin

sodium_add adds two equal-length little-endian binary integers in place.

The examples explain the data format, expected results and the difference between this API and nearby cryptographic operations.

What It Does


The operation is intended for: sodium_add adds two equal-length little-endian binary integers in place.

The sodium extension must be enabled.

Syntax and Return Value


sodium_add(string $string1, string $string2): void
ParameterPurpose
$string1 (string)Use the PHP signature above to determine the exact expected input type; validate untrusted inputs before calling.
$string2 (string)Use the PHP signature above to determine the exact expected input type; validate untrusted inputs before calling.

The declared return type is shown above. Errors can include false results or exceptions depending on this API: Encoding does not encrypt or authenticate data; exact byte lengths and formats still matter.

Example 1: Basic Operation


Inspect the output: this operation works on raw byte strings and does not by itself provide encryption.

<?php
$message = "Account update";
$left = hex2bin('01000000'); $right = hex2bin('02000000');
sodium_add($left, $right); echo bin2hex($left);

Example 2: A Different Use Case


Inspect the output: this operation works on raw byte strings and does not by itself provide encryption.

<?php
// Check the alternative case.
$message = "New order: 42";
$left = hex2bin('01000000'); $right = hex2bin('02000000');
sodium_add($left, $right); echo bin2hex($left);

Practical Example: Checking the Result


Inspect the output: this operation works on raw byte strings and does not by itself provide encryption.

<?php
// Verify the expected behavior before using results.
$message = "Export completed";
$left = hex2bin('01000000'); $right = hex2bin('02000000');
sodium_add($left, $right); echo bin2hex($left);

Important Behavior and Edge Cases


Encoding does not encrypt or authenticate data; exact byte lengths and formats still matter.

Encoding does not encrypt or authenticate data; exact byte lengths and formats still matter.

Comparison with Related Functions


ApproachKey distinction
sodium_addsodium_add adds two equal-length little-endian binary integers in place.
Related techniqueCryptographic primitives such as secretbox and auth provide actual security properties.

Common Beginner Mistakes


MistakeCorrect approach
Confusing this operation with a neighboring cryptographic or security mechanismCryptographic primitives such as secretbox and auth provide actual security properties.
Ignoring a security prerequisite or failure caseEncoding does not encrypt or authenticate data; exact byte lengths and formats still matter.

Key Takeaways


  • sodium_add adds two equal-length little-endian binary integers in place.
  • Encoding does not encrypt or authenticate data; exact byte lengths and formats still matter.
  • Cryptographic primitives such as secretbox and auth provide actual security properties.

Apply this behavior to a real application only after confirming the required extension, configuration and failure handling on the deployment runtime.

Share this resourceSend this page to someone who may find it useful.