php8.5
Home/ Manual/ strings / functions/ stripos

stripos

PHP function Edit on GitHub ✎

(PHP 5, PHP 7, PHP 8)

Find the position of the first occurrence of a case-insensitive substring in a string

Description

stripos(string $haystack, string $needle, int $offset = 0): int|false

Find the numeric position of the first occurrence of needle in the haystack string.

Unlike strpos(), stripos() is case-insensitive.

Parameters

haystack

The string to search in.

needle

The string to search for.

Non-string

offset

If specified, search will start this number of characters counted from the beginning of the string. If the offset is negative, the search will start this number of characters counted from the end of the string.

Return Values

Returns the position of where the needle exists relative to the beginning of the haystack string (independent of offset). Also note that string positions start at 0, and not 1.

Returns false if the needle was not found.

Falseproblem

Errors/Exceptions

  • If offset is greater than the length of haystack, a ValueError will be thrown.

Changelog

VersionDescription
8.0.0Passing an Integer as needle is no longer supported.
7.3.0Passing an Integer as needle has been deprecated.
7.1.0Support for negative offsets has been added.

Examples

stripos() examples

php
<?php
$findme    = 'a';
$mystring1 = 'xyz';
$mystring2 = 'ABC';

$pos1 = stripos($mystring1, $findme);
$pos2 = stripos($mystring2, $findme);

// Nope, 'a' is certainly not in 'xyz'
if ($pos1 === false) {
    echo "The string '$findme' was not found in the string '$mystring1'", PHP_EOL;
}

// Note our use of !==.  Simply != would not work as expected
// because the position of 'a' is the 0th (first) character.
if ($pos2 !== false) {
    echo "We found '$findme' in '$mystring2' at position $pos2", PHP_EOL;
}
?>

Notes Bin-safe

See Also

Source: reference/strings/functions/stripos.xml · from the official PHP manual (php/doc-en)