PHPackages                             threadi/easy-setup-for-wordpress - 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. threadi/easy-setup-for-wordpress

ActiveLibrary[Utility &amp; Helpers](/categories/utility)

threadi/easy-setup-for-wordpress
================================

Provides a simple react-driven plugin-setup for WordPress-backend.

1.3.1(1mo ago)0509↑62.5%GPL-3.0-or-laterJavaScript

Since Oct 8Pushed 1mo ago1 watchersCompare

[ Source](https://github.com/threadi/easy-setup-for-wordpress)[ Packagist](https://packagist.org/packages/threadi/easy-setup-for-wordpress)[ RSS](/packages/threadi-easy-setup-for-wordpress/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)DependenciesVersions (39)Used By (0)

Easy Setup for WordPress
========================

[](#easy-setup-for-wordpress)

Hint
----

[](#hint)

This is the successor to *WP Easy Setup*. The new name became necessary due to the abbreviations used.

### Changes

[](#changes)

#### Hooks

[](#hooks)

wp\_easy\_setup\_skip =&gt; esfw\_skip wp\_easy\_setup\_step =&gt; esfw\_steps wp\_easy\_setup\_process\_init =&gt; esfw\_process\_init wp\_easy\_setup\_process =&gt; esfw\_process wp\_easy\_setup\_completed =&gt; esfw\_completed wp\_easy\_setup\_set\_completed =&gt; esfw\_set\_completed wp\_easy\_setup\_step\_label =&gt; esfw\_step\_label wp\_easy\_setup\_max\_steps =&gt; esfw\_max\_steps

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

[](#requirements)

- composer to install this package.
- npm to compile the scripts.
- WordPress-plugin where this setup will be used

Installation
------------

[](#installation)

1. `composer require threadi/easy-setup-for-wordpress`
2. Switch to `vendor/thread/easy-setup-for-wordpress`
3. Run `npm i` to install dependencies.
4. Run `npm run build` to compile the scripts.

Usage
-----

[](#usage)

### Embed

[](#embed)

Add this in the page where you want to show the setup.

```
$setup_obj = \easySetupForWordPress\Setup::get_instance();
$setup_obj->set_url( 'website-URL' );
$setup_obj->set_path( 'website-path' );
$setup_obj->set_texts( array(
    'title_error'      => __( 'Error', 'your-text-domain' ),
    'txt_error_1'      => __( 'The following error occurred:', 'your-text-domain' ),
    'txt_error_2'      => __( 'text after error', 'your-text-domain' ),
) );
$setup_obj->set_config( array( /* your custom setup configuration */ ) );
echo $setup_obj->display( 'your-setup-name' );

```

**Hint:** line 1 to 4 should be run before any output, e.g. via `admin_init` hook.

### Custom configuration

[](#custom-configuration)

The array *must* contain following entries:

- name =&gt; the unique name for the setup (e.g. the plugin slug)
- title =&gt; the language-specific title of the setup for the header of it
- steps =&gt; list of steps (see below)
- back\_button\_label =&gt; language-specific title for the back-button
- continue\_button\_label =&gt; language-specific title for the continue-button
- finish\_button\_label =&gt; language-specific title for the finish-button

### Steps

[](#steps)

Steps are defined as array with step-number as index and fields-configuration as value. Example:

```
1 => array( /* fields in step 1 */ ),
2 => array( /* fields in step 2 */ )

```

The fields-configuration is defined as array with the following structure:

```
1 => array(
    'field_1_name'              => array(
        'type'                => 'field-type',
        'label'               => __( 'the label', 'your-text-domain' ),
        'help'                => __( 'the help text', 'your-text-domain' ),
        'placeholder'         => __( 'the placeholder', 'your-text-domain' ),
        'required'            => true, // true if required for next step
        'validation_callback' => 'example::validate', // PHP-callback to validate the entry
    ),
    'field_2_name'              => array(
        'type'                => 'field-type',
        'label'               => __( 'the label', 'your-text-domain' ),
        'help'                => __( 'the help text', 'your-text-domain' ),
        'placeholder'         => __( 'the placeholder', 'your-text-domain' ),
        'required'            => true, // true if required for next step
        'validation_callback' => 'example::validate', // PHP-callback to validate the entry
    ),

```

#### Field-types

[](#field-types)

Following field-types are supported:

- CheckboxControl =&gt; shows a simple checkbox for "yes/no"
- ProgressBar =&gt; shows a progressbar which will process what is defined via hook "wp\_easy\_setup\_process"
- RadioControl =&gt; shows a group of radio-boxes where the user should decide what to choose
- TextControl =&gt; shows a single input-text-field
- Text =&gt; shows the text you defined in array-key "text"

#### Other array keys

[](#other-array-keys)

- label =&gt; is the label above the field
- help =&gt; shows a html-formatted text below the field
- placeholder =&gt; is used as such on field which support it
- required =&gt; true if field is required for next step
- validation\_callback =&gt; PHP-callback to validate the entry

###  Health Score

44

—

FairBetter than 92% of packages

Maintenance90

Actively maintained with recent releases

Popularity17

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity51

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

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

Recently: every ~41 days

Total

19

Last Release

51d ago

### Community

Maintainers

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

---

Top Contributors

[![threadi](https://avatars.githubusercontent.com/u/16623633?v=4)](https://github.com/threadi "threadi (40 commits)")

### Embed Badge

![Health badge](/badges/threadi-easy-setup-for-wordpress/health.svg)

```
[![Health](https://phpackages.com/badges/threadi-easy-setup-for-wordpress/health.svg)](https://phpackages.com/packages/threadi-easy-setup-for-wordpress)
```

PHPackages © 2026

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