https://github.com/nielsdeblaauw/query-monitor-twig-profile

Displays Twig profiler output in Query Monitor
https://github.com/nielsdeblaauw/query-monitor-twig-profile

hacktoberfest performance performance-analysis plugin query-monitor timber timber-library twig twig-profile wordpress wordpress-development wordpress-plugin

Last synced: about 2 months ago
JSON representation

Displays Twig profiler output in Query Monitor

• Host: GitHub
• URL: https://github.com/nielsdeblaauw/query-monitor-twig-profile
• Owner: NielsdeBlaauw
• License: mit
• Created: 2020-09-14T19:08:48.000Z (over 4 years ago)
• Default Branch: stable
• Last Pushed: 2023-02-24T01:12:07.000Z (almost 2 years ago)
• Last Synced: 2024-11-07T20:04:41.305Z (about 2 months ago)
• Topics: hacktoberfest, performance, performance-analysis, plugin, query-monitor, timber, timber-library, twig, twig-profile, wordpress, wordpress-development, wordpress-plugin
• Language: PHP
• Homepage:
• Size: 2.55 MB
• Stars: 29
• Watchers: 2
• Forks: 4
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Query monitor Twig profile

[![CI](https://github.com/NielsdeBlaauw/query-monitor-twig-profile/workflows/Test/badge.svg)](https://github.com/NielsdeBlaauw/query-monitor-twig-profile/actions)

[![WordPress Plugin Version](https://img.shields.io/wordpress/plugin/v/query-monitor-twig-profile)](https://wordpress.org/plugins/query-monitor-twig-profile/)

[![Query Monitor](https://img.shields.io/badge/Query%20Monitor-add--on-31C653)](https://github.com/johnbillion/query-monitor)

**Query Monitor Twig profile is available in the [WordPress plugin repository](https://wordpress.org/plugins/query-monitor-twig-profile/)**.

Displays [Twig](https://twig.symfony.com/) profiler output in [Query Monitor](https://github.com/johnbillion/query-monitor).

Automatically works with [Timber](https://github.com/timber/timber).

![Screenshot showing the Twig Profile panel for Query Monitor](.wordpress-org/screenshot-1.png)

![Screenshot showing the Twig Profile panel for Query Monitor (dark mode)](.wordpress-org/screenshot-2.png)

## Description

Find out which pages are slow, and why! Immediately see profiling information from Twig in your Query Monitor toolbar.

Automatically integrates with Timber.

- Support for dark mode.

- Clickable links to profiled templates in your preferred editor.

- Downloadable blackfire.io profiles.

- History mode. Save profiles so you can see the impact of your changes.

## Installation

1. Install the plugin

2. Activate it

3. Check the 'Twig profile' tab in Query Monitor

4. Optimize your site

## Frequently Asked Questions

### Can I use it with other frameworks that use Twig?

Definitely. Just add a Twig profiler extension to your Twig instance and submit it to the collector.

```php

if ( function_exists( 'NdB\QM_Twig_Profile\collect' ) ) {

	$twig = \NdB\QM_Twig_Profile\collect( $twig );

}

```

## Development

Test the GitHub Actions workflow with [act](https://github.com/nektos/act):

See the documentation for the [setup-php action](https://github.com/marketplace/actions/setup-php-action#local-testing-setup)

```shell

./bin/act pull_request -P ubuntu-latest=shivammathur/node:latest

```