HH\Lib\Str\search
Requires the Hack Standard Library to be installed.
Facebook Engineer?
This function is available as Str\search()
in Facebook's www repository.
Returns the first position of the "needle" string in the "haystack" string, or null if it isn't found
namespace HH\Lib\Str;
function search(
string $haystack,
string $needle,
int $offset = 0,
): ?int;
An optional offset determines where in the haystack the search begins. If the offset is negative, the search will begin that many characters from the end of the string. If the offset is out-of-bounds, a ViolationException will be thrown.
- To simply check if the haystack contains the needle, see
Str\contains()
. - To get the case-insensitive position, see
Str\search_ci()
. - To get the last position of the needle, see
Str\search_last()
.
Previously known in PHP as strpos
.
Parameters
string $haystack
string $needle
int $offset = 0
Returns
?int