SunshinePHP 2016


(PHP 5)

substr_compareComparación segura a nivel binario de dos o más strings desde un índice hasta una longitud de caracteres dada


int substr_compare ( string $main_str , string $str , int $offset [, int $length [, bool $case_insensitivity = false ]] )

substr_compare() compara main_str desde la posición offset con str hasta la cantidad length de caracteres.



El string principal a comparar.


El string secundario a comparar.


La posición de inicio para la comparación. Si es negativa, se comienza a contar desde el final del string.


La longitud de la comparación. El valor predeterminado es el que sea mayor entre la longitud de str comparado con la longitud de main_str menos el offset.


Si case_insensitivity es TRUE, la comparación no considera el uso de mayúsculas y minúsculas.

Valores devueltos

Devuelve < 0 si main_str, desde la posición offset, es menor que str, > 0 si es mayor que str, y 0 si son iguales. Si offset es igual o mayor que la longitud de main_str, o length se establece y es menor que 1 (antes de PHP 5.6), substr_compare() muestra una advertencia y devuelve FALSE.

Historial de cambios

Versión Descripción
5.6.0 length ahora puede ser 0.
5.1.0 Se añadió la posibilidad de usar un offset negativo.


Ejemplo #1 Un ejemplo de substr_compare()

echo substr_compare("abcde""bc"12); // 0
echo substr_compare("abcde""de", -22); // 0
echo substr_compare("abcde""bcg"12); // 0
echo substr_compare("abcde""BC"12true); // 0
echo substr_compare("abcde""bc"13); // 1
echo substr_compare("abcde""cd"12); // -1
echo substr_compare("abcde""abc"51); // advertencia

Ver también

  • strncmp() - Comparación segura a nivel binario de los primeros n caracteres entre strings

add a note add a note

User Contributed Notes 3 notes

jimmetry at gmail dot com
2 years ago
When you came to this page, you may have been looking for something a little simpler: A function that can check if a small string exists within a larger string starting at a particular index. Using substr_compare() for this can leave your code messy, because you need to check that your string is long enough (to avoid the warning), manually specify the length of the short string, and like many of the string functions, perform an integer comparison to answer a true/false question.

I put together a simple function to return true if $str exists within $mainStr. If $loc is specified, the $str must begin at that index. If not, the entire $mainStr will be searched.


function contains_substr($mainStr, $str, $loc = false) {
    if (
$loc === false) return (strpos($mainStr, $str) !== false);
    if (
strlen($mainStr) < strlen($str)) return false;
    if ((
$loc + strlen($str)) > strlen($mainStr)) return false;
    return (
strcmp(substr($mainStr, $loc, strlen($str)), $str) == 0);

3 years ago
Take note of the `length` parameter: "The default value is the largest of the length of the str compared to the length of main_str less the offset."

This is *not* the length of str as you might (I always) expect, so if you leave it out, you'll get unexpected results.  Example:

= '$5$lalalalalalalala$';
var_dump(substr_compare($hash, '$5$', 0)); # int(34)
var_dump(substr_compare($hash, '$5$', 0, 3)); # int(0)
var_dump(PHP_VERSION); # string(6) "5.3.14"
10 years ago
Modified version of the original posted function. Use this one:

if (!function_exists('substr_compare')) {
substr_compare($main_str, $str, $offset, $length = NULL, $case_insensitivity = false) {
$offset = (int) $offset;

// Throw a warning because the offset is invalid
if ($offset >= strlen($main_str)) {
trigger_error('The start position cannot exceed initial string length.', E_USER_WARNING);

// We are comparing the first n-characters of each string, so let's use the PHP function to do it
if ($offset == 0 && is_int($length) && $case_insensitivity === true) {
strncasecmp($main_str, $str, $length);

// Get the substring that we are comparing
if (is_int($length)) {
$main_substr = substr($main_str, $offset, $length);
$str_substr = substr($str, 0, $length);
        } else {
$main_substr = substr($main_str, $offset);
$str_substr = $str;

// Return a case-insensitive comparison of the two strings
if ($case_insensitivity === true) {
strcasecmp($main_substr, $str_substr);

// Return a case-sensitive comparison of the two strings
return strcmp($main_substr, $str_substr);
To Top