Skip to content

makewpdev/client

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MakeWP CLient

Installation

You can install MakeWP Client in two ways, via composer or manually.

1. Composer Installation

Add dependency in your project (theme/plugin):

composer require makewpdev/client

Now add autoload.php in your file if you haven't done already.

require_once __DIR__ . '/vendor/autoload.php';

2. Manual Installation

Clone the repository in your project.

cd /path/to/your/project/folder
git clone https://github.com/makewpdev/client.git makewpdev

Now include the dependencies in your plugin/theme.

require_once __DIR__ . '/makewpdev/src/Client.php';

Insights

MakeWP can be used in both themes and plugins.

The makewpdev\Client class has three parameters:

$client = new Makewpdev\Client( $hash, $name, $file );
  • hash (string, required) - The unique identifier for a plugin or theme.
  • name (string, required) - The name of the plugin or theme.
  • file (string, required) - The main file path of the plugin. For theme, path to functions.php

Usage Example

Please refer to the installation step before start using the class.

You can obtain the hash for your plugin for the MakeWP Dashboard. The 3rd parameter must have to be the main file of the plugin.

/**
 * Initialize the tracker
 *
 * @return void
 */
if(!function_exists('makeWP_init_tracker_plugin_name')){
function makeWP_init_tracker_plugin_name() {

    if ( ! class_exists( 'Makewpdev\Client' ) ) {
        require_once __DIR__ . '/makewpdev/src/Client.php';
    }

    $client = new \Makewpdev\Client( 'QYwQI-Yu79YOd7-bYf3GJJ5hm-uzACdpk-O88JP6', 'Plugin Name', __FILE__ );

    // Active insights
    $client->insights()->init();

    // Active automatic updater
    $client->updater();

    // Active license page and checker
    $args = array(
        'type'       => 'options',
        'menu_title' => 'Plugin Name',
        'page_title' => 'Plugin Name License Settings',
        'menu_slug'  => 'plugin_name_settings',
    );
    $client->license()->add_settings_page( $args );
}

makeWP_init_tracker_plugin_name();
}

Makesure to:

  • change plugin_name with your plugin slug
  • call this function direcly, never use any action hook to call this function

For plugins example code that needs to be used on your main plugin file. For themes example code that needs to be used on your themes functions.php file.

Releases

No releases published

Packages

No packages published

Languages