README

Yii 2 is a modern framework designed to be a solid foundation for your PHP application.

It is fast, secure and efficient and works right out of the box pre-configured with reasonable defaults. The framework is easy to adjust to meet your needs, because Yii has been designed to be flexible.

Installation

• The minimum required PHP version of Yii is PHP 7.3.
• It works best with PHP 8.
• Follow the Definitive Guide in order to get step by step instructions.

Documentation

• A Definitive Guide and a Class Reference cover every detail of the framework.
• There is a PDF version of the Definitive Guide and a Definitive Guide Mirror which is updated every 15 minutes.
• For Yii 1.1 users, there is Upgrading from Yii 1.1 to get an idea of what has changed in 2.0.

Versions & PHP compatibility

¹ All mentioned dates may be subject to change and no rights can be derived from them.
² Note: Yii 2.1 was skipped, Yii 2.2 has not yet been released.
³ PHP 8.3 EOL date.
⁴ Expected PHP 8.4 EOL date.

Community

• Participate in discussions at forums.
• Community Slack and Chat in IRC.
• Follow us on Facebook, Twitter and GitHub.
• Check other communities.

Contributing

The framework is Open Source powered by an excellent community.

You may join us and:

• Report an issue
• Translate documentation or messages
• Give us feedback or start a design discussion
• Contribute to the core code or fix bugs
• Become a sponsor

Reporting Security issues

Please refer to a special page at the website describing proper workflow for security issue reports.

Directory Structure

build/               internally used build tools
docs/                documentation
framework/           core framework code
tests/               tests of the core framework code

Spreading the Word

Acknowledging or citing Yii 2 is as important as direct contributions.

In presentations

If you are giving a presentation or talk featuring work that makes use of Yii 2 and would like to acknowledge it, we suggest using our logo on your title slide.

In projects

If you are using Yii 2 as part of an OpenSource project, a way to acknowledge it is to use a special badge in your README:

If your code is hosted at GitHub, you can place the following in your README.md file to get the badge:

[![Yii2](https://img.shields.io/badge/Powered_by-Yii_Framework-green.svg?style=flat)](https://www.yiiframework.com/)

Sponsoring

Support this project by becoming a sponsor or a backer.