PHPackages                             maadhattah/wppb-mod - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. maadhattah/wppb-mod

AbandonedProject[Framework](/categories/framework)

maadhattah/wppb-mod
===================

A modern WordPress development boilerplate, based on Tom McFarlin's wppb.io

1.0.2(11y ago)4341[2 issues](https://github.com/mAAdhaTTah/wppb-mod/issues)GPL-2.0+PHPPHP &gt;=5.3.0

Since Oct 17Pushed 8y ago2 watchersCompare

[ Source](https://github.com/mAAdhaTTah/wppb-mod)[ Packagist](https://packagist.org/packages/maadhattah/wppb-mod)[ Docs](https://github.com/mAAdhaTTah/wppb-mod)[ RSS](/packages/maadhattah-wppb-mod/feed)WikiDiscussions master Synced 4w ago

READMEChangelogDependencies (1)Versions (4)Used By (0)

DEPRECATED
==========

[](#deprecated)

This project has been deprecated in favor of [jaxion-bootstrap](https://github.com/intraxia/jaxion-bootstrap). That project is still under development but most of the tools/implementations found here will be included. If you have any questions, please email me at .

wppb-mod
========

[](#wppb-mod)

A standardized, organized, object-oriented foundation for building high-quality WordPress Plugins.

Requirements
------------

[](#requirements)

wppb-mod comes with these tool requirements:

1. PHP 5.3+
    - Note: WordPress is compatible back to 5.2, so not all your users will be able to use this plugin yet.
2. [Composer](https://getcomposer.org/), for back-end libraries.
3. [npm](https://www.npmjs.org/), for build tools.
4. [Bower](http://bower.io/), for front-end libraries.
5. [Gulp](http://gulpjs.com/), for project builds

Features
--------

[](#features)

- New plugins can be generated with `composer create-project maadhattah/wppb-mod `.
    - The flattened structure is required for this to work.
- boilerplate is based on the [Plugin API](http://codex.wordpress.org/Plugin_API), [Coding Standards](http://codex.wordpress.org/WordPress_Coding_Standards), and [Documentation Standards](http://make.wordpress.org/core/handbook/inline-documentation-standards/php-documentation-standards/).
- All classes, functions, and variables are documented so that you know what you need to be changed.
- The app is loaded into a singleton so third-party developers can manipulate the hooks.
- The project includes a `.pot` file as a starting point for internationalization.
- The unit tests are scaffolded and ready to go, based on `wp scaffold plugin-tests`, which provides support for [travis-ci](https://getcomposer.org/).

Installation
------------

[](#installation)

The plugin can be developed in your `wp-content` folder directly. Run `gulp` to make the minified and concatenated files and begin the watch process. Whenever the scripts or styles change, gulp will recompile them into their respective css and js files.

When you want to provide a version to distribute, run `gulp build` and distribute the resulting .zip file.

Recommended Tools
-----------------

[](#recommended-tools)

### i18n Tools

[](#i18n-tools)

The WordPress Plugin Boilerplate uses a variable to store the text domain used when internationalizing strings throughout the Boilerplate. To take advantage of this method, there are tools that are recommended for providing correct, translatable files:

- [Poedit](http://www.poedit.net/)
- [makepot](http://i18n.svn.wordpress.org/tools/trunk/)
- [i18n](https://github.com/grappler/i18n)

Any of the above tools should provide you with the proper tooling to internationalize the plugin.

License
-------

[](#license)

The WordPress Plugin Boilerplate is licensed under the GPL v2 or later.

> This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2, as published by the Free Software Foundation.

> This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

> You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

A copy of the license is included in the root of the directory. The file is named `LICENSE`.

Important Notes
---------------

[](#important-notes)

### Licensing

[](#licensing)

The WordPress Plugin Boilerplate is licensed under the GPL v2 or later; however, if you opt to use third-party code that is not compatible with v2, then you may need to switch to using code that is GPL v3 compatible.

For reference, [here's a discussion](http://make.wordpress.org/themes/2013/03/04/licensing-note-apache-and-gpl/) that covers the Apache 2.0 License used by [Bootstrap](http://twitter.github.io/bootstrap/).

### Includes

[](#includes)

Note that if you include third-party libraries, use either `bower install --save-dev`, for front end libraries, or `composer require`, for php libraries.

Note that previous versions of the Boilerplate did not include `Loader` but this class is used to register all filters and actions with WordPress.

The example code provided shows how to register your hooks with the Loader class. More information will be provided in the upcoming documentation on the website.

### Assets

[](#assets)

The `assets` directory contains three files.

1. `banner-772x250.png` is used to represent the plugin’s header image.
2. `icon-256x256.png` is a used to represent the plugin’s icon image (which is new as of WordPress 4.0).
3. `screenshot-1.png` is used to represent a single screenshot of the plugin that corresponds to the “Screenshots” heading in your plugin `README.txt`.

The WordPress Plugin Repository directory structure contains three directories:

1. `assets`
2. `branches`
3. `trunk`

The Boilerplate offers support for `assets` and `trunk` as `branches` is something that isn’t often used and, when it is, is done so under advanced circumstances.

When committing code to the WordPress Plugin Repository, all of the banner, icon, and screenshot should be placed in the `assets` directory of the Repository, and the core code should be placed in the `trunk` directory.

Credits
=======

[](#credits)

The WordPress Plugin Boilerplate was started in 2011 by [Tom McFarlin](http://twitter.com/tommcfarlin/) and his since included a number of great contributions.

The current version of the Boilerplate was developed in conjunction with [Josh Eaton](https://twitter.com/jjeaton), [Ulrich Pogson](https://twitter.com/grapplerulrich), and [Brad Vincent](https://twitter.com/themergency). This fork is developed and maintained by [James DiGioia](http://jamesdigioia.com/).

The homepage is based on a design as provided by [HTML5Up](http://html5up.net), the Boilerplate logo was designed by Rob McCaskill of [BungaWeb](http://bungaweb.com), and the site `favicon` was created by [Mickey Kay](https://twitter.com/McGuive7).

###  Health Score

27

—

LowBetter than 49% of packages

Maintenance10

Infrequent updates — may be unmaintained

Popularity12

Limited adoption so far

Community22

Small or concentrated contributor base

Maturity60

Established project with proven stability

 Bus Factor1

Top contributor holds 75.5% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~70 days

Total

3

Last Release

4081d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/d02a4e24f81bb9cba462d90227c43a6f84518694f8db18180f977640f16c99da?d=identicon)[maadhattah](/maintainers/maadhattah)

---

Top Contributors

[![tommcfarlin](https://avatars.githubusercontent.com/u/132166?v=4)](https://github.com/tommcfarlin "tommcfarlin (360 commits)")[![mAAdhaTTah](https://avatars.githubusercontent.com/u/4371429?v=4)](https://github.com/mAAdhaTTah "mAAdhaTTah (41 commits)")[![grappler](https://avatars.githubusercontent.com/u/1785641?v=4)](https://github.com/grappler "grappler (23 commits)")[![barryceelen](https://avatars.githubusercontent.com/u/4179791?v=4)](https://github.com/barryceelen "barryceelen (9 commits)")[![bluehiveinteractive](https://avatars.githubusercontent.com/u/2881651?v=4)](https://github.com/bluehiveinteractive "bluehiveinteractive (6 commits)")[![GeertDD](https://avatars.githubusercontent.com/u/38326?v=4)](https://github.com/GeertDD "GeertDD (4 commits)")[![anabelle](https://avatars.githubusercontent.com/u/445690?v=4)](https://github.com/anabelle "anabelle (3 commits)")[![emeraldjava](https://avatars.githubusercontent.com/u/229760?v=4)](https://github.com/emeraldjava "emeraldjava (3 commits)")[![rob](https://avatars.githubusercontent.com/u/503?v=4)](https://github.com/rob "rob (2 commits)")[![Japh](https://avatars.githubusercontent.com/u/237905?v=4)](https://github.com/Japh "Japh (2 commits)")[![thuijssoon](https://avatars.githubusercontent.com/u/4426512?v=4)](https://github.com/thuijssoon "thuijssoon (2 commits)")[![akshayraje](https://avatars.githubusercontent.com/u/5327602?v=4)](https://github.com/akshayraje "akshayraje (2 commits)")[![michaelbeil](https://avatars.githubusercontent.com/u/4752949?v=4)](https://github.com/michaelbeil "michaelbeil (2 commits)")[![dmtrmrv](https://avatars.githubusercontent.com/u/5512633?v=4)](https://github.com/dmtrmrv "dmtrmrv (2 commits)")[![Tintazul](https://avatars.githubusercontent.com/u/6369451?v=4)](https://github.com/Tintazul "Tintazul (1 commits)")[![afragen](https://avatars.githubusercontent.com/u/1296790?v=4)](https://github.com/afragen "afragen (1 commits)")[![tylerdigital](https://avatars.githubusercontent.com/u/232096?v=4)](https://github.com/tylerdigital "tylerdigital (1 commits)")[![andrejcremoznik](https://avatars.githubusercontent.com/u/761287?v=4)](https://github.com/andrejcremoznik "andrejcremoznik (1 commits)")[![bradp](https://avatars.githubusercontent.com/u/66798?v=4)](https://github.com/bradp "bradp (1 commits)")[![cudazi](https://avatars.githubusercontent.com/u/996941?v=4)](https://github.com/cudazi "cudazi (1 commits)")

---

Tags

pluginwordpressboilerplate

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/maadhattah-wppb-mod/health.svg)

```
[![Health](https://phpackages.com/badges/maadhattah-wppb-mod/health.svg)](https://phpackages.com/packages/maadhattah-wppb-mod)
```

###  Alternatives

[wordpress-phoenix/abstract-plugin-base

PHP class to extend when building a WordPress plugin allowing you to follow smart plugin setup standards.

1013.0k1](/packages/wordpress-phoenix-abstract-plugin-base)[justcoded/wordpress-theme-framework

Lightweight theme framework base with Model-View concept for developers who want to better organize their own custom themes.

264.1k2](/packages/justcoded-wordpress-theme-framework)[alleyinteractive/pest-plugin-wordpress

WordPress Pest Integration

263.7k1](/packages/alleyinteractive-pest-plugin-wordpress)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
