Getting An Excerpt Of Text With PHP

1st June 2008 - 5 minutes read time

I have talked before about truncating strings to include whole words, but what if you want to have complete sentences? The following function will truncate a string the number of words specified and until the sentence ends.

function excerpt($paragraph, $limit)
{
 $tok = strtok($paragraph, " ");
 while ($tok !== false) {
  $text .= " ".$tok;
  $words++;
  if (($words >= $limit) && ((substr($tok, -1) == "!") || (substr($tok, -1) == ".") || (substr($tok, -1) == "?"))) {
   break;
  }
  $tok = strtok(" ");
 }
 return ltrim($text);
}

Using this function you can create an excerpt of any text you want, as long as it has a sentence in it. Take the following section of text.

$string = 'Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Maecenas sollicitudin. Suspendisse potenti. Mauris lorem elit, sodales at, aliquet eu, porta vitae, velit. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Phasellus rhoncus ipsum non urna. Donec et quam. Sed vel lectus in enim porttitor vulputate. Vestibulum at nisi a nulla vulputate mattis. Integer luctus mauris id dolor. In hac habitasse platea dictumst. Aliquam placerat consectetuer ipsum.  Aliquam erat volutpat. Fusce ac nisi a neque laoreet feugiat. Fusce euismod ligula sit amet enim. Sed quis leo. Aenean vel nisi in nunc accumsan accumsan. Nullam egestas orci ut justo. Pellentesque suscipit. Suspendisse pretium fermentum nunc. Mauris ac orci vel nibh facilisis sollicitudin. Pellentesque mattis metus eu mi. Curabitur pharetra ante nec enim. Vestibulum pede.  Maecenas sodales tincidunt erat. Mauris tincidunt. Mauris justo sem, malesuada quis, ultricies non, malesuada nec, lorem. Vivamus laoreet lacus id lorem. Nulla rutrum nisi et urna. Praesent nec turpis ac orci feugiat egestas. Nunc tellus justo, pretium ac, molestie a, luctus a, lacus. Nunc pellentesque iaculis dui. Morbi vel sapien id ligula laoreet euismod. Sed convallis est eu mi. Nam suscipit, eros eu imperdiet malesuada, odio velit iaculis ipsum, eu accumsan ipsum metus id ipsum. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Integer urna. In orci est, semper vitae, adipiscing sed, tempor vel, massa. Sed venenatis, augue eu ornare ullamcorper, nulla enim mollis neque, nec luctus nunc risus non risus. Curabitur mattis arcu mollis magna. Maecenas sagittis metus a dolor. Aliquam accumsan lacinia sem. In hac habitasse platea dictumst.';

This can be passed through the function to get the first 50 words and the rest of the ending sentence like this.

echo excerpt($string, 50);

Produces the following output.

Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Maecenas sollicitudin. Suspendisse potenti. Mauris lorem elit, sodales at, aliquet eu, porta vitae, velit. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Phasellus rhoncus ipsum non urna. Donec et quam. Sed vel lectus in enim porttitor vulputate. Vestibulum at nisi a nulla vulputate mattis.
PHP

Comments

Does this work with UTF-8 (ie multiple byte strings)?

Submitted by aron on Tue, 06/03/2008 - 15:15

Permalink
I can only say maybe. The PHP manual is a bit sketchy on this and states that:
A string is series of characters. Before PHP 6, a character is the same as a byte. That is, there are exactly 256 different characters possible. This also implies that PHP has no native support of Unicode.
So in order to use multiple byte strings you might need to use the PHP utf8_decode() function to convert the string into a usable format before passing it through this function. The opposite function is utf8_encode(). The function hinges around the use of the PHP strtok() function so as long as that receives a string that PHP can understand then it should be fine.
Philip Norton

Submitted by giHlZp8M8D on Tue, 06/03/2008 - 15:28

Permalink
Nice function, thx - saved me some work. But one has to use while($tok !== false) or any single 0 will terminate the function (e.g. "aaa 0 bbb ccc." will always be "aaa").

Submitted by Phil on Wed, 01/21/2009 - 21:01

Permalink
Good point! I have updated the script accordingly.
Philip Norton

Submitted by giHlZp8M8D on Thu, 01/22/2009 - 08:55

Permalink
Also thank you for saving me some work. I used your function to create a helper for CakePHP. I will write an article about it and send you the link.

Submitted by Jon L on Wed, 01/19/2011 - 16:24

Permalink
I just realized CakePHP already has a function for this so I won't be creating one after all.

Submitted by Jon L on Wed, 01/19/2011 - 17:59

Permalink

Add new comment

The content of this field is kept private and will not be shown publicly.
CAPTCHA
3 + 3 =
Solve this simple math problem and enter the result. E.g. for 1+3, enter 4.
This question is for testing whether or not you are a human visitor and to prevent automated spam submissions.

Related Content

Generating Colour Palettes From Images In PHP

4th August 2024

A common web design pattern is to incorporate an image into the design of the page. This creates a tighter integration with the image and the rest of the page.

The main issue in designing a page around the image is that the colours of the page must match the image. Otherwise this creates a dissonance between the image and the styles of the site.

Read more

Validating XML Files With XML Schema Definitions In PHP

21st July 2024

XML is a useful format for configuration, data storage, and transmitting data from one system to another. As a human readable format that can be easily read by machines it quickly gained favor in lots of different systems as a mechanism for data storage.

Read more

Approximating Pi Using A Circle And A Square

26th May 2024

Pi day was a few weeks ago, but I came across this simple approximation of pi recently and decided to put together an example in PHP since it seemed pretty simple.

This approximation of pi centers around a real world example, but we can simulate this using some code.

Read more

Drawing A Parabolic Curve With Straight Lines In PHP

12th May 2024

A parabolic curve is a type of curve where every point is an equal distance from a focal point. There a number of different way to generate this sort of curve using math, but one of the simplest is to use straight lines to create the illusion of the curve.

Read more

Recreating Spotify Wrapped In PHP

17th March 2024

I quite like the end of the year report from Spotify that they call "Wrapped". This is a little application in which they tell you what your favorite artist was and what sort of genres you listened to the most during the year.

Read more