The substr_compare() function compares two strings from a specified start position.
int substr_compare ( string $main_str , string $str , int $offset [, int $length [, bool $case_insensitivity = FALSE ]] )
substr_compare() compares main_str from position offset with str up to length characters
| Parameter | Description |
|---|---|
| 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 less the offset. |
| case_insensitivity | If case_insensitivity is TRUE, comparison is case insensitive. |
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 or greater than the length of main_str, or the length is set and is less than 1 (prior to PHP 5.5.11), substr_compare() prints a warning and returns FALSE.