1. Home
  2. Language Guides
  3. PHP
  4. Crash Reporting
  5. WordPress

WordPress

Our Raygun for WordPress plugin allows you to easily set up Crash Reporting and Real User Monitoring on WordPress sites without having to write a single line of code.

This plugin utilizes lower-level Raygun providers:

  • Raygun4PHP is used to track server-side errors and exceptions.
  • Raygun4JS tracks errors and monitors user performance on the client-side.
Client-side Documentation

Further documentation on the JavaScript component can be found in JavaScript/WordPress.

Step 1 - Install and activate the Raygun plugin

Note: The server that your WordPress site runs on requires a PHP 7.4 or newer environment. This also requires that your WordPress version be at least 5.3.

Browse to your WordPress admin panel, click on "Plugins", "Add New", then type Raygun in the search box. Click "Install Now", then "Activate".

Alternatively, you can view and download Raygun from the official WordPress plugin repository.

Step 2 - Configure and enable Raygun

  • Go to the Raygun Settings page in your WordPress admin panel.
  • Paste your Raygun API key into the API key field.
    • API Key | paste_your_api_key_here
  • Enable Crash Reporting. Make any additional configurations as needed. You may also send a test error to verify functionality.

Tip: Setting the serverside sending method to asynchronous should yeild a significant performance increase.

Once this is complete, click Save Changes.

Additionally, you can enable server-side error tracking to gain visibility into PHP errors affecting your site.
Enable client-side error tracking to automatically track JavaScript errors that occur in your user's browsers.

Step 3 - Release

Deploy Raygun into your production environment for best results, or raise a test exception. Once we detect your first error event, the Raygun app will automatically update.

Enable server-side error tracking to gain visibility into PHP errors affecting your site. Enable client-side error tracking to automatically track JavaScript errors that occur in your user's browsers.

Include the currently logged in user's details (email address, first name, and last name) with each crash report or RUM session. This information will be visible in your Raygun dashboard. If this feature is not enabled, a random ID will always be assigned to each user.

note: If a user is not logged in, no user information will be sent. A random ID will be assigned instead.

The string properties of a User have a maximum length of 255 characters. Users with fields that exceed this amount will not be processed.

Tags are custom text transmitted with errors that allow for easy identification. JavaScript and PHP errors can be tagged independently through comma-delimited lists on the plugin settings page.

tip: For example, a developer might want to tag JavaScript errors with client-side and PHP errors with server-side.

As of version 2.0.0, asynchronous sending is avaliable on both Unix and Windows based systems. Enabling async sending should yeild a significant performance increase.

note: As of version 2.0.0, errors that fail to send to Raygun will be logged to the standard WordPress log file (WP_CONTENT_DIR/debug.log).

The provider is open source and available at the Raygun4WordPress repository.

On this page: