You are here : phpstringsubstr_compare

substr_compare() - string

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 less the offset.
  • case_insensitivity - If case_insensitivity is TRUE, comparison is case insensitive.

  • Syntax

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


    Example

    <?phpecho substr_compare("abcde", "bc", 1, 2); // 0echo substr_compare("abcde", "de", -2, 2); // 0echo substr_compare("abcde", "bcg", 1, 2); // 0echo substr_compare("abcde", "BC", 1, 2, true); // 0echo substr_compare("abcde", "bc", 1, 3); // 1echo substr_compare("abcde", "cd", 1, 2); // -1echo substr_compare("abcde", "abc", 5, 1); // warning?>


    Output / Return Value


    Limitations


    Alternatives / See Also


    Reference