substr_compare
(PHP 5, PHP 7)
substr_compare — Binary safe comparison of two strings from an offset, up to length characters
Description
$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
strcompared to the length ofmain_strminus theoffset. -
case_insensitivity -
If
case_insensitivityisTRUE, 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", 1, 2); // 0
echo substr_compare("abcde", "de", -2, 2); // 0
echo substr_compare("abcde", "bcg", 1, 2); // 0
echo substr_compare("abcde", "BC", 1, 2, true); // 0
echo substr_compare("abcde", "bc", 1, 3); // 1
echo substr_compare("abcde", "cd", 1, 2); // -1
echo substr_compare("abcde", "abc", 5, 1); // warning
?>
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-function.substr-compare.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.
