php-doc-en/reference/mbstring/functions/mb-strstr.xml
Kim Hallberg f63aa0afcd
[80738] Update MB string functions (#630)
* Add new `mbstring.changelog.needle-empty` entity

* Update changelog with `mbstring.changelog.needle-empty` entity
The following functions now support an empty `needle` argument.

- mb_strpos
- mb_strrpos
- mb_stripos
- mb_strripos
- mb_strstr
- mb_stristr
- mb_strrchr
- mb_strrichr
2021-09-17 20:53:19 +01:00

167 lines
4.7 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry xml:id="function.mb-strstr" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mb_strstr</refname>
<refpurpose>Finds first occurrence of a string within another</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>string</type><type>false</type></type><methodname>mb_strstr</methodname>
<methodparam><type>string</type><parameter>haystack</parameter></methodparam>
<methodparam><type>string</type><parameter>needle</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>before_needle</parameter><initializer>&false;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>mb_strstr</function> finds the first occurrence of
<parameter>needle</parameter> in <parameter>haystack</parameter>
and returns the portion of <parameter>haystack</parameter>.
If <parameter>needle</parameter> is not found, it returns &false;.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>haystack</parameter></term>
<listitem>
<para>
The string from which to get the first occurrence
of <parameter>needle</parameter>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>needle</parameter></term>
<listitem>
<para>
The string to find in <parameter>haystack</parameter>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>before_needle</parameter></term>
<listitem>
<para>
Determines which portion of <parameter>haystack</parameter>
this function returns.
If set to &true;, it returns all of <parameter>haystack</parameter>
from the beginning to the first occurrence of <parameter>needle</parameter> (excluding needle).
If set to &false;, it returns all of <parameter>haystack</parameter>
from the first occurrence of <parameter>needle</parameter> to the end (including needle).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>encoding</parameter></term>
<listitem>
<para>
Character encoding name to use.
If it is omitted, internal character encoding is used.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the portion of <parameter>haystack</parameter>,
or &false; if <parameter>needle</parameter> is not found.
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&mbstring.changelog.needle-empty;
&mbstring.changelog.encoding-nullable;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>mb_strstr</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>stristr</function></member>
<member><function>strstr</function></member>
<member><function>mb_stristr</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->