dist
1 year ago
includes
1 month ago
locale
2 months ago
res
1 year ago
src
1 month ago
templates
1 month ago
vendor-bin
3 years ago
Makefile
5 years ago
README.md
5 years ago
installer.php
1 month ago
loader.php
1 month ago
phpcs.compatibility.xml
1 year ago
phpcs.xml
5 years ago
phpunit.xml
10 months ago
repositories.xml
3 years ago
webpack.config.js
1 year ago
README.md
62 lines
| 1 | # OTGS WP Installer |
| 2 | |
| 3 | OTGS WP Installer is a library that allows you to install and upgrade plugins and themes developed by OnTheGoSystems. |
| 4 | |
| 5 | ## Installation |
| 6 | |
| 7 | First, add OTGS WP Installer as a dependency with [](http://getcomposer.orgComposer](http://getcomposer.org](http://getcomposer.org): |
| 8 | |
| 9 | ```bash |
| 10 | composer require otgs/installer |
| 11 | ``` |
| 12 | |
| 13 | Make sure that your bootstrap file is loading the composer autoloader: |
| 14 | |
| 15 | ```php |
| 16 | require_once 'vendor/autoload.php'; |
| 17 | ``` |
| 18 | |
| 19 | Then, load the OTGS WP Installer bootstrap. Before the `plugins_loaded` action add: |
| 20 | |
| 21 | ```php |
| 22 | include 'vendor/otgs/installer/loader.php'; |
| 23 | ``` |
| 24 | |
| 25 | Optionally, you can specify parameters to configure showing a dedicated UI under `Plugins -> Install New` or to load specific repositories. |
| 26 | By default, all repositories configrede in `repositories.xml` will be loaded: |
| 27 | * wpml - [](http://wpml.orgWPML.org](http://wpml.org](http://wpml.org) |
| 28 | * toolset - [](http://wp-types.comWP-Types.com](http://wp-types.com](http://wp-types.com) |
| 29 | |
| 30 | ```php |
| 31 | WP_Installer_Setup( $wp_installer_instance, |
| 32 | array( |
| 33 | 'plugins_install_tab' => '1', // optional, default value: 0 |
| 34 | 'repositories_include' => array( 'wpml' ) // optional, default to empty (show all) |
| 35 | ) |
| 36 | ); |
| 37 | ``` |
| 38 | |
| 39 | After `init`, configure display the OTGS WP Installer UI like in the example below: |
| 40 | |
| 41 | ```php |
| 42 | WP_Installer_Show_Products( |
| 43 | array( |
| 44 | 'template' => 'compact', //required |
| 45 | 'product_name' => 'WPML', |
| 46 | 'box_title' => 'Multilingual Avada', |
| 47 | 'name' => 'Avada', //name of theme/plugin |
| 48 | 'box_description' => 'Avada theme is fully compatible with WPML - the WordPress Multilingual plugin. WPML lets |
| 49 | you add languages to your existing sites and includes advanced translation management.', |
| 50 | 'repository' => 'wpml', // required |
| 51 | 'package' => 'multilingual-cms', // required |
| 52 | 'product' => 'multilingual-cms' // required |
| 53 | ) |
| 54 | ); |
| 55 | ``` |
| 56 | |
| 57 | * `template` two options available: default and compact. Default will be the same GUI as on the Plugins -> Install new page while compact is a smaller version that can be fit in a different already existing screen |
| 58 | * `repository` only one product of a specific product package from a specific repository can be shown |
| 59 | * `package` only one product of a specific product package from a specific repository can be shown |
| 60 | * `product` only one product of a specific product package from a specific repository can be shown |
| 61 | |
| 62 |