PHPackages                             personare/plugin-boilerplate - 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. [Utility &amp; Helpers](/categories/utility)
4. /
5. personare/plugin-boilerplate

ActiveWordpress-plugin[Utility &amp; Helpers](/categories/utility)

personare/plugin-boilerplate
============================

Personare Plugin Boilerplate.

v2.0.0(5y ago)281[23 PRs](https://github.com/Personare/plugin-boilerplate/pulls)GPL-2.0-onlyPHPPHP &gt;=7.3

Since Jul 8Pushed 3y ago3 watchersCompare

[ Source](https://github.com/Personare/plugin-boilerplate)[ Packagist](https://packagist.org/packages/personare/plugin-boilerplate)[ RSS](/packages/personare-plugin-boilerplate/feed)WikiDiscussions master Synced 2d ago

READMEChangelog (7)Dependencies (10)Versions (31)Used By (0)

Plugin Boilerplate [![Release](https://github.com/Personare/plugin-boilerplate/workflows/Release/badge.svg)](https://github.com/Personare/plugin-boilerplate/workflows/Release/badge.svg) [![semantic-release](https://camo.githubusercontent.com/5f3b57745af83409bc673dec57e3eb360e1ec53b37ac29f81a319e347fa351c6/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f2532302532302546302539462539332541362546302539462539412538302d73656d616e7469632d2d72656c656173652d6531303037392e737667)](https://github.com/semantic-release/semantic-release)
===========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================

[](#plugin-boilerplate--)

Plugin destinado a ser usado como boilerplate, ele irá ser usado principalmente quando surgir a necessidade de criar um plugin WordPress do zero, mas com uma estrutura já bem definida, pronto para testes unitários, linter + analisador estático de código e com container de injeção de dependência.

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

[](#requirements)

- PHP &gt;= 7.3
- Composer

Release automático
------------------

[](#release-automático)

Este projeto tem uma action do [semantic release](https://github.com/semantic-release/semantic-release), que a cada push no branch `master` ela roda para verificar se será necessário gerar um novo release, para isso ele percorre os commits verificando se está no padrão [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/).

**Importante**: Quando for fazer `squash` dos `commits`, será necessário alterar a mensagem do `squash` para o padrão [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/), caso isso não seja feito, o release não será gerado automaticamente.

Quickstart
----------

[](#quickstart)

1. Entre em wp-content/plugins.
2. Execute `composer create-project personare/plugin-boilerplate nome-do-seu-novo-plugin`.
3. [Renomeie as strings](#n%C3%A3o-esque%C3%A7a-de-renomear).
4. Ative o seu novo plugin.

Não esqueça de renomear
-----------------------

[](#não-esqueça-de-renomear)

Renomeie todas as strings abaixo para algo que faça sentido para o projeto que está a desenvolver.

- `MY_APP_`
- `MyApp`
- `my-app`
- `plugin-boilerplate`
- `GPL-2.0-only`

Scripts
-------

[](#scripts)

- `composer ci` irá executar todos os scripts importantes para o CI, consulte o `composer.json` caso queira roda-los individualmente;
- `yarn lint` irá executar o linter para JavaScript + SASS;
- `yarn build` comando para gerar os bundles;

Configurando Phan como `external tool` no PHPStorm
--------------------------------------------------

[](#configurando-phan-como-external-tool-no-phpstorm)

- Em Preferences -&gt; Tools -&gt; External Tools clique para adicionar uma nova tool. Coloque o nome que achar melhor, selecione `run_phan.sh` script como "Program" e selecione o diretório do projeto como "Working directory" e por ultimo coloque `$FILE_PATH$:$LINE$`como "Output filters" clicando em "Advanced Options". Você consegue executar `external tools` em Tools -&gt; External Tools.

Caso dê algum erro de permissão, execute `chmod +x run_phan.sh` no seu terminal.

Exemplo de uso
--------------

[](#exemplo-de-uso)

Consulte os arquivos dentro de `src/WordPress/`, lá vai encontrar bons exemplos de como declarar hooks nesta estrutura, caso queira registrar um CPT consulte `src/WordPress/Services/ExampleServiceProvider.php` ou se caso quer registrar uma Taxonomia, então consulte `src/WordPress/Services/ExampleCategoryServiceProvider.php`

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity8

Limited adoption so far

Community16

Small or concentrated contributor base

Maturity61

Established project with proven stability

 Bus Factor2

2 contributors hold 50%+ of commits

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 ~18 days

Recently: every ~27 days

Total

7

Last Release

2023d ago

Major Versions

v1.2.0 → v2.0.02020-10-27

PHP version history (2 changes)v1.0.0PHP &gt;=7.4

v2.0.0PHP &gt;=7.3

### Community

Maintainers

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

---

Top Contributors

[![elvishp2006](https://avatars.githubusercontent.com/u/7463100?v=4)](https://github.com/elvishp2006 "elvishp2006 (568 commits)")[![renovate-bot](https://avatars.githubusercontent.com/u/25180681?v=4)](https://github.com/renovate-bot "renovate-bot (369 commits)")[![dependabot-preview[bot]](https://avatars.githubusercontent.com/in/2141?v=4)](https://github.com/dependabot-preview[bot] "dependabot-preview[bot] (341 commits)")[![renovate[bot]](https://avatars.githubusercontent.com/in/2740?v=4)](https://github.com/renovate[bot] "renovate[bot] (8 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (5 commits)")[![paulomfr](https://avatars.githubusercontent.com/u/13263721?v=4)](https://github.com/paulomfr "paulomfr (2 commits)")[![kassyn](https://avatars.githubusercontent.com/u/3626002?v=4)](https://github.com/kassyn "kassyn (1 commits)")[![hugoleonardocm](https://avatars.githubusercontent.com/u/13857451?v=4)](https://github.com/hugoleonardocm "hugoleonardocm (1 commits)")

###  Code Quality

TestsPHPUnit

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/personare-plugin-boilerplate/health.svg)

```
[![Health](https://phpackages.com/badges/personare-plugin-boilerplate/health.svg)](https://phpackages.com/packages/personare-plugin-boilerplate)
```

###  Alternatives

[phpro/soap-client

A general purpose SoapClient library

8885.6M46](/packages/phpro-soap-client)[ecotone/ecotone

Supporting you in building DDD, CQRS, Event Sourcing applications with ease.

558549.8k17](/packages/ecotone-ecotone)[civicrm/civicrm-core

Open source constituent relationship management for non-profits, NGOs and advocacy organizations.

728272.9k20](/packages/civicrm-civicrm-core)[j0k3r/php-readability

Automatic article extraction from HTML

186808.8k6](/packages/j0k3r-php-readability)[symfony/ai-platform

PHP library for interacting with AI platform provider.

51927.7k136](/packages/symfony-ai-platform)[spomky-labs/pwa-bundle

Progressive Web App Manifest Generator Bundle for Symfony.

6144.4k1](/packages/spomky-labs-pwa-bundle)

PHPackages © 2026

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