Pop PHP
Documentation

Here's how it works.

Guides, generated API reference, release notes and coverage reports — for the current version and the legacy versions that came before it.

Read the documentation

The current handbook for Pop PHP. Everything from your first route to shipping a real application, in plain language with code samples you can copy & paste.

docs.popphp.org

Browse the API

Every class, method and signature in the framework and its components, generated straight from the source for the 7.x release.

api.popphp.org/7.x
Guides

Prose documentation — install it, configure it, route it, run it.

Pop PHP Documentation docs.popphp.org The current handbook for v7. Start at the top and work down — application structure, routing, controllers, views, databases and the rest of the toolkit. Current Pop PHP v6 Documentation docs.popphp.org/6.x The v6 handbook, kept online for applications still running on v6. Legacy Documentation Archive pop-php-framework.readthedocs.io The original manual hosted on Read the Docs. Older still, and left up for anyone maintaining a long-lived project. Legacy
API Reference

Generated from the source. Every namespace, class, method and signature in the framework and its components.

API Docs 7.x api.popphp.org/7.x The reference for the current v7 release. Look here when you need the exact signature rather than the explanation. Current API Docs 6.x api.popphp.org/6.x The generated reference for v6. Legacy API Docs 5.x api.popphp.org/5.x The generated reference for the v5. Legacy
Releases & Upgrading

What changed, what is new, and what will possibly break when migrating from v6.

Changelog github.com — CHANGELOG.md The release-level record of every change that landed in v7. New in v7 github.com — NEW-FEATURES.md The additions worth knowing about — the features that were not there before. BC Breaks from v6 to v7 github.com — BC-BREAKS.md Read this one first if you are upgrading. Everything that changed in a way your existing code will notice.
Test Coverage

The framework and every component are covered by their own PHPUnit suites. The reports are public.

Code Coverage Reports cc.popphp.org Line-by-line coverage for the framework and each component, so you can see exactly what the test suites touch.
Coming from v6?

Know what moved before you move.

Version 7 adds a significant set of new functionality and interoperability across the framework and its components, so you can do even more with Pop than ever before. Some of that meant changing things. The BC breaks are all written down, so nothing surprises you mid-upgrade.

BC Breaks from v6 to v7 BC-BREAKS.md New in v7 NEW-FEATURES.md Changelog CHANGELOG.md

Still have a question?

Every component keeps its own README and examples alongside the code. If the answer is not in the docs or the README files, feel free to open an issue.

Get started Open an issue