HomeMenu
Jesus · Bible · HTML · CSS · JS · PHP · SVG · Applications

strpos

Description

The strpos of String for PHP find the position of the first occurrence of a substring in a string.

Syntax

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

Parameters

haystack

The string to search in.

needle

The string to search for.

offset

If zero or positive, the search will start this number of characters counted from the beginning of the string.

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

Return

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.

WARNING: This function may return Boolean false, but may also return a non-Boolean value which evaluates to false. Use the === operator for testing the return value of this function.

Examples

1 · haystack needle · string

<?

$haystack = 'CASEcase';
$needle = 's';

$return = strpos($haystack, $needle);

echo $return;

?>
6

2 · haystack needle · chr

<?

$haystack = 'CASEcase';
$needle = chr(115);

$return = strpos($haystack, $needle);

echo $return;

?>
6

3 · offset · Negative

<?

$haystack = 'CASEcase';
$needle = 's';
$offset = -4;

$return = strpos($haystack, $needle, $offset);

echo $return;

?>
6

4 · offset · Non-negative

<?

$haystack = 'CASEcase';
$needle = 's';
$offset = 4;

$return = strpos($haystack, $needle, $offset);

echo $return;

?>
6

5 · Return

<?

// use identity operator (===) instead of comparison operator (==) to test return

$haystack = 'abc';
$needle = 'a';

$return = strpos($haystack, $needle);

if($return === false)
{
    echo "not found";
}
else
{
    echo "found";
}

?>
found