=== WP PHP Console ===
Contributors: nekojira
Donate link: http://iheu.org/support/make-a-donation/
Tags: dev, development, bug, debug, debugging, stacktrace, php, console, terminal, browser
Requires at least: 3.6.0
Tested up to: 4.9
Stable tag: 1.5.1
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

An implementation of PHP Console as a WordPress plugin.
Use Chrome Dev Tools to debug your WordPress installation!

== Description ==

> PHP Console allows you to handle PHP errors & exceptions, dump variables, execute PHP code remotely and many other things using [Google Chrome extension PHP Console](https://chrome.google.com/webstore/detail/php-console/nfhmhhlpfleoednkpnnnkolmclajemef) and [PHP Console server library](https://github.com/barbushin/php-console).

This implementation of PHP Console is a handy tool to make it easier to test on the fly any WordPress specific function or class (including those introduced by your active theme and plugins!) from a terminal and inspect results, catch errors and warnings with complete call stack trace straight from the Chrome JavaScript console. In other words, besides debugging, you can execute PHP or WordPress-specific PHP code straight from the terminal and print PHP variables in Chrome Dev Tools JavaScript console along with your normal JavaScript debugging and testing. Keep everything in one place, without leaving the browser to check for your logs or writing temporary PHP test code on a PHP file and refresh your browser page.

Note: PHP version 5.4.0 or above is required to use this plugin.

For support and pull requests, please refer to [WP PHP Console GitHub repo](https://github.com/unfulvio/wp-php-console) and read the instructions there - thank you.


== Installation ==

1. First, install [Google Chrome extension PHP Console](https://chrome.google.com/webstore/detail/php-console/nfhmhhlpfleoednkpnnnkolmclajemef) from the [Chrome WebStore](https://chrome.google.com/webstore/search/php%20console?_category=extensions).
Make sure the PHP Console Chrome extension is enabled through [chrome://extensions/](chrome://extensions/ "chrome://extensions/").

2. Then, add this plugin to your WordPress installation either by:

  - Installing it as any other WordPress plugin from your WordPress admin Plugins page (`Add New`)

  - Uploading it in `wp-php-console` directory into your `wp-content/plugins/` directory or corresponding plugins directory in your installation

3. Activate the plugin through the `Plugins` admin page in WordPress

4. In the `Settings` menu go to `WP PHP Console`:

  - Enter a password for the Eval Terminal (this setting is needed or the terminal feature simply won't work).

  - You can also set other options.

= Options =

**Allow only on SSL**
Forces PHP Console to connect on a SSL connection only (of course then if you don't actually have SSL (https), PHP Console simply won't work).

**Allowed IP Masks**
You can secure your server by specifying IP addresses to restrict the accessibility from the Eval Terminal (a single address eg. `192.168.0.4` or an address mask eg. `192.168.*.*` or multiple IPs, comma separated `192.168.1.22,192.168.1.24,192.168.3.*`). In case of having issues connecting with the Remote PHP Eval Terminal, try leaving this blank.

**Register PC Class**
Tick this option to register `PC` in the global PHP namespace. This allows to write `PC::debug($var, $tag)` or `PC::magic_tag($var)` instructions in PHP to inspect `$var` in the JavaScript console.

**Show Call Stack**
Tick this option to see the call stack when PHP Console server writes to the JavaScript console.

**Short Path Names**
Tick this checkbox to shorten PHP Console error sources and traces paths in the JavaScript console. E.g. paths like `/server/path/to/document/root/WP/wp-admin/admin.php:38` will be displayed as `/WP/wp-admin/admin.php:38`

== Usage ==

After you entered WP PHP Plugin password, your browser address bar should show a yellow "key" icon, which, if clicked, will prompt for the password you have set earlier.
The "key" icon will change into a "terminal" icon, click on it to open the PHP Console eval & options form.

After entering the correct password, you can use the Eval Terminal in the PHP Console eval & options form and run any PHP code from it, including WordPress's own functions: enter one or more lines of PHP code in the black Eval terminal screen, press Ctrl+Enter and see the result in Chrome Dev Tools JavaScript console.
The result includes the output, the return value and the net server execution time.

In your PHP code on the Server, you can call PHP Console debug statements like `PC::debug( $var, $tag )` to display PHP variables in the JavaScript console and optionally filter selected tags through the PHP Console eval & options form opened from the address bar in your browser.

In the JavaScript console you will see printed any `PC::debug()`` information, PHP errors, warnings, notices with optional stack trace, which will be useful to debug your plugin or theme.

== Frequently Asked Questions ==

= Is this an official plugin from PHP Console author? =

No, but it makes use of Sergey's PHP Console library as it is.

= Does it work with Firefox, IE, Opera or other browsers? =

No it doesn't, unless PHP Console browser extension is ported, for example, as a Firefox add-on.

= Can I use PHP Console in a live production environment? =

You *can* but it is probably not a good idea. You should do your debugging and testing on a development/testing environment on a staging server or local machine. Likewise, you normally wouldn't want to turn on PHP error reporting or set WP_DEBUG to true in a live site as you wouldn't want to display error information to public. Furthermore, PHP Console allows execution of any remote PHP code through terminal - for this you can set a strong password and restrict the IP address range to access the terminal, but still it's not advisable. Besides putting your site at risk, you will also add more load to your server.

= Will there be items logged in my debug.log files when a PHP error occurs? =

Generally no, WP PHP Console will intercept those. However, it's always a good idea to keep an eye on the logs too. Furthermore, WP PHP Console is unable to catch many server errors that result in a 500 error code on the browser. For those you may have traces left in the debug.log file.

= Why are PHP arrays shown as objects? =

The JavaScript console prints PHP variables as JavaScript variables. Associative PHP arrays such as `['key1' => 'var2', 'key2' => 'var2', ... ]` are shown as objects; automatically indexed arrays like `[ 'var1', 'var2', ... ]` are shown as arrays.

= Fatal error: Class 'PC' not found in 'my code' =

`PC::debug( $my_var, $my_tag )` can only be called after the WordPress core included the WP PHP Console plugin.

You could move your debug code or either do something like

`
  // delay use of PC class until WP PHP Console plugin is included
  add_action( 'plugins_loaded', function () use ( $my_var ) {
    // send $my_var with tag 'my_tag' to the JavaScript console through PHP Console Server Library and PHP Console Chrome Plugin
    PC::my_tag( $my_var );
  });
`

or

`
  // PHP Console autoload
  require_once dirname( __FILE__ ) . '/wp-php-console/vendor/autoload.php';

  // make PC class available in global PHP scope
  if ( ! class_exists( 'PC', false ) ) PhpConsole\Helper::register();

  // send $my_var with tag 'my_tag' to the JavaScript console through PHP Console Server Library and PHP Console Chrome Plugin
  PC::my_tag( $my_var );

`

== Screenshots ==

None.


== Changelog ==

= 1.5.1 =
* Misc: Bump WordPress compatibility to mark support for the latest versions

= 1.5.0 =
* Fix: Fixes "PHP Warning: session_start(): Cannot send session cache limiter - headers already sent" notice in logs
* Misc: Internal changes, new Settings class, deprecated methods and properties in main Plugin class
* Misc: Updated PHP Console Library to 3.1.6
* Misc: Tested up to WordPress 4.5.2

= 1.4.0 =
* Enhancement: Support for WordPress language packs
* Misc: Improved error and exception handling and usage of Composer in plugin development
* Misc: Updated PHP Console Library to 3.1.5
* Misc: Tested up to WordPress 4.4.1

= 1.3.9 =
* Misc: Use WP Requirements as Composer dependency.

= 1.3.8 =
* Misc: Internal changes (alternate PHP version check, automated SVN deploys)

= 1.3.7 =
* Fix: Fixes a bug `Cannot send session cache limiter - headers already sent`
* Misc: Updated PHP Console Library to 3.1.4

= 1.3.5 =
* Misc: Made PHP 5.4.0 the minimum required version to activate the plugin
* Misc: Updated PHP Console library to 3.1.3

= 1.3.3 =
* Misc: Supports WordPress 4.2

= 1.3.2 =
* Fix: Fixes "Fatal error: Using $this when not in object context" upon activation in some installations.

= 1.3.1 =
* Enhancement: earlier PC initialisation - props @Polfo
* Misc: Updated readme files

= 1.3.0 =
* Fix: IP mask
* Enhancement: added configuration options - props @Polfo
  - Register PC class
  - Show Call Stack
  - Short Path Names

= 1.2.3 =
* Fix: Fixes "Wrong PHP Console eval request signature" error when executing WordPress code from terminal, props @Polfo @barbushin

= 1.2.2 =
* Fix: Bugfixes
* Misc: Submission to WordPress.org plugins repository.

= 1.2.1 =
* Fix: Fixed allowed IPs bug.

= 1.2.0 =
* Misc: Updated dependencies and got rid of git submodules.

= 1.1.0 =
* Fix: PHP Console server is now instantiated later, allowing to catch all your theme functions too.
* Misc: Included PHP Console server library as git submodule rather than a composer dependency.

= 1.0.0 =
* First public release.


== Upgrade Notice ==

= 1.5.0 =
* If you were extending or using public methods and properties of the plugin main class, you may have to do some changes in your code.

= 1.4.0 =
* If you were installing this plugin by downloading a zip directly from the GitHub repository, please be sure to run `composer install --no-dev` and then `composer dump-autoload --optimize --no-dev` first, or use the bundled grunt task `grunt build` to generate a working copy of the plugin (if using grunt, run `npm install` first).

= 1.3.7 =
* To improve compatibility with other plugins, now stores session data in a file.
* You need to be able to write inside WP PHP Console plugin dir for better compatibility.

= 1.3.5 =
* PHP 5.4.0 is the minimum PHP required version to run this plugin.

= 1.0.0 =
* First public release.
