STRISTR(3) 1 STRISTR(3)
stristr - Case-insensitivestrstr(3)
SYNOPSIS
string stristr (string $haystack, mixed $needle, [bool $before_needle = false])
DESCRIPTION
Returns all of $haystack starting from and including the first occurrence of $needle to the end.
PARAMETERS
o $haystack
- The string to search in
o $needle
- If $needle is not a string, it is converted to an integer and applied as the ordinal value of a character.
o $before_needle
- If TRUE, stristr(3) returns the part of the $haystack before the first occurrence of the $needle (excluding needle).
$needle and $haystack are examined in a case-insensitive manner.
RETURN VALUES
Returns the matched substring. If $needle is not found, returns FALSE.
CHANGELOG
+--------+-----------------------------------------------+
|Version | |
| | |
| | Description |
| | |
+--------+-----------------------------------------------+
| 5.3.0 | |
| | |
| | Added the optional parameter $before_needle. |
| | |
| 4.3.0 | |
| | |
| | stristr(3) was made binary safe. |
| | |
+--------+-----------------------------------------------+
EXAMPLES
Example #1
stristr(3) example
<?php
$email = 'USER@EXAMPLE.com';
echo stristr($email, 'e'); // outputs ER@EXAMPLE.com
echo stristr($email, 'e', true); // As of PHP 5.3.0, outputs US
?>
Example #2
Testing if a string is found or not
<?php
$string = 'Hello World!';
if(stristr($string, 'earth') === FALSE) {
echo '"earth" not found in string';
}
// outputs: "earth" not found in string
?>
Example #3
Using a non "string" needle
<?php
$string = 'APPLE';
echo stristr($string, 97); // 97 = lowercase a
// outputs: APPLE
?>
NOTES
Note
This function is binary-safe.
SEE ALSO
strstr(3), strrchr(3), stripos(3), strpbrk(3), preg_match(3).
PHP Documentation Group STRISTR(3)
