PluginPulse Connect Library

Embeddable diagnostic and monitoring library for WordPress plugins.

Overview

PluginPulse Connect Library enables WordPress plugin developers to add comprehensive diagnostic and monitoring capabilities to their plugins without requiring users to install a separate plugin. The library handles version conflicts automatically and supports multiple plugins using it simultaneously.

Features

• 🔍 Automatic Diagnostic Data Collection - Gathers WordPress environment, plugin settings, and debug information
• 📊 Multi-Plugin Aggregation - Works seamlessly when multiple plugins embed the library
• 🔐 Secure REST API Endpoints - Generate temporary access links for remote diagnostics
• ⚙️ Configurable Data Collection - Define exactly what data to collect via support-config.json
• 🔄 Automatic Version Conflict Resolution - Always uses the newest library version
• 💻 Composer or Manual Integration - Works with or without Composer

Requirements

• PHP 7.4+
• WordPress 5.8+
• (Optional) Composer for dependency management

Installation

Method 1: Via Composer (Recommended)

composer require pluginpulse/connect-library

Method 2: Manual Installation

1. Download the latest release from GitHub Releases
2. Copy the pluginpulse-connect-library folder to your plugin's library/ directory
3. Include the autoloader in your plugin

Quick Start

Composer Integration

<?php
// In your main plugin file
use PluginPulse\Library\Core\LibraryBootstrap;

add_action('plugins_loaded', function() {
    LibraryBootstrap::init([
        'plugin_slug'    => 'my-awesome-plugin',
        'plugin_name'    => 'My Awesome Plugin',
        'plugin_version' => '1.0.0',
        'option_name'    => 'my_plugin_settings',  // WordPress option name for settings
    ]);
}, 5);

Manual Integration

<?php
// In your main plugin file
require_once __DIR__ . '/lib/pluginpulse-connect-library/src/autoload.php';

add_action('plugins_loaded', function() {
    \PluginPulse\Library\Core\LibraryBootstrap::init([
        'plugin_slug'    => 'my-awesome-plugin',
        'plugin_name'    => 'My Awesome Plugin',
        'plugin_version' => '1.0.0',
        'option_name'    => 'my_plugin_settings',
        'library_path'   => __DIR__ . '/lib/pluginpulse-connect-library',
    ]);
}, 5);

Configuration Options

Full initialization configuration:

\PluginPulse\Library\Core\LibraryBootstrap::init([
    // Required
    'plugin_slug'          => 'my-plugin',      // Unique plugin identifier
    'plugin_name'          => 'My Plugin',      // Display name
    'plugin_version'       => '1.0.0',          // Plugin version
    'option_name'          => 'my_plugin_opts', // WordPress option name for settings

    // Optional
    'library_path'         => '',               // Path to library (auto-detected if empty)
    'enable_rest_api'      => true,             // Enable REST API endpoints (default: true)
    'enable_admin_ui'      => true,             // Enable admin interface (default: true)
    'diagnostics_callback' => null,             // Callable to return custom diagnostic data
]);

Custom Diagnostics Callback

You can provide a callback function to include plugin-specific diagnostic data:

LibraryBootstrap::init([
    'plugin_slug'    => 'my-plugin',
    'plugin_name'    => 'My Plugin',
    'plugin_version' => '1.0.0',
    'option_name'    => 'my_plugin_settings',

    'diagnostics_callback' => function() {
        return [
            'custom_setting'  => get_option('my_custom_setting'),
            'cache_enabled'   => wp_cache_get('my_cache_key') ? true : false,
            'feature_flags'   => [
                'feature_a' => true,
                'feature_b' => false,
            ],
        ];
    },
]);

How It Works

Version Management

When multiple plugins embed the library, it automatically handles version conflicts:

1. First plugin loads → Sets the active library version
2. Newer version detected → Library switches to the newer version
3. Older version detected → Continues using the currently active version

Example:

• Plugin A (library v1.2.0) loads → Active: v1.2.0
• Plugin B (library v1.1.0) loads → Active: v1.2.0 (newer already loaded)
• Plugin C (library v1.3.0) loads → Active: v1.3.0 (switches to newest)

All plugins now use v1.3.0 automatically.

Multi-Plugin Admin UI

When multiple plugins use the library, a unified admin interface is created:

WordPress Admin → Tools → PluginPulse Diagnostics

• Tab: Plugin A Diagnostics
• Tab: Plugin B Diagnostics
• Tab: Plugin C Diagnostics
• Tab: Settings (library version info)

Each tab allows generating diagnostics specific to that plugin.

Documentation

• Integration Guide - Step-by-step integration instructions
• API Reference - REST API endpoint documentation
• Examples - Working code examples
• Testing Guide - How to test library integration

Examples

See the examples/ directory for:

• Composer integration example
• Manual integration example
• Advanced configuration
• Custom diagnostic data

Support

• Documentation: https://pluginpulse.io/docs
• Issues: https://github.com/pluginpulse/pluginpulse-connect-library/issues
• Email: support@pluginpulse.io

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for guidelines.

License

GPL-2.0-or-later - See LICENSE file for details.

Credits

Developed by PluginPulse for the WordPress plugin development community.