Skip to main content

How to create a simple Wordpress plugin

Last year, I was working on some projects related to bloging platforms such as Wordpress, and I became really passionate about Wordpress during that time. Wordpress has become a very popular CMS, although originally it came as a blog publishing platform. One of the main reasons for this popularity may be it's powerful plugin architecture. So, I thought it's better to write a simple tutorial about how to create a simple plugin for Wordpress.

In this tutorial, I am giving the main priority for the simplicity since I need to show how easy to create a plugin for Wordpress. I highly recommend to improve the structure of code if you are going to use this for a complex project.

This simple plugin will show, the head lines of the latest posts in the bottom of each single post page, so that users will be able to navigate to the latest articles without moving back to the home page.

To check out the source code for this example : https://github.com/nadeeth/wp_latest_posts/tree/simple

Step 1. Create the main plugin file

Create a directory (ex: wp_latest_posts) and create a php file as the main plugin file (ex: wp_latest_posts.php) and add the following header information in the top.

/*
Plugin Name: LatestPosts
Plugin URI: http://plugin.example.com
Description: Show the latest posts bottom of each single post page
Version: beta 1.0
Author: Author L.
Author URI: http://example.com
License: GPL2
*/ 
 
This is the standard plugin information which lets Wordpress identify your plugin.

Step 2. The function to get latest posts

Add the function given below to the file created in the step 1 after the header information. On execution, it will return a brief list of last five posts ordered descending by post date so that the latest one to be in the top. I guess the code is self explanatory.

function get_latest_posts_list() {

    $args = array(
        'posts_per_page' => 5,
        'numberposts' => 5,
        'offset' => 0,
        'category' => '',
        'orderby' => 'post_date',
        'order' => 'DESC',
        'include' => '',
        'exclude' => '',
        'meta_key' => '',
        'meta_value' => '',
        'post_type' => 'post',
        'post_mime_type' => '',
        'post_parent' => '',
        'post_status' => 'publish',
        'suppress_filters' => true );

        $posts = get_posts( $args );

    if (empty($posts) || count($posts)<1) return;

    $html = "<ul>";
    foreach ($posts as $post) {

    $html .= "<li><a href='".$post->guid."'>".
        strip_tags($post->post_title).
        "</a> - ".strip_tags(substr($post->post_content, 0, 150)).
        "...</li>";
    }
    $html .= "</ul>";

    $container = "<div><h2>Latest Posts... </h2>{$html}</div>";

    return $container;
} 

Step 3. Create the filter function

Wordpress uses filter functions to pass data through. So, here we can use a filter function to add the list retuned by the function in step 2 to the bottom of each post. Add this function too to the main file after the function created in the step 2.

function show_latest_posts($content){

    if(is_single()){
        return $content . get_latest_posts_list();
    } else{
        //if `the_content` belongs to a page no change to `the_content`
        return $content;
    }
} 

Next, this filter function should be added to the hook. Add the line given below to the main file after the filter function.

add_filter('the_content', 'show_latest_posts');

Now, our simple plugin is ready to install and test.  

Step 4: Installation

Please follow the instructions given below to install the plugin.

  • Upload the 'wp_latest_posts' folder (created in the step one which contains the plugin main file) to the `/wp-content/plugins/` directory
  • Activate the plugin through the 'Plugins' menu in WordPress
OR
  • Compress 'wp_latest_posts' folder as a zip file. (wp_latest_posts.zip)
  • Login as wp admin.
  • Go to "Plugins --> Add New"
  • Click Upload
  • Brows and select the file(wp_latest_posts.zip), click "Install Now" button.
  • Activate the plugin

Now open a post in your blog (you should have at least 2 posts in your blog) and check the bottom of the page between the post and comments areas.

Above code was tested in WordPress 3.3.1.



[Refrences]

Comments

Anonymous said…
Need more posts like this :-)

Popular posts from this blog

Common Characteristics of Enterprise Applications

Last week, I was conducting a tech talk about “Architectural Patterns of Enterprise Applications” with our team. The discussion was mainly based on Marin Fowler's famous book “Patterns of Enterprise Application Architecture”. So, I thought, it's good to write something about that in my Blog. Given below are few common characteristics of Enterprise Applications. If any software product has the following characteristics, we can identify it as an Enterprise Application. These ware originally documented by “Martin Fowler”, in his book “Patterns of Enterprise Application Architecture”. Persistent Data - Enterprise applications usually involve persistent data. The data is persistent because it needs to be around between multiple runs of the program—indeed, it usually needs to persist for several years. Also during this time there will be many changes in the programs that use it. Lot of Data - There's usually a lot of data, a moderate system will have over 1 GB of data organ

How to avoid those little issues one can get when creating new projects with Zend Framwork...

CSS styles my not apply to the templates : Some times this happens when you haven't created a virtual host for the application. After the virtual host is created styles will apply properly, or just use some url helper like "baseUrl" when linking the style sheets to the templates. Error messages when using the commands like "zf enable layout", "zf create db-table ....", "zf create model ...", "zf configure db-adapter", and "zf create action ...." etc... You may get error like "Action 'enable' is not a valid action", "Action 'configure' is not a valid action"......... etc... Reason for this may be, the Zend library is not in the include path. If so add the library path to the include path. Or check whether there are old libraries in any directories of include paths that conflicts with the new one. Check whether there is a one as a PEAR package. And check whether the "zf" c

How to create a waveform animation with HTML and JavaScript

Recently, for a pet project, I wanted to create an animation of a waveform based on the varying decibel level of the microphone input. I was thinking about a really simple way to accomplish this with SVG and JavaScript. Given below is the first sample code I did on the Codepen. You can change this code to use with any framework of your choice. For this sample code, I am using a random number as the microphone input. You can replace it with any other time based input. Code Pen : https://codepen.io/nadeeth/pen/vmaYXw For this example, you need an HTML code snippet like the one given below. It’s just an SVG with a Polyline element inside.  <div style="text-align:center">   <svg height="150" width="400" id='svg'>     <polyline id="polyline-id" fill="none" stroke="#005c66" stroke-width="1" />   </svg> </div> And then the plain Javascript code to animate the polyline. You can