andreyzb / wp-php-console

:pager: Implementation of PHP Console for WordPress.

WP PHP Console

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 and PHP Console server library.

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.

Installation

Note: you will at least PHP 5.6.0 or above installed on your machine or server to run this plugin.

1. First, install Google Chrome extension PHP Console from the Chrome WebStore. Make sure the PHP Console Chrome extension is enabled through chrome://extensions/.

   Important Note

   If the Google Chrome extension is not available on the Chrome Web Store, you can manually install it from source.

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).

• Downloading a copy from WordPress.org and uploading it in wp-php-console directory into your wp-content/plugins/ directory or corresponding plugins directory in your installation. You can also do this from the WordPress plugins installation admim dashboard pages.

• Note: If you decide to git clone this repository instead, you will need composer install to install its dependencies first, or it won't work in WordPress as it is.

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 (see inline instructions or read below).

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.