Introduction
The plugin connects WordPress and Adminer tool. Use database management tool directly in your WordPress site.
Let's start to play with the plugin and install it.
Installation
The extension can be installed in different ways.
The preferable way:
- Login to admin area of your WordPress site and open "Plugins → Add New" page.
- Enter "ARI Adminer" in "Search Plugins" box and search the plugin.
- Click "Install Now" button for "ARI Adminer" plugin.
- Click "Activate" link after successful plugin installation.
An alternative way #1:
- Download ari-adminer.zip archive here.
- Login to admin area of your WordPress site and open "Plugins → Add New" page.
- Click "Upload Plugin" button, use "Browse" button to select the downloaded archive with the plugin and click "Install now" button.
- Click "Activate" link after successful plugin installation.
An alternative way #2:
- Download ari-adminer.zip archive here.
- Unzip it to a folder on your local machine.
- Connect your server (where WordPress is installed) by FTP.
- Copy ari-adminer folder from the archive to [wordpress_folder]/wp-content/plugins folder on the server.
- Login to admin area of your WordPress site and open "Plugins → Installed Plugins" page.
- Click "Activate" link for "ARI Adminer" plugin to active it.
When the plugin is installed and activated, "ARI Adminer" link will appear in main menu for administrators (if multisite mode is not used on your WordPress site) or for super-administrators (if multisite mode is enabled).
Update
The extension supports automatic update which is a core feature of WordPress. The plugin will be updated automatically in a background or show an alert when a new version is available and offer to update the plugin by press a confirm button. This behavior depends on configuration of your WordPress site. More information about automatic updates is available here.The extension can also be updated manually, for this download the latest version of the extension here, uninstall the previous version of the plugin and install a new one like described in installation section or login to your server by FTP, delete [wordpress_folder]/wp-content/plugins/ari-adminer folder and copy content of ari-adminer.zip archive to [wordpress_folder]/wp-content/plugins.
System requirements
The extension is compatible with WordPress 4.0+ and requires PHP 5.4+.Admin area
The plugin adds "ARI Adminer" menu item to main menu on WordPress admin part. By default the plugin is available for administrators (if multisite mode is not used on your WordPress site) or for super-administrators (if multisite mode is enabled).
It is possible to select user roles for which the plugin will be available on "ARI Adminer → Settings" page.
"ARI Adminer" menu contains Run Adminer, Connections and Settings sub-menu items.
Run "Adminer" tool via Run Adminer page.
Save connections which want to use regularly on Connections page.
Global plugin settings are configured on Settings page.
Admin Area - Page - Run Adminer
This page is used to start "Adminer" database management tool. It will be connected to database which is selected in "Connection" drop-down.
"Connection" drop-down contains all connections which are defined on Connections page, "- WordPress database -" option is used if want to connect to WordPress database and "- Custom parameters -" option is used to enter connection parameters manually.
After choose the connection click "Run Adminer in modal window" button (the application will be opened into a popup) or "Run Adminer in a new window" (it will be loaded into a new browser's window).
More information how to use "Adminer" can be found on Adminer official page.
Admin Area - Page - Connections
If you need to connect to some databases regularly, it is possible to save connection parameters for these databases on this page and don't enter them each time.
Use "Add New" button to enter connection parameters and save them. If you want to test connection before saving, use "Test connection" button in "Connection settings" popup.
Admin Area - Page - Settings
Global plugin settings are configured on this page.
Click "Save Changes" button at the bottom of the page to save changes after configuration all options.
This page is available for users with granted manage_options permission if multisite mode is disabled in WordPress and only for super-administrators in multisite mode.
See description of each parameter below:
Parameter | Description |
---|---|
Adminer theme | The selected theme will be used in "Adminer" application. |
Mode | Two modes are supported: Advanced and Simple. All features for managing databases are available in advanced mode. Adminer Editor tool is used in simple mode , it provides limited functionality with user-friendly database data editing. Provides high-level data manipulation and suitable for common users. |
Stop "Adminer" on logout | If the parameter is enabled, all "Adminer" sessions will be terminated when a user is logged out from WordPress otherwise user can use opened "Adminer" instances even after log out from WordPress. |
Roles | Use it to specify user roles for what the plugin will be available. |
Other references
This section described topics which are not covered in other sections of this documentation. How to create translation, themes and etc.
Translations
The extension is fully translatable. Loco Translate WordPress extension can be used to create new translations.
Open "Loco Translate → Plugins" from admin menu and select "ARI Adminer" plugin to edit existing or create a new translation.
If you prefer to create translations on your local machine then POEdit application can be used. It is a free and available for different platforms.
Use [wordpress_folder]/wp-content/plugins/ari-adminer/languages/ari-adminer.pot language template file.
Language file should have ari-adminer-LANGUAGECODE name. For example en_US language code is used for "English (United States)" language and language file for this language should have ari-adminer-en_US name.
"Adminer" tool is used own translations.
Themes
Themes are used to change design of "Adminer" application. The plugin contains 20+ themes by default. The active theme can be selected in "Adminer theme" drop-down on settings page.
If want to add your own theme, create a sub-folder in [wordpress_folder]/wp-content/plugins/ari-adminer/assets/themes folder and place adminer.css file to it. Styles from this file will be used by "Adminer". The new theme will be available in "Adminer theme" drop-down on settings page.