wp-plugin-kit.php

<?php
/**
 * WpPluginKit - A starter plugin for WordPress
 *
 * @package    WpPluginKit - WpPluginKit
 * @author     WpPluginKit <therakib7@gmail.com>
 * @link       https://therakib7.com
 * @copyright  2024 WpPluginKit
 *
 * @wordpress-plugin
 * Plugin Name:       WP Plugin Kit
 * Plugin URI:        https://wordpress.org/plugins/wp-plugin-kit
 * Description:       A starter plugin for WordPress that provides a foundational structure to build upon
 * Version:           0.1.0
 * Author:            WpPluginKit
 * Author URI:        https://therakib7.com
 * Requires at least: 5.8
 * Requires PHP:      7.4
 * Tested up to:      6.4
 * Text Domain:       wp-plugin-kit
 * Domain Path:       /languages
 * License: GPL-2.0-or-later
 * License URI: https://www.gnu.org/licenses/gpl-2.0.html
 */

/**
 * Don't allow call the file directly
 *
 * @since 0.1.0
 */
defined( 'ABSPATH' ) || exit;

/**
 * WpPluginKit Final Class
 *
 * @since 0.1.0
 *
 * @class WpPluginKit The class that holds the entire WpPluginKit plugin
 */

final class WpPluginKit {

    /**
     * Instance of self
	 *
     * @since 0.1.0
	 *
     * @var WpPluginKit
     */
    private static $instance = null;

    /**
     * Plugin version
     *
     * @since 0.1.0
	 *
     * @var string
     */
    private const VERSION = '0.1.0';

    /**
     * Plugin slug.
     *
     * @var string
     *
     * @since 0.1.0
     */
    const SLUG = 'wp-plugin-kit';

    /**
     * Holds various class instances.
     *
     * @var array
     *
     * @since 0.1.0
     */
    private $container = [];

    /**
     * Minimum PHP version required
	 *
     * @since 0.1.0
	 *
     * @var string
     */
    private const MIN_PHP = '7.4';

    /**
     * Constructor for the WpPluginKit class
     *
     * Sets up all the appropriate hooks and actions
     * within our plugin.
     */
    public function __construct() {

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

        $this->define_constants();

		register_activation_hook( __FILE__, [ $this, 'activate' ] );
        register_deactivation_hook( __FILE__, [ $this, 'deactivate' ] );

		add_action( 'wp_loaded', [ $this, 'flush_rewrite_rules' ] );

		$this->init_plugin();
    }

	/**
     * Initializes the WpPluginKit() class
     *
     * Checks for an existing WpPluginKit() instance
     * and if it doesn't find one, create it.
     */
    public static function init() {
        if ( self::$instance === null ) {
            self::$instance = new self();
        }

        return self::$instance;
    }

    /**
     * Magic getter to bypass referencing plugin.
     *
     * @since 0.1.0
     *
     * @param $prop
     *
     * @return mixed
     */
    public function __get( $prop ) {
        if ( array_key_exists( $prop, $this->container ) ) {
            return $this->container[ $prop ];
        }

        return $this->{$prop};
    }

    /**
     * Magic isset to bypass referencing plugin.
     *
     * @since 0.1.0
     *
     * @param $prop
     *
     * @return mixed
     */
    public function __isset( $prop ) {
        return isset( $this->{$prop} ) || isset( $this->container[ $prop ] );
    }

    /**
     * Define all constants
	 *
     * @since 0.1.0
	 *
     * @return void
     */
    public function define_constants() {
        define( 'WP_PLUGIN_KIT_VERSION', self::VERSION );
        define( 'WP_PLUGIN_KIT_SLUG', self::SLUG );
        define( 'WP_PLUGIN_KIT_FILE', __FILE__ );
        define( 'WP_PLUGIN_KIT_DIR', __DIR__ );
        define( 'WP_PLUGIN_KIT_PATH', plugin_dir_path( WP_PLUGIN_KIT_FILE ) );
        define( 'WP_PLUGIN_KIT_URL', plugins_url( '', WP_PLUGIN_KIT_FILE ) );
        define( 'WP_PLUGIN_KIT_TEMPLATE_PATH', WP_PLUGIN_KIT_PATH . '/templates' );
        define( 'WP_PLUGIN_KIT_BUILD', WP_PLUGIN_KIT_URL . '/build' );
        define( 'WP_PLUGIN_KIT_ASSETS', WP_PLUGIN_KIT_URL . '/assets' );
    }

	/**
     * Load the plugin after all plugins are loaded.
     *
     * @since 0.1.0
     *
     * @return void
     */
    public function init_plugin() {

		do_action( 'wp_plugin_kit_before_init' );

        $this->includes();
        $this->init_hooks();

		// Fires after the plugin is loaded.
        do_action( 'wp_plugin_kit_init' );
    }

	/**
     * Include the required files.
     *
     * @since 0.1.0
     *
     * @return void
     */
    public function includes() {
        if ( $this->is_request( 'admin' ) ) {
            $this->container['installer'] = new Therakib7\WpPluginKit\Setup\Installer();
            $this->container['admin_menu'] = new Therakib7\WpPluginKit\Admin\Menu();
        }

        $this->container['assets']   = new Therakib7\WpPluginKit\Assets\Manager();
        $this->container['rest_api'] = new Therakib7\WpPluginKit\Api\Controller();
        $this->container['hooks'] = new Therakib7\WpPluginKit\Hooks\Manager();
    }

	/**
     * Initialize the hooks.
     *
     * @since 0.1.0
     *
     * @return void
     */
    public function init_hooks() {

        // Localize our plugin
        add_action( 'init', [ $this, 'localization_setup' ] );
    }

	/**
     * Initialize plugin for localization
     *
     * @since 0.1.0
     *
     * @uses load_plugin_textdomain()
	 *
	 * @return void
     */
    public function localization_setup() {
        load_plugin_textdomain( 'wp-plugin-kit', false, dirname( plugin_basename( __FILE__ ) ) . '/languages' );
    }

	/**
     * Activating the plugin.
     *
     * @since 0.1.0
     *
     * @return void
     */
    public function activate() {
        // Run the installer to create necessary migrations and seeders.
    }

    /**
     * Placeholder for deactivation function.
     *
     * @since 0.1.0
     *
     * @return void
     */
    public function deactivate() {
        // Remove unnecessary data when deactivate
    }

	/**
     * Flush rewrite rules after plugin is activated.
     *
     * Nothing being added here yet.
     *
     * @since 0.1.0
	 *
	 * @return void
     */
    public function flush_rewrite_rules() {
        // fix rewrite rules
    }

    /**
     * What type of request is this?
     *
     * @param string $type admin, ajax, cron or public.
     *
     * @since 0.1.0
     *
     * @return bool
     */
    private function is_request( $type ) {
        switch ( $type ) {
            case 'admin':
                return is_admin();

            case 'ajax':
                return defined( 'DOING_AJAX' );

            case 'rest':
                return defined( 'REST_REQUEST' );

            case 'cron':
                return defined( 'DOING_CRON' );

            case 'frontend':
                return ( ! is_admin() || defined( 'DOING_AJAX' ) ) && ! defined( 'DOING_CRON' );
        }
    }
}

/**
 * Initialize the main plugin.
 *
 * @since 0.1.0
 *
 * @return WpPluginKit
 */
function wp_plugin_kit() {
    return WpPluginKit::init();
}
wp_plugin_kit(); // Run WpPluginKit Plugin