Loader

substr_compare

substr_compare() compares main_str from position offset with str up to length characters. Test substr_compare online.

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

PHP Documentation by the PHP Documentation Group

substr_compare

(PHP 5, PHP 7)

substr_compareBinary safe comparison of two strings from an offset, up to length characters

Description

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

substr_compare() compares main_str from position offset with str up to length characters.

Parameters

main_str

The main string being compared.

str

The secondary string being compared.

offset

The start position for the comparison. If negative, it starts counting from the end of the string.

length

The length of the comparison. The default value is the largest of the length of the str compared to the length of main_str minus the offset.

case_insensitivity

If case_insensitivity is TRUE, comparison is case insensitive.

Return Values

Returns < 0 if main_str from position offset is less than str, > 0 if it is greater than str, and 0 if they are equal. If offset is equal to (prior to PHP 7.2.18, 7.3.5) or greater than the length of main_str, or the length is set and is less than 0, (or, prior to PHP 5.5.11, less than 1) substr_compare() prints a warning and returns FALSE.

Changelog

Version Description
7.2.18, 7.3.5 offset may now be equal to the length of main_str.
5.5.11 length may now be 0.
5.1.0 Added the possibility to use a negative offset.

Examples

Example #1 A substr_compare() example

<?php
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); // warning
?>

See Also

  • strncmp() - Binary safe string comparison of the first n characters

PHP Documentation

Copyright © 1997 - 2016 by the PHP Documentation Group. This material may be distributed only subject to the terms and conditions set forth in the Creative Commons Attribution 3.0 License or later. A copy of the Creative Commons Attribution 3.0 license is distributed with this manual. The latest version is presently available at » http://creativecommons.org/licenses/by/3.0/.