You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: development/development/upgrade.rst
+4-6Lines changed: 4 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,13 +2,11 @@
2
2
Upgrade Guide
3
3
=============
4
4
5
-
This document outlines changes introduced in different versions of phpBB. These changes may require adjustments to your
6
-
existing custom PHP code or Extension code when upgrading to specific versions from a prior versions of phpBB.
7
-
It is mainly meant to be used by core and Extension developers and does not provide end user documentation for upgrading.
5
+
This guide summarizes code-level changes introduced in various phpBB versions that may require updates to your custom PHP code, extensions, or styles during an upgrade.
8
6
9
-
Unless explicitly stated otherwise, each version describes the changes compared to the previous major or minor version
10
-
that directly preceded it. For example the upgrade guide for 4.0 will describe the changes compared to 3.3 whereas an upgrade guide
11
-
for 4.1 will describe the changes compared to 4.0.
7
+
It is intended primarily for core developers, extension authors, and style creators. **It does not cover instructions for end users performing a board upgrade.**
8
+
9
+
Unless otherwise noted, each upgrade entry documents changes relative to the immediately preceding major or minor release.
Copy file name to clipboardExpand all lines: development/development/upgrade/400.rst
+23-15Lines changed: 23 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,8 @@
2
2
phpBB 3.3 to 4.0
3
3
================
4
4
5
-
phpBB 4.0 is a major release that contains backward compatibility breaks and also introduces some deprecations.
5
+
phpBB 4.0 is a major release that includes backward-incompatible changes and new deprecations.
6
+
This guide highlights the most important changes and resources to help extension and style developers adapt their code.
6
7
7
8
.. contents:: Table of Contents
8
9
:depth: 2
@@ -14,42 +15,49 @@ Basics
14
15
15
16
PHP
16
17
---
17
-
The minimum required version of PHP for phpBB 4.0 is ``8.1`` with full support for versions ``8.2`` and ``8.3``.
18
-
PHP code that worked with the supported versions of phpBB 3.3 should work with phpBB 4.0 as well but might require minor adjustments.Recommendation
18
+
phpBB 4.0 requires PHP 8.1 or higher. Most PHP code compatible with phpBB 3.3 should work in phpBB 4.0 with minimal changes,
19
+
but you may need to make adjustments depending on deprecated or changed functionality.
19
20
20
21
Symfony
21
22
-------
22
-
phpBB 4.0 ships with Symfony 6.4. There are quite a few changes to the standard Symfony version that came with phpBB 3.3.
23
-
The following upgrade guides provides by Symfony might help with resolving some of the issues you might encounter when upgrading
24
-
custom PHP or Extension code for phpBB 4.0:
23
+
phpBB 4.0 uses Symfony 6.4, a significant upgrade from the version bundled with phpBB 3.3. As Symfony introduced breaking
24
+
changes across versions, we recommend reviewing the following Symfony upgrade guides when updating custom code or extensions:
25
25
26
26
- `Upgrade Symfony from 3.x to 4.0 <https://github.com/symfony/symfony/blob/4.4/UPGRADE-4.0.md>`_
27
27
- `Upgrade Symfony from 4.4 to 5.0 <https://github.com/symfony/symfony/blob/5.4/UPGRADE-5.0.md>`_
28
28
- `Upgrade Symfony from 5.x to 6.0 <https://github.com/symfony/symfony/blob/6.4/UPGRADE-6.0.md>`_
29
29
30
-
You can find more upgrade guides in the `Symfony Repository <https://github.com/symfony/symfony/tree/6.4>`_ on GitHub.
30
+
Additional guides are available in the `Symfony GitHub repository <https://github.com/symfony/symfony/tree/6.4>`_.
31
31
32
32
Major changes
33
33
=============
34
34
35
35
Ban system
36
36
----------
37
-
The ban system has been greatly refactored for phpBB 4.0. As part of this, the following changes were introduced:
37
+
The ban system has been significantly refactored in phpBB 4.0. Key changes include:
38
38
39
-
- Added support for banning `CIDR blocks<https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_blocks>`_
40
-
- Added support for IPv6 banning
41
-
- Removed "exclude" functionality which resulted in ambiguous settings
39
+
- `CIDR block<https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_blocks>`_ support for banning IP ranges.
40
+
- IPv6 banning is now supported.
41
+
- “Exclude” functionality has been removed due to ambiguity and inconsistent behavior.
42
42
43
43
Removal of Jabber/XMPP
44
44
----------------------
45
-
The Jabber/XMPP functionality has been removed from phpBB 4.0. This includes the Jabber/XMPP settings in the ACP and the Jabber/XMPP notification system.
46
-
Users with Jabber/XMPP accounts will no longer receive notifications via Jabber/XMPP and have instead been migrated to email notifications.
47
-
The Jabber/XMPP functionality was removed due to the lack of support for the XMPP protocol in modern browsers and the fact that it was not widely used by phpBB users.
45
+
All Jabber/XMPP features have been removed in phpBB 4.0:
46
+
47
+
- Jabber/XMPP settings in the ACP are gone.
48
+
- XMPP-based notifications have been discontinued.
49
+
- Users who previously used Jabber/XMPP will now receive notifications via email.
50
+
51
+
This removal was driven by lack of browser support for XMPP and limited adoption within the phpBB community.
48
52
49
53
Class and function changes
50
54
==========================
55
+
Several classes and functions have been changed or removed. If your extension or code uses phpBB internals, you’ll want to:
56
+
57
+
- Review the updated `phpBB 4.0 API documentation <https://area51.phpbb.com/docs/code/master/>`_
58
+
- Audit your code for usages of deprecated or removed methods/classes
59
+
51
60
The following table lists class and function changes that might affect custom PHP or Extension code.
52
-
Also have a look at the `phpBB API documentation <https://area51.phpbb.com/docs/code/master/>`_ for further insight into the class and function API in phpBB 4.0.
0 commit comments