{"id":20310141,"url":"https://github.com/phpro/phpro-mage2-module-bypass-page-cache","last_synced_at":"2025-07-11T13:05:05.275Z","repository":{"id":40370743,"uuid":"267868041","full_name":"phpro/phpro-mage2-module-bypass-page-cache","owner":"phpro","description":"Module to bypass to fullpage cache","archived":false,"fork":false,"pushed_at":"2022-05-12T09:10:22.000Z","size":15,"stargazers_count":1,"open_issues_count":1,"forks_count":2,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-11T15:56:31.347Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/phpro.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-05-29T13:43:50.000Z","updated_at":"2022-05-12T09:09:30.000Z","dependencies_parsed_at":"2022-08-09T18:42:05.269Z","dependency_job_id":null,"html_url":"https://github.com/phpro/phpro-mage2-module-bypass-page-cache","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/phpro/phpro-mage2-module-bypass-page-cache","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phpro%2Fphpro-mage2-module-bypass-page-cache","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phpro%2Fphpro-mage2-module-bypass-page-cache/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phpro%2Fphpro-mage2-module-bypass-page-cache/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phpro%2Fphpro-mage2-module-bypass-page-cache/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/phpro","download_url":"https://codeload.github.com/phpro/phpro-mage2-module-bypass-page-cache/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phpro%2Fphpro-mage2-module-bypass-page-cache/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264815606,"owners_count":23667977,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-14T17:30:07.863Z","updated_at":"2025-07-11T13:05:05.233Z","avatar_url":"https://github.com/phpro.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"![](https://github.com/phpro/phpro-mage2-module-bypass-page-cache/workflows/.github/workflows/grumphp.yml/badge.svg)\n\n# Bypass Page Cache for Magento 2\n\nIn some cases we want to be able to bypass Magento's full page cache. For example, when profiling a page using Blackfire, we want to test the performance of the page without full page cache.\n\n## Installation\n\n`composer require phpro/mage2-module-bypass-page-cache`\n\n## Key features\n\n### Configuration\n\nTo use this feature, you have to activate it in the backend \n`Stores \u003e Configuration \u003e Advanced \u003e System \u003e Full Page Cache \u003e Enable Full Page Cache Bypass`\n\nThis setting is only available when you use the Built-in Cache. This feature is not relevant when you use Varnish. \n\nNote: this is meant to be used on development and staging environments. Make sure this is disabled in production. \n\n### Blackfire\n\nThis module was built to be used with Blackfire.\n\nWhen creating profiles in Blackfire, you need to be able to bypass the full page cache. Magento 2 does not provide an\neasy way to bypass the full page cache, so we created this module. \n\nBlackfire adds the header `X-Blackfire-Query` when profiling over HTTP. When this header exists your request, the full\npage cache will be ignored.\n\n### Custom header\n\nThe module is created to work with the Blackfire header by default. If you want to use this feature, but need a \ndifferent header, you can override the default configuration.\n\nAdd the following in the file `config.xml` of a project module.\n\n    \u003cdefault\u003e\n        \u003csystem\u003e\n            \u003cfull_page_cache\u003e\n                \u003cbypass_header\u003eMy-Custom-Header\u003c/bypass_header\u003e\n            \u003c/full_page_cache\u003e\n        \u003c/system\u003e\n    \u003c/default\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphpro%2Fphpro-mage2-module-bypass-page-cache","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fphpro%2Fphpro-mage2-module-bypass-page-cache","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphpro%2Fphpro-mage2-module-bypass-page-cache/lists"}