README

A simple wordpress plugin to display users in table on custom endpoint from third party API.

Installation

Plugin Installation

The plugin can be installed via Composer by the name drcsystems/display-third-party-users.

It means they can be installed by adding the entry to composer.json require-dev:

{
    "require-dev": {
        "drcsystems/display-third-party-users": "^1"
    }
}

or via command line with: (From your wordpress root)

$ composer require drcsystems/display-third-party-users --dev

Plugin Requirements

• Php 5.6 or later
• Wordpress 5 or later

(The default target version is PHP 7.0+ and Wordpress 5.7)

Usage

Basic usage

When the plugin is installed via Composer, and dependencies are updated, everything is ready and you can view the plugin in wp-admin under plugin where you need to activate it.

There are options that can be used to customise which can be found under Settings->Third Party Users in wp-admin

Configuration

After activating the plugin go to Settings->Third Party Users in wp-admin and change the Endpoint Slug if you want other wise the default value will be used.

Following API is used as default to display users:

https://jsonplaceholder.typicode.com/users

(You can change the API but make sure your API has the same response structure as the default API)

Visit the page with your Endpoint Slug to view the data in table

http://YOUR_DOMAIN_NAME/ENDPOINT_SLUG

OR

https://YOUR_DOMAIN_NAME/ENDPOINT_SLUG

Customization

You can display more columns in the table using this filter hook:

wpdtpu_datatable_columns

For e.g.,

function wpdtpu_get_columns($data){
	$data[] = 'email'; //valid column name
	return $data;
}

add_filter( 'wpdtpu_datatable_columns', 'wpdtpu_get_columns',1 );

Phpunit Testing

Go to your plugin dir, run this command:

wp scaffold plugin-tests display-third-party-users

Replace “root” with the username of your database and replace ” with the database password. Also replace “localhost” with the hostname of your database. You can find all three of these values in your wp-config.php file.

You can now type phpunit OR lib/bin/phpunit into the command line and the unit tests will run

Phpunit Testing Refrence

• https://pippinsplugins.com/unit-tests-wordpress-plugins-setting-up-testing-suite/
• https://gist.github.com/dotherightthing/c8dede3241909e931e62deaf3acf7b8b