Obtain first line of a string in PHP

kinokijuf picture kinokijuf · Feb 1, 2012 · Viewed 41k times · Source

In PHP 5.3 there is a nice function that seems to do what I want:

strstr(input,"\n",true)

Unfortunately, the server runs PHP 5.2.17 and the optional third parameter of strstr is not available. Is there a way to achieve this in previous versions in one line?

Answer

Your Common Sense picture Your Common Sense · Feb 1, 2012

Given that a line could be delimited by either one ("\n") or two ("\r\n") characters, the most bullet-proof method would be

$line = preg_split('#\r?\n#', $input, 0)[0];

for any sequence before the first line feed, even if it an empty string, and

$line = preg_split('#\r?\n#', ltrim($input), 0)[0];

for the first non-empty string.

When this answer was first written, almost a decade ago, it featured a few subtle nuances

  • it was too localized, following the Opening Post with the assumption that the line delimiter is always a single "\n" character, which is not always the case. Using PHP_EOL is not the solution as we can be dealing with outside data, not affected by the local system settings
  • it was assumed that we need the first non-empty string
  • there was no way to use either explode() or preg_split() in one line, hence a trick with strtok() was proposed. However, shortly after, thanks to the Uniform Variable Syntax, proposed by Nikita Popov, it become possible to use one of these functions in a neat one-liner

but as this question gained some popularity, it is essential to cover all the possible edge cases in the answer. But for the historical reasons here is the original answer

$str = strtok($input, "\n");

that will return the first non-empty line from the text in the unix format.

However, given that the line delimiters could be different and the behavior of strtok() is not that straight, as "Delimiter characters at the start or end of the string are ignored", as it says the man page for the original strtok() function in C, now I would advise to use this function with caution.