DocumentationHSLReferenceFunctionHH\Lib\Str\search_ci

HH\Lib\Str\search_ci

Meta Engineer?

This is available as Str\search_ci in the www repository.

Returns the first position of the "needle" string in the "haystack" string, or null if it isn't found (case-insensitive)

namespace HH\Lib\Str;

function search_ci(
  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-sensitive position, see Str\search().
To get the last position of the needle, see Str\search_last().

Previously known in PHP as stripos.

Guide

String

Parameters

string $haystack
string $needle
int $offset = 0

Returns

?int

Examples

$result = Str\search_ci("example_string", "example");
echo($result);
//result: 0

$result = Str\search_ci("example_string", "EXAMPLE");
echo($result);
//result: 0

$result = Str\search_ci("example_string", "example", 2); // with offset
echo($result);
//result: null

$result = Str\search_ci("example_string", "uncontained");
echo($result);
//result: null