I’ve developed a few WordPress plugins and I love to hack WordPress, so there are times when I need to write and test PHP within the WordPress framework. Because my plugins are site-wide sidebar widgets, any errors I may introduce while testing have the potential to affect every page on my site.

Instead of testing my widgets live, I test the underlying PHP in a designated test area that his hidden from regular readers. That way, if PHP barks at me for missing an underscore, it’s more of a private message to me, and not a public broadcast to all of my readers.

Creating a WordPress test area is a simple addition of a page template and test page to your WordPress theme files. Any PHP that you put in the test template can be executed by refreshing a draft preview of the page assigned to it. Because the test page is never actually published, there’s no possibility of it reaching your readers and interrupting the flow of your site.

Want to set up your own WordPress PHP test area?

Using A WordPress Page Template As A PHP Test Area

1. Put the following into a text file and save it as phptest.php:

   <?php
   /*
   Template Name: PHP Test Template
   */
   ?>
   
   <?php get_header(); ?>
   
   <div id="content" class="narrowcolumn">
   <h2>This is a test File</h2>
   
   <?php
   //PHP test area
   ?>
   </div>
   
   <?php get_sidebar(); ?>
   
   <?php get_footer(); ?>

2. Upload the file into your current theme. These are typically located in /wp-content /themes/ [theme-name]/ under your WordPress installation directory.
3. Go into your WordPress admin panel and click Editor from the Appearance menu on the left. Make sure that you can see the PHP Test Template listed on the in the template list on the right hand side. If it’s not there, you might’ve uploaded the file to the wrong theme directory.
4. From the Pages menu in the left side column of your WordPress admin panel, click Add New.
5. Title the page something like “PHP Test Page” and leave the post area blank.
6. On the right hand side, under Attributes / Template, Select PHP Test Template from the drop down menu.
7. Click Save Draft.
8. Click Preview.
9. Now go back to the PHP Test template in your theme by clicking Editor from the Appearance menu on the left side of the admin panel.
10. From the list on the right, click PHP Test Template.
11. Add your PHP code to the line of the test template that reads //PHP test area.
12. When you’re done, click Update File.
13. When you refresh the preview of your draft PHP test page (that you opened in step 8), any PHP that you put in the template will execute.

Once you’re satisfied that the PHP has been tested, it can be moved out of the test template and into a production template or widget with the confidence that it’s going to behave within the WordPress framework. You can clear your test template and leave the test page dormant until your next idea comes along.

Posted in Blogging, Geeky