PHP Classes


Recommend this page to a friend!
  Classes of Maniruzzaman Akash   WordPress React Plugin Kit   Download  
Role: Documentation
Content type: text/markdown
Description: Documentation
Class: WordPress React Plugin Kit
Environment to develop new WordPress plugins
Author: By
Last change:
Date: 1 year ago
Size: 6,620 bytes


Class file image Download


A simple starter kit to work in WordPress plugin development using WordPress Rest API, WP-script, React, React Router, Tailwind CSS, PostCSS, Eslint, WP-Data, WP-Data Store, React Components, React CRUD, i18n, PHPUnit Test, JestUnit Test, e2e Test and PHP OOP plugin architecture easily in a minute.

What's included?

  1. WordPress Rest API
  2. WP-script Setup
  3. React
  4. React Router
  5. TypeScript
  6. Tailwind CSS [Nested + ]
  7. Scss
  8. PostCSS
  9. Eslint
  10. WP-Data
  11. WP-Data Redux Store [Redux Saga, Generator function, Thunk, Saga Middleware]
  12. React Components
  13. React CRUD Operations [Continuing...]
  14. Internationalization - WP i18n
  15. PHPUnit Test [Test + Fix]
  16. JestUnit Test
  17. Jest-Pupetter e2e Test
  18. PHP OOP plugin architecture [Traits + Interfaces + Abstract Classes]

Quick Start

# Clone the Git repository
git clone

# Install PHP-composer dependencies [It's empty]
composer install

# Install node module packages
npm i

# Start development mode
npm start

# Start development with hot reload (Frontend components will be updated automatically if any changes are made)
npm run start:hot

# To run in production
npm run build

After running start, or build command, there will be a folder called /build will be generated at the root directory.

Activate the plugin

You need activate the plugin from plugin list page. http://localhost/wpex/wp-admin/plugins.php

Run PHP Unit Test


Run Jest Unit Test

npm run test:unit

Run Jest-Pupeteer e2e Test

WordPress core doc link:

Requirements: - Must have docker installed and running by ensuring these commands -

npm run env:stop
npm run env:start

Normal e2e test

npm run test:e2e

Interactive e2e test

npm run test:e2e:watch

PHP Coding Standards - PHPCS

Get all errors of the project:

vendor/bin/phpcs .

Fix all errors of the project:

vendor/bin/phpcbf .

Browse Plugin


Where, /wpex is the project root folder inside /htdocs.

Or, it could be your custom processed URL.


Postman API Link -

REST API Documentation

  1. Job Types - Method: `GET` - URL: http://localhost/wpex/wp-json/job-place/v1/job-types
  2. Job Lists - Method: `GET` - URL: http://localhost/wpex/wp-json/job-place/v1/jobs
  3. Job Details - Method: `GET` - URL By ID: http://localhost/wpex/wp-json/job-place/v1/jobs/1 - URL By Slug: http://localhost/wpex/wp-json/job-place/v1/jobs/first-job
  4. Create Job
    - Method: `POST`
    - URL: http://localhost/wpex/wp-json/job-place/v1/Jobs
    - Body:
        "title": "Simple Job Post",
        "slug": "simple-job-post",
        "description": "Simple job post description",
        "company_id": 1,
        "job_type_id": 2,
        "is_active": 1
  5. Update Job
    - Method: `PUT`
    - URL: http://localhost/wpex/wp-json/job-place/v1/jobs/1
    - Body:
        "title": "Simple Job Post Updated",
        "slug": "simple-job-post-updated",
        "description": "Simple job post description",
        "company_id": 1,
        "job_type_id": 2,
        "is_active": 1
  6. Delete Jobs
    - Method: `DELETE`
    - URL: http://localhost/wpex/wp-json/job-place/v1/jobs
    - Body:
        "ids": [1, 2]

Detailed Documentation - View Detailed documentations with parameters and responses of the REST API

Version & Changelogs

v0.4.1 - 18/08/2022

  1. Added Jest Unit Test Setup.
  2. Added some dummy Jest Unit Test.
  3. Fix #11 - Version naming while installing.

v0.4.0 - 12/08/2022

  1. Added many re-usable general components.
  2. Header Component refactored and re-designed.
  3. WP-Data setup and made Job Store.
  4. Job List Page frontend added.

v0.3.1 - 11/08/2022

  1. PHPUnit Test cases setup.
  2. PHPUnit Test cases added for Job Manager and Job REST API's.

v0.3.0 - 02/08/2022

  1. Necessary traits to handle - sanitization, query.
  2. Advanced setup for migration, seeder, REST API.
  3. Jobs, Job Types REST API developed.


<summary>Options for specific files:</summary>

Get specific file errors of the project:

vendor/bin/phpcs job-place.php

Fix specific file errors of the project:

vendor/bin/phpcbf job-place.php




<summary>Simple Version with raw PHP</summary> </details>


<summary>Version with EsLint and i18n Setup</summary> </details>


<summary>Version with EsLint, i18n and React Router Setup</summary> </details>


<summary>Version with PostCSS and Tailwind CSS Setup</summary> </details>


<summary>Version with PHPCS setup</summary> </details>


<summary>Version with PHP OOP Architecture</summary> </details>

File structure:


<summary>Simple Version Code-Structure:</summary>

Simple Version </details>

Demo with Simple Version


<summary>Demo in WordPress plugin:</summary>

Demo Plugin </details>

Demo With React Router & Menu

Demo Plugin

Final Demos

Job List Page

Job List Page

Job List Page with Pagination

Job List Page with Pagination

Job List Page with search

Job List Page with Search