Plugin Class

$plugin = WPKirk();

/**
 * Return the public apps URL
 *
 * @example http://example.com/wp-content/plugins/my-plugin/public/apps
 *
 * @return string
 */

echo $plugin->apps; // Outputs the URL to the plugin's public apps directory

/**
 * Return the filesystem path to the plugin
 *
 * @example /var/www/html/wp-content/plugins/my-plugin
 *
 * @return string
 */

echo $plugin->basePath; // Outputs the filesystem path to the plugin

/**
 * Return the base URI of the plugin
 *
 * @example http://example.com/wp-content/plugins/my-plugin
 *
 * @return string
 */

echo $plugin->baseUri; // Outputs the base URI of the plugin

/**
 * Return the public css URL
 *
 * @example http://example.com/wp-content/plugins/my-plugin/public/css
 *
 * @return string
 */

echo $plugin->css; // Outputs the URL to the plugin's public CSS directory

/**
 * Return the plugin file.
 * This is an alias of `__FILE__`
 *
 * @example /var/www/html/wp-content/plugins/my-plugin/my-plugin.php
 *
 * @since 1.8.0
 *
 * @return string
 */

echo $plugin->file; // Outputs the path to the main plugin file

/**
 * Return the public images URL
 *
 * @example http://example.com/wp-content/plugins/my-plugin/public/images
 *
 * @return string
 */

echo $plugin->images; // Outputs the URL to the plugin's public images directory

/**
 * Return the public js URL
 *
 * @example http://example.com/wp-content/plugins/my-plugin/public/js
 *
 * @return string
 */

echo $plugin->js; // Outputs the URL to the plugin's public JavaScript directory

/**
 * Magic method to get the options
 *
 * @return WordPressOption
 */

$options = $plugin->options; // Access the plugin's options

/**
 * Return the plugin basename
 *
 * @example my-plugin/my-plugin.php
 *
 * @return string
 */

echo $plugin->pluginBasename; // Outputs the plugin's basename

/**
 * Magic method to get the request
 *
 * @return Request
 */

$request = $plugin->request; // Access the current HTTP request

/**
 * The slug of this plugin.
 *
 * @var string
 */

echo $plugin->slug; // Outputs the slug of the plugin

/**
 * Get / set the specified configuration value.
 *
 * If an array is passed as the key, we will assume you want to set an array of values.
 *
 * @param array|string $key The key of the configuration in dot notation.
 * @param mixed $default    Optional. Default value
 *
 * @return mixed
 */
public function config($key = null, $default = null)

$value = $plugin->config('plugin.some_setting', 'default_value');

$log = WPKirk()->config('plugin.log');

<?php
 
return [
  'sample' => 'Hello, Captain!',
  'nested' => [
    'key' => 'value'
  ]
];

$sample = WPKirk()->config('custom.sample');

$nested = WPKirk()->config('custom.nested.key');

/**
 * Helper method to load (enqueue) styles.
 *
 * For your convenience, the params $filename may be an array of file.
 *
 * @param string|array  $filename  Filename
 * @param array         $deps      Optional. Dependencies array
 * @param null          $version   Optional. Default plugin version
 */
public function css($filename, $deps = [], $version = null)

$plugin->css(['style.css', 'theme.css']);

/**
 * Gets the value of an environment variable. Supports boolean, empty and null.
 *
 * @param string $key     The environment variable name.
 * @param mixed $default  Optional. Default null.
 *
 * @return mixed
 */
public function env($key, $default = null)

$dbHost = $plugin->env('DB_HOST', 'localhost');

/**
 * Utility method to get the callback for a route
 *
 * @param array $routes
 * @return Closure|null
 */
public function getCallableHook($routes)

$callback = $plugin->getCallableHook($routes);

/**
 * Return the URL of a menu page
 *
 * @param string|int  $menuSlug The slug of the menu. The array key used in the menu array.
 *
 * @return string
 */
public function getMenuUrl($menuSlug): string

$url = $plugin->getMenuUrl('my_menu_slug');

/**
 * Return the URL of a custom page
 *
 * @param string  $pageSlug The slug of the page
 *
 * @return string
 */
public function getPageUrl($pageSlug): string

$url = $plugin->getPageUrl('my_page_slug');

/**
 * Return TRUE if an Ajax called
 *
 * @return bool
 */
public function isAjax(): bool

if ($plugin->isAjax()) {
    // Handle AJAX request
}

/**
 * Helper method to load (enqueue) styles.
 *
 * For your convenience, the params $filename may be an array of file.
 *
 * @param string|array  $filename Filenames
 * @param array         $deps     Optional. Dependencies array
 * @param null          $version  Optional. Default plugin version
 * @param bool          $footer   Optional. Load on footer. Default true
 */
public function js($filename, $deps = [], $version = null, $footer = true)

$plugin->js(['script.js', 'theme.js']);

/**
 * Return the Log provider
 *
 * @return mixed
 */
public function log()

$log = $plugin->log();
$log->info('This is a log message.');

/**
 * Return a provider by name
 *
 * @param string  $name The Class name of the provider.
 *
 * @return mixed|null
 */
public function provider($name)

$provider = $plugin->provider('SomeServiceProvider');

/**
 * Returns the absolute URL for the vendor directory.
 *
 * @param string $vendor Optional. Default 'wpbones'.
 *
 * @return string
 */
public function vendor($vendor = 'wpbones'): string

$vendorUrl = $plugin->vendor();

/**
 * Return an instance of View/Contract.
 *
 * @param null  $key  Optional. Default null.
 * @param array $data Optional. Default null.
 *
 * @return View
 */
public function view($key = null, $data = []): View

$view = $plugin->view('template', ['key' => 'value']);