wp-kit/config

The config handler for wp-kit

2.0.4 2020-09-23 10:29 UTC

This package is not auto-updated.

Last update: 2024-07-02 07:28:16 UTC


README

wp-kit/config

This is a wp-kit component that handles config files.

wp-kit/config is fully compatible with Themosis.

If you are using Themosis you'll notice it already has a ConfigFactory however this lacks ArrayAccess and only binds to $app['config.factory`] and not $app['config`] which means it is not compatible with most Illuminate components. wp-kit/config solves these issues so you can benefit from using Illuminate components when using Themosis.

Installation

If you're using Themosis, install via Composer in the Themosis route folder, otherwise install in your Composer driven theme folder:

composer require "wp-kit/config"

Setup

Add Service Provider

Just register the service provider and facade in the providers config and theme config:

//inside theme/resources/config/providers.config.php

return [
    //
    WPKit\Config\ConfigServiceProvider::class,
    //
];

Usage

Simply add config files as theme/resources/config/*.config.php and reference the below snippet to access config data in ArrayAccess fashion:

app('config')->get('anything.key.key');

Get Involved

To learn more about how to use wp-kit check out the docs:

View the Docs

Any help is appreciated. The project is open-source and we encourage you to participate. You can contribute to the project in multiple ways by:

  • Reporting a bug issue
  • Suggesting features
  • Sending a pull request with code fix or feature
  • Following the project on GitHub
  • Sharing the project around your community

For details about contributing to the framework, please check the contribution guide.

Requirements

Wordpress 4+

PHP 5.6+

License

wp-kit/config is open-sourced software licensed under the MIT License.