Use your left/right keys to browse tutorials
Caching Dynamic PHP pages easily

Caching Dynamic PHP pages easily

1 Star2 Stars3 Stars4 Stars5 Stars
Posted on February 17, 2009

I’ve been looking for a solution to cache heavy pages and just serve a static html version for a little while now, and I’ve found a solution in output buffering.

Things to think about

It’s not a good idea to go away and cache your entire site, you need to think about which pages receive high traffic, and which pages make a number of database requests. Static HTML pages aren’t going to see a benefit from caching and may in fact be served slower due to PHP invoking the request to the cached version. as an example I’m using caching on dotdashcreate.com homepage as there are a number of database requests that could easily be cached, the cached version of the page is stored here.

If you run a big site or blog I would certainly recommend caching your homepage as this will usually be your visitors first point of contact thus generating more traffic. Its probably not a good idea to cache individual posts that allow comments etc, unless you are willing to write a script to re-cache the page.

You need to allow write access to the cache directory, in the code example this is /cache/. There’s quite a bit going on in the script, the first two lines set the path to the cached directory and the time frame to refresh the cache, we then do a check to see if the cached file is older than the cache time, if it is then it refreshes the cached version (which is the block of code at the bottom), if not it just serves the cached version.

The Code:


$cachefile = 'cache.html';
$cachetime = 4 * 60;
// Serve from the cache if it is younger than $cachetime
if (file_exists($cachefile) && time() - $cachetime < filemtime($cachefile)) {
    include($cachefile);
    echo "<!-- Cached copy, generated ".date('H:i', filemtime($cachefile))." -->\n";
    exit;
}
ob_start(); // Start the output buffer

/* Heres where you put your page content */

// Cache the contents to a file
$cached = fopen($cacheFile, 'w');
fwrite($cached, ob_get_contents());
fclose($cached);
ob_end_flush(); // Send the output to the browser

demo



Recent shares

