php8.5
Home/ Manual/ mbstring / functions/ mb_strstr

mb_strstr

PHP function Edit on GitHub ✎

(PHP 5 >= 5.2.0, PHP 7, PHP 8)

Finds first occurrence of a string within another

Description

mb_strstr(string $haystack, string $needle, bool $before_needle = false, string|null $encoding = null): string|false

mb_strstr() finds the first occurrence of needle in haystack and returns the portion of haystack. If needle is not found, it returns false.

Parameters

haystack

The string from which to get the first occurrence of needle

needle

The string to find in haystack

before_needle

Determines which portion of haystack this function returns. If set to true, it returns all of haystack from the beginning to the first occurrence of needle (excluding needle). If set to false, it returns all of haystack from the first occurrence of needle to the end (including needle).

encoding

Parameter

Return Values

Returns the portion of haystack, or false if needle is not found.

Changelog

VersionDescription
8.3.2On invalid strings (those with encoding errors) and on SJIS-mac (MacJapanese) strings, the portion of haystack returned when before_needle is true is now determined from the same character indices as the other mbstring functions.

See Also

Source: reference/mbstring/functions/mb-strstr.xml · from the official PHP manual (php/doc-en)