WordPress-Widget-Boilerplate - GitLite

KO | EN

gitlite — search

#javascript #llm #golang #android #machine-learning #rust #linux #nodejs #macos #cli #kubernetes #vue #mcp #ios

WordPress-Widget-Boilerplate

(★ 997)

[WordPress] The WordPress Widget Boilerplate is an organized, maintainable boilerplate for building widgets using WordPress best practices.

File Explorer

Download Latest Version (.zip)

- - admin.css
  - widget.css
- - admin.js
  - widget.js
- plugin.po
- - AbstractSubscriber.php
  - AdminScriptAssetSubscriber.php
  - AdminStyleAssetSubscriber.php
  - DeleteWidgetCacheSubscriber.php
  - PublicScriptAssetSubscriber.php
  - PublicStyleAssetSubscriber.php
  - WidgetSubscriber.php
- - Registry.php
- - Widget.php
  - WidgetAdmin.php
  - WidgetDisplay.php
  - WidgetSerializer.php
- Plugin.php
.gitignore
.php_cs.cache
.php_cs.dist
CHANGELOG.md
composer.json
grumphp.yml
LICENSE
phpcs.xml
phpmd.xml
README.md
wordpress-widget-plugin.php

# Installation Guide

1. Get the code

git clone https://github.com/tommcfarlin/WordPress-Widget-Boilerplate

Downloads the entire project code from GitHub to your computer.

cd WordPress-Widget-Boilerplate

Moves into the project folder you just downloaded.

2. PHP (Composer)

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
PHP A PHP runtime is required.
Composer The package manager used to install PHP libraries.

composer install

Installs the PHP libraries listed in composer.json.

✅ Run it with a built-in server like php -S localhost:8000, then open http://localhost:8000 in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# WordPress Widget Boilerplate

The WordPress Widget Boilerplate serves as a foundation off of which to build your WordPress widgets using modern tools such as [Composer](https://getcomposer.org/) and an object-oriented approach all of which is documented in [this series of posts](https://tommcfarlin.com/tag/wordpress-widgets-api/).

## Features

* The Widget Boilerplate is fully-based on the WordPress [Widget API](http://codex.wordpress.org/Widgets_API)
* Uses [PHPDoc](http://en.wikipedia.org/wiki/PHPDoc) conventions for easily following the code.
* Uses Composer to handle linting and code quality tools before committing it to a repository.
* Uses a strict file organization scheme to make sure the assets are easily maintainable.

## Usage

The WordPress Widget Boilerplate is ready to activate as-is (and it includes a sample widget with a title, content, and checkbox).

1. Copy the `wordpress-widget-boilerplate` directory into your `wp-content/plugins` directory
2. Navigate to the "Plugins" dashboard page
3. Locate the menu item that reads "TODO"
4. Click on "Activate"

The purpose of having a working widget is to give you an idea as to where certain things belong. Further, the idea is to fork the existing code and make it your own for your own project.

It's organized in such a way that lends itself to unit testing, a higher level of cohesion, a lower level of coupling. It also uses features of the object-oriented paradigm to provide better organization of code base and features of PHP such as namespaces and type hinting.

## Author Information

The WordPress Widget Boilerplate was originally started and is maintained by [Tom McFarlin](https://twitter.com/tommcfarlin/).

The project is open-source and receives contributions from awesome WordPress Developers throughout the world.