This is an old revision of the document!

PHP RFC: Add str begin and end functions


PHP does not contain functions to test if a string begins or ends with a certain substring. This is currently possible using several other functions, but adding pre-built functions to do this will improve the readability and clarity of PHP code using the function. This feature has been requested multiple times and would be of use to many PHP developers with varying levels of experience.


Add str_begins(), str_ibegins(), str_ends(), str_iends(), mb_str_begins(), mb_str_ibegins(), mb_str_ends(), and mb_str_iends() functions

boolean str_begins[(string $haystack, string $needle)]
boolean str_ibegins[(string $haystack, string $needle)]
boolean str_ends[(string $haystack, string $needle)]
boolean str_iends[(string $haystack, string $needle)]
boolean mb_str_begins[(string $haystack, string $needle [, string $encoding])]
boolean mb_str_ibegins[(string $haystack, string $needle [, string $encoding])]
boolean mb_str_ends[(string $haystack, string $needle [, string $encoding])]
boolean mb_str_iends[(string $haystack, string $needle [, string $encoding])]

str_begins() checks if $haystack begins with $needle. It accomplishes this by comparing each character in $haystack with the corresponding character in $needle. If any of the characters do not match, it will return false. str_ends() does the same thing except in reverse: it starts at the end of both $haystack and $needle and compares each character in $haystack to the corresponding character in $needle.

str_ibegins() and str_iends() do the same thing, except they are case insensitive.

The mb_* versions of these method function very similar except they make use of the mbfl_strpos() function or the php_mb_stripos() helper function.

Examples below:

$str = "beginningMiddleEnd";
if (str_begin("beg", $str))
    echo "This condition would be true";
 if (str_begins("Beg", $str))
     echo "This condition would not be true";
 if (str_ibegin("beg", $str))
     echo "This condition would be true";
 if (str_ibegin("Beg", $str))
     echo "This condition would also be true";
 if (str_end("End", $str))
    echo "This condition would be true";
 if (str_end("end", $str))
     echo "This condition would not be true";
 if (str_iend("End", $str))
     echo "This condition would be true";
 if (str_iend("end", $str))
     echo "This condition would also be true";

Backward Incompatible Changes


Proposed PHP Version(s)

Next PHP 7.x release.

RFC Impact


Will add the aforementioned functions to all PHP environments.

To Existing Extensions

Adds mb_str_begins(), mb_str_ibegins(), mb_str_ends(), and mb_str_iends() to the mbstring extension.

To Opcache

No effect.

New Constants

No new constants.

php.ini Defaults

No changed php.ini settings.

Open Issues

This functionality was requested in both of these bug reports: https://bugs.php.net/bug.php?id=67035 and https://bugs.php.net/bug.php?id=50434.

Unaffected PHP Functionality

The PHP string library has been modified. This means that strings.c, basic_functions.c, and php_strings.h have all been modified. Additionally the mbstring library has been modified.

Future Scope

Once this feature is approved and added, it will not need any future improvements.

Proposed Voting Choices

This project requires a 2/3 majority to be approved.

Patches and Tests


After the project is implemented, this section should contain

  1. the version(s) it was merged to
  2. a link to the git commit(s)
  3. a link to the PHP manual entry for the feature


Links to external references, discussions or RFCs

Related feature request: bug #50434.

Rejected Features

Keep this updated with features that were discussed on the mail lists.

rfc/add_str_begin_and_end_functions.1560883147.txt.gz · Last modified: 2019/06/18 18:39 by wkhudgins92