More tutorials from Papermashup
Comments
59 discussions around Caching Dynamic PHP pages easily
  1. I have read so many articles or reviews concerning the blogger lovers except this article is in fact a
    good paragraph, keep it up.

  2. Fatriff says:

    Recently I started a new project where the best solution would be to generate static pages using this method because everything on the site is dynamic so having constantly changing text and things would hurt the site in seo.. So i’m glad I found this again!

  3. jackie says:

    I love you so

  4. Pingback: Useful Components of PHP , Techniques and Tutorials | Rapidesigners

  5. Pingback: Highly Useful Tools and Techniques for PHP Developers | Techno Tab

  6. Very great post. I just stumbled upon your weblog and wanted to mention that I’ve really loved browsing your blog posts. In any case I’ll be subscribing for your feed and I’m hoping you write again very soon!

  7. Pingback: 10 Useful Techniques and Tutorials for PHP Programmers | ZoomZum

  8. , provides effective Jacksonville toenail fungus choose to members
    with the community using technologically advanced methods
    that include laser care. Even after successful treatment, the fungus may return.
    Apart from these natural treatments one must also take certain precautions in keeping chlamydia away.

  9. Pingback: 简化 PHP 开发的10个工具 | 博海时空

  10. Bob Cavezza says:

    FYI the variables are not consistent in the code above. $cacheFile should be named $cachefile on this line:

    Incorrect:
    $cached = fopen($cacheFile, ‘w’);

    Correct: $cached = fopen($cacheFile, ‘w’);
    $cached = fopen($cachefile, ‘w’);

    Cheers!

  11. Pingback: 简化PHP开发的11个工具 - 博客 - 伯乐在线

  12. goals mad says:

    excellent post I’m a huge football fan looking forward for the 2012-2013 season

  13. Pingback: Sell code BenTreWap bản Mới - Trang 10

  14. Carlos says:

    OK – I just discovered unlink() :)

    thanks again for posting this

  15. Carlos says:

    thanks for this very clean solution !!

    I am also wondering if there is a way that an admin could flush the cache from another page for content editing purposes

  16. Nice article, very well written.

  17. Dan says:

    I have just set this up, and it works well. For those who run expensive sql queries the same approach can be applied for some very big improvements.

    Dan

  18. Interesting post. I also use the WordPress Caching plugin for my blog. It works great. On other large ecommerce sites, I’ve often rolled my own caching backend. As an admin user changes a product, adds a new category – the caching program would kick in and rerip new static HTML / PHP pages from the dynamic PHP code I had created. One trick to pull this off is to call your dynamic PHP front-end scripts like a real user using file_get_contents. Then, store that data into a new file for customers to hit. It requires a bit of hacking to get the caching program built, but once it’s in place, you can regenerate the cached version of your site with a click.

  19. xenang says:

    oh.It seems very simple! thanks for sharing

  20. Onore says:

    Very simplify and works tutorial, Thanks.

  21. its work-) great php tutorilas to beginers,,,thank you

  22. csr says:

    very simple caching….

  23. Great solution.. Cache-ing is difficult. If users are seeing old content, they are gone.. GJ.

  24. Delta says:

    Hi,
    I have Any Login Form In Index Page ! Now After Login Your Code Re Generate Cache?
    How To Best Chaching Page For Any Index Page With Login Form ?

    Thanks

  25. Diego says:

    Man that’s a very good solution, and simple! Tanks for sharing!

  26. Hey Sven good work with the guide man.

  27. It’s a pity you don’t have a donate button! I’d most certainly donate to this outstanding blog! I guess for now i’ll settle for book-marking and adding your RSS feed to my Google account. I look forward to fresh updates and will share this site with my Facebook group. Chat soon!

  28. Sven says:

    I wrote I little guide where I store cache files using php and read them using apache and c++. The performance gain is really great. Read more about it:
    http://sven.webiny.com/advanced-cache-mechanism-using-php-cpp-and-apache/

  29. useful. thank you for article.

  30. Pingback: Useful PHP Components & Tutorials for Everyday Project « UR-Technology

  31. CodesTips says:

    Caching is very usefull on website with big databases. I wrote a post about cache on my blog:cache file in php

  32. Pingback: links for 2009-11-09 | Yostivanich

  33. Daniel says:

    Thanks…

    Just installed the code, works really well ! !

    Nice and easy is how I like it…

  34. Pingback: 25 New & Useful PHP Techniques & Tutorials

  35. Davinder says:

    Hello.
    I love this tutorial but there is a problem
    Why not use PHP strip slashes e.g. if i type in (with out the spaces) i could easily cross refrence……. your site

  36. Tommy M says:

    @Marc, @Steve, @ Ashley.

    filectime is more accurate, so I implemented that with Marc’s advice.

    Additionally, Steve is correct to use readfile. It ran considerably faster!

    Thanks for this great technique!

  37. Pingback: 40+ Invaluable PHP Tutorials and Resources | rapid-DEV.net

  38. Marc says:

    Idea is good, but filemtime is innacurate to give the last time the file was modified for that case. If you try it you will see.. you can modify the file and unix will tell php that the file was modified on the date it was created. Use filectime to get the last time the inode of the file was changed, since you overwrite the file each X seconds, the inode meta data will change, giving you valid informations about the file.

  39. Steve Clay says:

    You might as well send HTTP cache headers as well: header(‘Cache-Control: public, max-age=’ . $cacheTime);

    Also, you might get a slight perf boost using readfile() over include, since the cache file will have no PHP blocks.

    • Ashley says:

      @steve good point with the cache header, never used readfile() will have to look into that. Thanks for the feedback :)

  40. Pingback: 40+ Invaluable PHP Tutorials and Resources | Ouech.net

  41. Pingback: Angels Picks » Blog Archive » 20 Useful PHP Components & Tutorials for Everyday Project

  42. Pingback: Dynamic page caching with PHP and output buffering | Spoonfed Project

  43. Pingback: Easy PHP Caching: Speed-Up Dynamic Content

  44. Pingback: 20 Useful PHP Components & Tutorials for Everyday Project « Hdeya team blog

  45. jebaird says:

    First off I have gota say that this caching idea kicks ass.
    I have created a class based on the original code and user comments code. Also i fixed a couple of bugs:

    here is the link:
    http://www.jebaird.com/blog.php?year=2009&month=03&cat=3&id=32

  46. Used it, in my “freshly” created cms. Works like a charm!

  47. AzeriFire says:

    Thank you admin :)
    There are some new correction too:
    Replace this one:

    if (isset($_SERVER['REQUEST_URI'])) // Is there any URI to cache
    

    with this one:

    if (isset($_SERVER['REQUEST_URI']) && $_SERVER['REQUEST_URI']!="/") 

    to escape problems when site URL ends with slash (http://site.com/)

    Latest version is here:
    http://paste.org/5666

    P.S. Sorry for spam

  48. AzeriFire says:

    Hi. Thank you for this little, but powerful code. I use SEF URL on my sites. There are problem with “/” (slash). If site URI ll be for sample – /nokia/n97/comments/page/1.html this cache script will look for cache folder, then nokia folder, then inside of nokia folder for n97 subfolder and etc… There are will be PHP errors on site (Not found page and etc.). I improved it little more.And use global variable to define is the caching this page indeed. For sample, I don’t need caching login page and etc. I use $useCache variable ($useCache=0 to disable, =1 to enable caching currently viewing page.)
    And finally improved script:
    http://paste.org/5665
    OR
    http://www.pastethat.com/use_cache_with_p

    Thanks again!
    P.S. Sorry for my poor English.

    • admin says:

      AzeriFire,

      Thanks for the comments and code update! Glad to hear you found it useful and adapted the code in your own way.

      Ashley

  49. Andrew Gill says:

    Great article. My homepage (index.php) is also calling the database many times. So i’ve used your approach slightly differently by creating an index.html page in the root so there is no need for the include.

  50. Traducciones says:

    nice post! i will use it

  51. Pingback: Wordpress Blog Services - 20 Useful PHP Components &amp; Tutorials for Everyday Project

  52. Pingback: 20 Useful PHP Components & Tutorials for Everyday Project | Noupe

  53. Pingback: Daily Links | AndySowards.com :: Professional Web Design, Development, Programming, Hacks, Downloads, Math and being a Web 2.0 Hipster?

  54. Patternhead says:

    If you’re using using WordPress then the wp-supercache plugin works pretty well!

  55. Ashley says:

    That’s a great point, I should have mentioned that in my post! I’m currently using the wp-supercache plugin, well worth installing if you anticipate spikes in blog traffic.

Leave a Reply

Your email address will not be published. Required fields are marked *

You may use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>



Never miss an update from Papermashup

Get notified about the latest tutorials and downloads.

Subscribe by Email

Get alerts directly into your inbox after each post and stay updated.
Subscribe
OR

Subscribe by RSS

Add our RSS to your feedreader to get regular updates from us.
Subscribe

Get in contact

Please use the form below to get in contact. If your question is related to a free script download, please use the comments on the article page as community members are more likely to respond quicker than I can personally.

About Me

I'm Ashley Ford, Co-founder and Technical Director at Harkable.com London, UK. Previously I worked at InMobi, Spotify and MySpace. My interests include photography and making short videos I'm also an avid F1 fan. I'm always working on side projects. Here are a few: Easy Poll, We Deliver.



What do you specialise in?

I spend a lot of time coding in PHP and MySQL, as well as front end XHTML and CSS. I also specialise in javascript and the jQuery framework as well as being an avid designer. You can find me on dribbble

Interested in advertising?

If you'd like to advertise on Papermashup.com please get in touch via the contact link below for advertising opportunities.

How do I contact you

You can contact me here. and I'm available for consultation, freelance, programming book reviews.

Get on the mailing list

Join over 3000 people who have subscribed to the Papermashup inbox message, and be the first to find out about tutorial, competitions and giveaways.