apiki/wpsteak-plugin

A fully structured WordPress plugin.

3.1.11 2021-05-25 14:05 UTC

Requires

• php: >=7.4
• apiki/wpsteak: 0.1.2
• composer/installers: 1.11.0
• league/container: 3.3.5

Requires (Dev)

• dealerdirect/phpcodesniffer-composer-installer: 0.7.1
• edgedesign/phpqa: ^1.24.0
• nette/neon: 3.2.2
• php-stubs/wordpress-stubs: 5.7.1
• phpcompatibility/phpcompatibility-wp: 2.1.1
• phpunit/phpunit: 9.5.4
• slevomat/coding-standard: 7.0.8
• szepeviktor/phpstan-wordpress: 0.7.5
• vimeo/psalm: 4.7.3
• wp-coding-standards/wpcs: 2.3.0

GPL-2.0-only

README

Features

• All advantages from WPSteak
• Dependency injection container;
• Ready for unit tests with PHPUnit;
• PHP CodeSniffer configured with WordPress Coding Standards;
• Wonderful resources processing configuration extracted from wpemerge-theme;
• PHP PSR-4 autoloading for all your source code and tests;

Requirements

• PHP >= 7.4
• Composer

Quickstart

1. Browse to wp-content/plugins.
2. Run composer create-project apiki/wpsteak-plugin your-plugin-name.

Directory structure

.
├── dist/                            # Bundles, optimized images etc.
├── languages/                       # Language files.
├── resources/                       # Build process configuration, Scripts, Styles, etc.
├── src/                             # PSR-4 autoloaded classes.
│   ├── Entities/                    # Classes for using on data mapper.
│   │   ├── Categories.php
│   │   ├── Category.php
│   │   ├── ExampleCategory.php
│   │   ├── Example.php
│   │   ├── Examples.php
│   │   ├── Page.php
│   │   ├── Post.php
│   │   ├── Posts.php
│   │   ├── Tag.php
│   │   └── Tags.php
│   ├── Providers/                   # Your hooks declarations.
│   │   ├── Assets
│   │   │   ├── Admin.php
│   │   │   ├── Editor.php
│   │   │   ├── Login.php
│   │   │   └── Theme.php
│   │   ├── Example
│   │   │   ├── PostMeta.php
│   │   │   └── PostType.php
│   │   └── ExampleCategory
│   │       └── Taxonomy.php
│   ├── Repositories/                # Where you put your data handle (includes API).
│   │   ├── Category.php
│   │   ├── Example.php
│   │   ├── Page.php
│   │   ├── Post.php
│   │   └── Tag.php
│   ├── Services/                    # Where your business logic goes on.
│   └── Widgets/                     # Widget classes.
├── tests/                           # PHP Unit tests.
├── views/                           # View files used for metaboxes, shortcodes, etc.
├── config.json.dist
├── config.php                       # Where your providers and services providers will be loaded.
└── wpsteak.php                      # Bootstrap plugin.