HH\Lib\Str\search

This API is part of the Hack Standard Library, not HHVM itself.
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

Description

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.

Previously known in PHP as strpos.

Parameters

  • string $haystack
  • string $needle
  • int $offset = 0