WordPress Plugin Boilerplate

Information, updates, and other posts related to my WordPress Plugin Boilerplate that serves to provide a solid foundation for building WordPress plugins.

Decisions on Documentation for the WordPress Plugin Boilerplate

When I first launched the landing page for the WordPress Plugin Boilerplate last year, the main idea was to grow a site around the single landing page that offered code examples, how to’s, and other forms of documentation.

The WordPress Plugin Boilerplate Homepage

The WordPress Plugin Boilerplate Homepage

But I’ve spent the last month working on some special material for the Boilerplate (that I’ll talk about in an upcoming post) which got me thinking more about what I wanted to offer in terms of documentation for the project.

And I’ve changed my mind.

A WordPress Plugin Boilerplate Generator

Since the release of the latest version of the WordPress Plugin Boilerplate, the top two things that people have requested are documentation complete with examples, and a generator to ease the pain of having to replace certain tokens throughout the boilerplate’s codebase.

And I’m all for it – I’ve even committed to begin providing this material in early 2015 (and not just via the project’s website, but a few other channels, as well – more on that later). The awesome thing about open source is the contributions that can come from other people.

Sometimes these come in the form of patches or pull requests, other times they come in the form of extensions, enhancements, and other types of projects that help improve the initial project.

It’s awesome, isn’t it?

Documenting The WordPress Plugin Boilerplate

A little over a month ago, I released the latest version of the WordPress Plugin Boilerplate. The response has been great – more than I was expecting, really but that’s a good thing – and, generally speaking, it’s been overall positive.

The WordPress Plugin Boilerplate Homepage

The WordPress Plugin Boilerplate Homepage

Over the last month or so, it’s become clear that more time and resources will be needed to focus on the Boilerplate and to continue to refine its codebase, its functionality, its documentation, and so on. The bottom line is that I want to make sure that I get the right – or as close to right – as possible during the first try.

To that end, I need some input from others (read: you).

The WordPress Plugin Boilerplate 3.0.0

A few years ago, I started the WordPress Plugin Boilerplate project as nothing more than a GitHub repository used to store code that I found myself frequently using in both personal and client projects.

As I became more involved with WordPress, as I began to build more plugins for fun and profit, and as I began updating the repository, it grew into something a little more than I had expected.

Over time, people began to open issues, offer pull requests, perform code reviews, and create their own forks of the project. I learned a lot over the next few years, and I honestly couldn’t be more excited to see such a little project become, you know, such a slightly less little project.

Months ago, I mentioned that work on the next iteration of the WordPress Plugin Boilerplate was started and I’m excited to announce that, as of today, the WordPress Plugin Boilerplate 3.0.0 is officially ready for use.

And it comes with a lot of new and neat things to boot.

WordPress Plugin Boilerplate: Testing 1, 2, 3

In 2011, I released the first version of the WordPress Plugin Boilerplate and have been maintaining it (along with contributions from other programmers) ever since.

Over the last couple of years, the Boilerplate became quite active – as far as very small projects are concerned – with issues, pull requests, and so on. It’s been a lot of fun to maintain, and it’s been really neat to receive so much feedback from other developers in terms of making the Boilerplate more resilient and from those who were just getting started with plugin development.

Earlier this year, I shared that I – along with a small group of other people – began working on the next iteration of the WordPress Plugin Boilerplate. That is, we were initiating a complete rewrite of the project.

As of today, I’m officially launching a beta of sorts of 3.0.0 of the Boilerplate. This is a major rewrite and refactoring of the Boilerplate in the state that its had for the past few years, and there’s a lot of change coming not only to the Boilerplate itself, but to new site, documentation, forks, and so on.

Educate Your Users in Open Source Software

One of the things that I’m working hard to have released by the end of the month is the latest version of the WordPress Plugin Boilerplate.

The latest version has been in development for quite a while now (a lot has happened offline so, you know, that’s how it goes).

The last time that I really spent any time talking about this project was in November 2013. A lot has changed since then. Initially, I was planning on a minor upgrade with some of the following features:

  • Releasing the version has part of the 2.x.x versioning
  • Including a class specifically for administrative functionality
  • Fixing issues with symbolic links and textdomains
  • Including more TODO’s for users to find what needs to be changed
  • …and so on.

But when I got started on the next version of the Boilerplate, a lot of things changed. The short of it is that it’s being completely re-written from the ground up and the code and documentation are being split into to separate things for the sake of user education.

I’ll spend more time talking about the Boilerplate in a future, but one of the things that I wanted to share that’s related to running a project like the Boilerplate has to do with open source, contributions, lack of a vision, and how this can negatively impact your project and your users.

The Logo for the WordPress Plugin Boilerplate

As discussed earlier last month, the next version of the WordPress Plugin Boilerplate is currently in development.

For those who are interested:

  • You can find the current stable version on GitHub.
  • The develop branch to which the core team and I are working (though we’re not currently accepting pull requests).
  • And you can read about the changes in the upcoming version in this previous post.

The foundation of the status of the next version of the Boilerplate currently leaves a lot to be desired, but the team and I – along with the help of Slack (probably a topic for another post ) – are in the process of planning the upcoming website that will accompany the project.

Slack - WordPress Plugin Boilerplate

The problem? We’re all developers, but we need a logo.

How We’re Planning The Next Iteration of the WordPress Plugin Boilerplate

Months ago, I announced that there was going to be a major update to the WordPress Plugin Boilerplate.

Because of its nature in being a hobby project, because this project is something that’s being worked on by a number of contributors, and because the next iteration is going to be a major rewrite of what we have so far, it’s taking a while to begin pushing code for the new Boilerplate.

But there are a lot of neat things coming, and I think that even if it’s taking us a while to get something on GitHub, it’s worth providing updates as to where we currently stand with the project.

The Latest Branch of the WordPress Plugin Boilerplate

Just shy of a month ago, I shared some information about the state of the WordPress Plugin Boilerplate.

Specifically, I mentioned the following:

  • We’re working on rewriting it to be cleaner, easier to understand, and more flexible for developers of all experience.
  • I’ve got a small, core team of volunteers helping me out (who I greatly appreciate).
  • Where we’re headed with this latest version of the project.

To be honest, I’ve never been more excited about the project.

There’s a lot more coming down the pipeline that I’ll cover later in this post – I also want to clear up some fun versioning quirks that I’ve been asked about – but I wanted to give a heads up on the current state of the codebase and where you can follow along with the development as we begin to push code.

The State of the WordPress Plugin Boilerplate

One of the projects that I love working on the most is the WordPress Plugin Boilerplate.

I dig it because it’s been a resource that has helped other people, and there are a number of other contributors that are constantly working to make it even better.

Earlier this year, I had plans to begin releasing more frequent updates, but – as with the nature of employment and side projects that are done for free – the updates didn’t happen as fast as I would like.

Additionally, it was becoming clear to me that the Boilerplate was headed in a direction that was going to be more intimidating for beginners, harder to grasp for those migrating their plugins to that format, and that it was not using some of the best principles in place.

So after talking with a number of notable developers, I’ve opted to delay the release of 2.7.0 until we have something significantly better than what’s in place.

In fact, it’s going to be a near total rewrite.