Documentation
phpBB Modifications Documentation
Copyright © 2007 phpBB Modifications Team
Abstract
The guide for writing good phpBB Modifications. Includes information for phpBB2.0 and phpBB3.0 modifications. Sections titled phpBB3.0 are for phpBB3.0 only, and same for phpBB2.0.
Table of Contents
- 1. Coding with and for phpBB3.0
- 1.1. Using the phpBB3.0 Language System
- 1.2. Using the phpBB3.0 Template System
- 1.3. Using the phpBB3.0 DBAL
- 1.4. Using phpBB3's Basic Functions
- 1.4.1. User input
- 1.4.2. Preserving sessions
- 1.4.3. Redirecting users
- 1.4.4. The User Class
- 1.4.5. Validating input
- 1.4.6. Checking authorisation
- 1.4.7. Inserting Posts and Private Messages
- 1.4.8. Building URLs, hidden fields and other HTML
- 1.4.9. Errors
- 1.4.10. Log In
- 1.4.11. Confirm Box
- 1.4.12. Page Header and Footer
- 1.4.13. Bringing it all together: A Sample Page
- 1.5. Using the phpBB3.0 Module System
- 2. Appendicies
- 2.1. The Modifications Text Template
- 2.1.1. Basic Template
- 2.1.2. Header
- 2.1.3. Actions
- 2.1.3.1. Action definition
- 2.1.3.2. The SQL Action
- 2.1.3.3. The COPY Action
- 2.1.3.4. The DIY INSTRUCTIONS Action
- 2.1.3.5. The OPEN Action
- 2.1.3.6. The FIND Action
- 2.1.3.7. The REPLACE WITH Action
- 2.1.3.8. The AFTER, ADD Action
- 2.1.3.9. The BEFORE, ADD Action
- 2.1.3.10. The INCREMENT Action
- 2.1.3.11. The IN-LINE FIND Action
- 2.1.3.12. The IN-LINE AFTER, ADD Action
- 2.1.3.13. The IN-LINE BEFORE, ADD Action
- 2.1.3.14. The IN-LINE REPLACE WITH Action
- 2.1.3.15. Conclusion
- 2.1.3.16. Concluding a MOD Text Template file
List of Examples
- 1.1. A sample to initialise the connection without using config.php (don't do that at home)
- 1.2. An example to initialise the connection with config.php
- 1.3. An example for selecting data from the database.
- 1.4. An example for using sql_query_limit
- 1.5. Using sql_build_array
- 1.6. Example API submit_post()
- 1.7. Example confirm box
- 1.8. A sample info file
- 2.1. Example usage of title.
- 2.2. Examples of allowed usage
- 2.3. Examples of wrong usage.
- 2.4. Example Multiple MOD Author usage
- 2.5. Example SQL action usage
- 2.6. Another example SQL action usage
- 2.7. Example COPY action usage
- 2.8. Example DIY INSTRUCTIONS action usage
- 2.9. Example OPEN action usage
- 2.10. Example FIND action usages
- 2.11. Example partial FIND action usages
- 2.12. Example REPLACE WITH action usage
- 2.13. Example AFTER, ADD action usage
- 2.14. Example BEFORE, ADD action usage
- 2.15. Example INCREMENT action usage
- 2.16. Other example INCREMENT action usages
- 2.17. Example IN-LINE FIND action usage
- 2.18. Example IN-LINE AFTER, ADD action usage
- 2.19. Example IN-LINE BEFORE, ADD action usage
- 2.20. Example IN-LINE REPLACE WITH action usage
- 2.21. How to end a text template example
© 2006 phpBB Group — Licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 2.0 license
