Include WordPress plugins with themes and automatically install them the standalone theme is activated. Set plugin requirements as optional or required. Choose a plugin file to package with the theme or reference plugins from the WordPress.org repository.
Navigate to the “Runway > Add-ons” area of your WordPress admin. Find the Plugin Installer extension under the “Extensions” tab and click the “Install” button.
If the button is labeled “Details” but you’ve already purchased the extension, you need to sign in to your account for access. Go to “Runway > Accounts” and sign in with the same username and password used on RunwayWP.com. Return to the Add-ons page and you should now have an active button labeled “Install“.
Manually installing the extension.
To manually install the Plugin Installer extension, start by downloading the ZIP package from your account on RunwayWP.com. Extract the extension from the ZIP package. Login to your web server with your FTP client. Navigate to the Runway install’s extensions folder on your server, ‘wp-content/themes/runway-framework/extensions‘. Copy the extracted extension folder ‘plugin-installer’ to the extensions directory on the server.
Activate the extension
After installing the extension, go to the “Runway > Extensions” page, find the Plugin Installer extension in the list and click the “Activate” link.
Add plugins to be packaged with your theme from the Plugin Installer admin interface. Once the extension is installed and activated you can go to “Settings > Plugin Installer” and access this screen.
Uploading a Plugin File
To add a new plugin to be packaged with your theme, click the “Add New” button next to the page title at the top of the screen.
On the Add New screen you will see two options for selecting a plugin. Under the first option, “Upload a File“, click the “Choose File” or similar option to select a file.
Select the plugin ZIP file. Make sure this is the installable ZIP file, the same one you would upload to WordPress to use the file yourself.
Next, click the “Copy Now” button to finish packaging the plugin with the theme.
Immediately after clicking the “Copy Now” button you may see an alert prompting your to install and activate the plugin. If it happens, this means you do not have the selected plugin installed and activated on the current site. This is just the Plugin Installer doing it’s job already!
To add a free plugin hosted on the WordPress.org repository you can enter the URL to the plugin. Go the the page for the plugin on WordPress.org and copy the URL from your browser’s address bar.
Paste the URL into the field on the “Add New” page for the Plugin Installer and click the “Select Plugin” button.
By default a new plugins added to the Plugin Installer are set as required. You can change this to “Recommended” using the select option for each plugin. Click the “Save” button when finished.
Required plugins will show a notice on the user’s admin if a plugin is not both installed and activated. There is no option for the user to dismiss a notice for a required plugin. This option should only be used for plugins that a theme must have to work properly. All other plugins that provide enhancements or optional functionality should be included as recommended. When a plugin is set to recommended there is an added “Dismiss” option applied to the notice so a user can choose to ignore the recommendation.
Updating Plugin Files
You can update an included plugin by simply replacing the old ZIP file with a new one. The Plugin Installer will automatically read the version number of the new plugin files and know to prompt users to install the update.
To replace the ZIP file, go to ‘wp-content/themes/runway-framework/extensions/plugin-installer/plugins‘ and overwrite the existing ZIP file for that plugin.
You can also update the plugin from the WordPress admin. Go to the Plugin Installer and check box next to the plugin you wish to update. Under “Bulk Options” select “Delete” and click the “Apply” button. After the plugin is deleted you add it back with the newer version.
When a new version of a plugin is added to the theme the user will be notified and prompted to updated. This happens immediately after a user updates the theme. Plugins selected from the WordPress.org repository will work like any other plugin. When a new version is released the default WordPress alerts and update options be shown.
Extensions Installed as Plugins
Sometimes theme marketplaces have require certain functionality only be included using plugins. If you happen to have features of your theme included with Runway extensions but need them to be installed as a plugin to meet these requirements you can select them from the Plugin Installer.
Select the tab for “Extensions” from the Plugin Installer admin and check the boxes for the extensions to apply this option. Click the “Allow install as plugin” button when done. The chosen extensions will be automatically converted and installed as WordPress plugins when the user installs the theme.