PHPackages                             pinkcrab/perique-framework-core - 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. pinkcrab/perique-framework-core

ActiveLibrary

pinkcrab/perique-framework-core
===============================

The core package of the PinkCrab Perique framework.

2.1.1(3mo ago)528.7k↓50%[2 issues](https://github.com/Pink-Crab/Perique-Framework/issues)[4 PRs](https://github.com/Pink-Crab/Perique-Framework/pulls)2MITPHPPHP &gt;=7.4.0CI passing

Since Jan 10Pushed 3mo ago2 watchersCompare

[ Source](https://github.com/Pink-Crab/Perique-Framework)[ Packagist](https://packagist.org/packages/pinkcrab/perique-framework-core)[ Docs](https://pinkcrab.co.uk)[ RSS](/packages/pinkcrab-perique-framework-core/feed)WikiDiscussions master Synced today

READMEChangelog (10)Dependencies (21)Versions (130)Used By (2)

PinkCrab **Perique** Plugin Framework
=====================================

[](#pinkcrab-perique-plugin-framework)

[![logo](assets/Perique_Card.jpg "PinkCrab Perique")](assets/Perique_Card.jpg)

Welcome to the core package of the PinkCrab **Perique** plugin framework, formally known as just the PinkCrab Plugin Framework.

[![Latest Stable Version](https://camo.githubusercontent.com/bcc39390bb9dc83d0a2adceeae6249a9483092db7fe43ab0c724f70aed7d2cc3/68747470733a2f2f706f7365722e707567782e6f72672f70696e6b637261622f706572697175652d6672616d65776f726b2d636f72652f76)](https://packagist.org/packages/pinkcrab/perique-framework-core)[![Total Downloads](https://camo.githubusercontent.com/9263d51a30f54dd1827c7afa80110e5f36e7757a86ac07facf6dc6135f99cb1d/68747470733a2f2f706f7365722e707567782e6f72672f70696e6b637261622f706572697175652d6672616d65776f726b2d636f72652f646f776e6c6f616473)](https://packagist.org/packages/pinkcrab/perique-framework-core)[![License](https://camo.githubusercontent.com/16e41d3fa3bb372dec24e1f3016fb8f7d4747b0e15ca9b2c9f0d15ed6fddd45a/68747470733a2f2f706f7365722e707567782e6f72672f70696e6b637261622f706572697175652d6672616d65776f726b2d636f72652f6c6963656e7365)](https://packagist.org/packages/pinkcrab/perique-framework-core)[![PHP Version Require](https://camo.githubusercontent.com/9dd6cf21a67b1e4185517f95c7b4881a63fb10eb7d31554f9760b11755113f2f/68747470733a2f2f706f7365722e707567782e6f72672f70696e6b637261622f706572697175652d6672616d65776f726b2d636f72652f726571756972652f706870)](https://packagist.org/packages/pinkcrab/perique-framework-core)[![GitHub contributors](https://camo.githubusercontent.com/be34c28908910e62c3efff452ae0cf0cd9cdf9699555b1f6cf7638ce165a3df0/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f636f6e7472696275746f72732f50696e6b2d437261622f506572697175652d4672616d65776f726b3f6c6162656c3d436f6e7472696275746f7273)](https://camo.githubusercontent.com/be34c28908910e62c3efff452ae0cf0cd9cdf9699555b1f6cf7638ce165a3df0/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f636f6e7472696275746f72732f50696e6b2d437261622f506572697175652d4672616d65776f726b3f6c6162656c3d436f6e7472696275746f7273)[![GitHub issues](https://camo.githubusercontent.com/d370105d811306759a40b92d1f75dc0e5267e0d3712716356f43f8c5d7d28804/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6973737565732d7261772f50696e6b2d437261622f506572697175652d4672616d65776f726b)](https://camo.githubusercontent.com/d370105d811306759a40b92d1f75dc0e5267e0d3712716356f43f8c5d7d28804/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6973737565732d7261772f50696e6b2d437261622f506572697175652d4672616d65776f726b)

[![WP6.1 [PHP7.4-8.3] Tests](https://github.com/Pink-Crab/Perique-Framework/actions/workflows/WP_6_1.yaml/badge.svg)](https://github.com/Pink-Crab/Perique-Framework/actions/workflows/WP_6_1.yaml)[![WP6.2 [PHP7.4-8.3] Tests](https://github.com/Pink-Crab/Perique-Framework/actions/workflows/WP_6_2.yaml/badge.svg)](https://github.com/Pink-Crab/Perique-Framework/actions/workflows/WP_6_2.yaml)[![WP6.3 [PHP7.4-8.3] Tests](https://github.com/Pink-Crab/Perique-Framework/actions/workflows/WP_6_3.yaml/badge.svg)](https://github.com/Pink-Crab/Perique-Framework/actions/workflows/WP_6_3.yaml)[![WP6.4 [PHP7.4-8.3] Tests](https://github.com/Pink-Crab/Perique-Framework/actions/workflows/WP_6_4.yaml/badge.svg)](https://github.com/Pink-Crab/Perique-Framework/actions/workflows/WP_6_4.yaml)[![WP6.5 [PHP7.4-8.3] Tests](https://github.com/Pink-Crab/Perique-Framework/actions/workflows/WP_6_5.yaml/badge.svg)](https://github.com/Pink-Crab/Perique-Framework/actions/workflows/WP_6_5.yaml)[![WP6.6 [PHP7.4-8.3] Tests](https://github.com/Pink-Crab/Perique-Framework/actions/workflows/WP_6_6.yaml/badge.svg)](https://github.com/Pink-Crab/Perique-Framework/actions/workflows/WP_6_6.yaml)

[![Mutation testing badge](https://camo.githubusercontent.com/a6ccc6bf6c2328ac799eec7693d113f2518e6dc1b0b6a007b090c281a6eb9547/68747470733a2f2f696d672e736869656c64732e696f2f656e64706f696e743f7374796c653d666c61742675726c3d687474707325334125324625324662616467652d6170692e737472796b65722d6d757461746f722e696f2532466769746875622e636f6d25324650696e6b2d43726162253246506572697175652d4672616d65776f726b2532466d6173746572)](https://dashboard.stryker-mutator.io/reports/github.com/Pink-Crab/Perique-Framework/master)[![codecov](https://camo.githubusercontent.com/13bea1e6c8e665102b490a660e7ef9243b7d2b9e8bbaca983d14c5eb9947e42f/68747470733a2f2f636f6465636f762e696f2f67682f50696e6b2d437261622f506572697175652d4672616d65776f726b2f6272616e63682f6d61737465722f67726170682f62616467652e737667)](https://codecov.io/gh/Pink-Crab/Perique-Framework)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/d9a82f01eb69cb75258dd8896ad6fcd31e09639d5ccbe7f83b2f581e2f94b979/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f50696e6b2d437261622f506572697175652d4672616d65776f726b2f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/Pink-Crab/Perique-Framework/?branch=master)[![Maintainability](https://camo.githubusercontent.com/26fe077f1579823536b1d3d6b7c9000069d2f54c388745336dc283e9aa08449c/68747470733a2f2f6170692e636f6465636c696d6174652e636f6d2f76312f6261646765732f34613238303034616530396138636433376564662f6d61696e7461696e6162696c697479)](https://codeclimate.com/github/Pink-Crab/Perique-Framework/maintainability)

For more details please visit our docs. [**https://perique.info**](https://perique.info)

Why?
----

[](#why)

WordPress is a powerful tool for building a wide range of websites, but due to its age and commitment to backwards compatibility it's often frustration to work with using more modern tools.

Perique allows the creation of plugins, MU libraries for use on more complex websites.

The Core only provides access to the `Hook_Loader`, `Registration`, DI (DICE IOC Container), `App_Config` and basic (native) `PHP_Engine` rendering views.

What is Perique?
----------------

[](#what-is-perique)

Perique is rare form of pipe tobacco produced in the St James Parish of Louisiana. This historic tobacco has been produced in the region for centuries and sees tobaccos taken, packed into a barrels under pressure and left to ferment for over 12 months. The resulting tobacco has a strong and pungent quality, which is used to heavily enhance a tobaccos flavour, nicotine content and aroma with only a small quantity used. This is something we strived to produce in this framework; a small amount of existing code that can be used to enhance any codebase to be big, bold and striking.

Setup
-----

[](#setup)

```
$ composer require pinkcrab/perique-framework-core
```

First you will need to create your composer.json and plugin.php file.

### plugin.php

[](#pluginphp)

```
// @file plugin.php
