Debugging in PhpStorm Using Zend Server

To create a new project in PhpStorm:

1. Open PhpStorm.
2. In the menu-bar, select File | New Project from Existing Files.
   The Choose Your Scenario dialog is displayed.

3. Select the first option, and click Next.
   The Choose Project Directory dialog is displayed.
   

4. Browse to the WordPress folder in the root directory of your Web server, and click Project Root.
5. Click Next.
   The Specify Local Server dialog is displayed.

6. Select Use existing server, and click Next.
   The Specify Web Path dialog is displayed.

7. Leave the default project web path, and click Finish.
   The new project is created in PhpStorm.

8. To run the application in our browser, right-click the project's 'index.php' file, select Open in Browser, and select your preferred browser.
   The WordPress application is launched.
   As soon and the page loads, Z-Ray is displayed at the bottom of the page.

Can't see Z-Ray?

Make sure Z-Ray is enabled from the Configurations | Z-Ray page in the Zend Server UI. For more information, see Enabling/Disabling Z-Ray.

If you still can’t see Z-Ray, there may be a connectivity issue. For more information, see Troubleshooting Connectivity Issues.

To configure PhpStorm:

1. In the menu-bar, select File | Settings.
2. Under the Project Settings, go to PHP | Debug.

3. In the Zend Debugger section, verify the following:
   • Debug Port - 10137
   • Settings broadcast port - 20080
   • Can accept external connections - selected
4. Click OK.
5. In the top-right corner of the IDE, click the listen to debug connections icon .
   PhpStorm is now ready to receive incoming debugging connection from Zend Server and Z-Ray.

To insert example code:

1. In PhpStorm, open the 'general-template.php' file located in the 'wp-includes' folder.
2. Insert the following changes to lines 1-47 in your code (changes are marked in red):

/**
* General template tags that can go anywhere in a template.
*
* @package WordPress
* @subpackage Template
*/
function getFilePath() {
	return null;
}
 
/**
* Load header template.
*
* Includes the header template for a theme or if a name is specified then a
* specialised header will be included.
*
* For the parameter, if the file is called "header-special.php" then specify
* "special".
*
* @since 1.5.0
*
* @uses locate_template()
*
* @param string $name The name of the specialised header.
*/
function get_header( $name = null ) {
	/**
	* Fires before the header template file is loaded.
	*
	* The hook allows a specific header template file to be used in place of the
	* default header template file. If your file is called header-new.php,
	* you would specify the filename in the hook as get_header( 'new' ).
	*
	* @since 2.1.0
	* @since 2.8.0 $name parameter added.
	*
	* @param string $name Name of the specific header file to use.
	*/
	do_action( 'get_header', $name );
 
	$templates = array();
	$name = (string) $name;
 
	$filename = getFilePath();
	$file = file_get_contents($filename, true);

3. Save your changes.

To debug/profile your from Z-Ray:

1. In your browser, reload the page.
   As soon and the page loads, Z-Ray indicates that the page has triggered errors and monitor events.
   What is an event?

2. Open the Monitor Events panel.

3. Notice that both the PHP Error and Function Error events are related to the file_get_contents() function.
4. Open the adjacent Warnings and Errors panel.

5. Hover over the file name. Z-Ray pinpoints the exact location in your project causing the error.
6. In PhpStorm, insert a breakpoint on line 47 in the 'general-template.php' file.

7. In Z-Ray, click the Debug icon on the right, and select Debug current page.
   A debugging session is initiated in PhpStorm, pausing on the first line of code.

8. Click the Resume icon in the Debug window.
   Debugging will stop at the defined breakpoint.

9. In the Variables window, PhpStorm tells us that the filename variable is receiving a null value.
10. Continue debugging - remove the breakpoint on line 47, and insert a new one on line 46.
11. Repeat steps 7-8 to debug the application again.
    Debugging stops at the defined breakpoint on line 46.

12. Click the Step Into icon in the Debug window.
    PhpStorm displays the problematic expression in the code.

To profile from Z-Ray:

In Z-Ray, click the Debug icon on the right, and select Profile current page.
A Profiling session is initiated in PhpStorm.