Peter Upfold DevDocs

Developer documentation for Peter Upfold’s projects

User Tools

Site Tools

Documentation Archived

This documentation is archived and is no longer actively maintained.


WPGet Installation Guide

There are two ways to install WPGet:

  1. Using the installer
  2. Manually

Using the Installer

The WPGet Installer is an online copy of the wpgcfg.php script that is part of WPGet.

Simply browse to that page, and follow the instructions.

Step 1

The first step is to give the installer your database details for WordPress and to set whether you want WPGet to email you if something goes wrong and the page can't be displayed. Set these options and click Next.

Click the Download Ready-to-Run Script button, and save the resulting file to your computer. This is a customised version of WPGet, with your database configuration already done for you.

Copy this wpget.php file onto your web server, in the same directory as the page where you want to include the summary of blog posts.

Click Next back in the Installer to move on to Step 2.

Step 2

Here, you set a few options. Leave the first box as it is, and fill in the number of posts you want to show, the length of the extracts and pick a format to show the post's date and time in.

In the next section of the page, choose which content you want to appear in the extracts (for example, you might want to turn off images.

If you want to use the Advanced Features, such as retrieving posts only from certain categories or tags or just to show a single, static post, then choose the tickbox and fill in the required information.

Click Next, and you'll be given a code snippet.

Copy and paste this code into the page where you want the posts to appear. So if you have a site where you have index.php and a sidebar on that page, paste the code snippet in the sidebar inside index.php.

And you're done! Your web page should now show you the posts you want!

Manual Installation

To install WPGet manually, first download the code and extract it somewhere. You don't need wpgcfg.php, this is just a local copy of the installer (above) that you can use if you prefer.

Open wpget.php and set the database information at the top of the file to your information for WordPress, and also choose the email address to send error reports to (or false for none).

Save that file.

Now go into the page where you want the posts to appear. You need to now create a wpGet object, set your options, and instruct it to pull out the posts.

$wpget = new wpGet;
$wpget->dateformat = "d/m/Y H:i";
$wpget->showcredit = true;
$wpget->getWordpressEntries(5, 200, false, false, false);

Details on how to set advanced options can be found either by using the WPGet Installer's Step 2 to generate the code for you, or by looking at the comments at the top of wpget.php.

wpget/installation.txt · Last modified: 2011-12-03 10:28:55 (external edit)