Skip to content
phpBB-ItaliaPublic
forked from phpbb-seo/usu

About

Ultimate phpBB SEO Friendly URL extension

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

 
 

Repository files navigation

Ultimate SEO URL (USU) — Legacy Project

Important

This repository is maintained for existing installations and backward compatibility.

For NEW phpBB installations, do not install USU.

Use the new phpBB SEO Framework instead:
🔗 https://github.com/phpbb-seo/seo-framework

  • Legacy / Maintenance Status: USU remains available as a stable compatibility project for existing websites that depend on its historical URL structure.
  • Existing Installations: Existing USU users should NOT uninstall or attempt automatic migration.
  • New Installations: New phpBB 3.3.x boards should install phpBB SEO Framework, the actively developed next-generation SEO platform.

Successor: phpBB SEO Framework

phpBB SEO Framework is the modern successor to Ultimate SEO URL for new phpBB installations.

Key features of phpBB SEO Framework (Lite Edition):

  • SEO-Friendly Permalinks: Customizable URL pattern templates for forums, topics, members, and usergroups.

  • Persistent Slug Index: Framework-owned persistent slug storage providing fast and deterministic URL resolution without modifying phpBB core tables.

  • Canonical URLs & Automatic 301 Redirects: Seamlessly normalizes legacy native URLs (viewtopic.php?t=123) and historical stale slugs.

  • Titles & Meta Engine: Pattern-driven meta titles and clean plain-text description normalization.

  • Scalable XML Sitemap Suite: Keyset-based streaming architecture with strict Anonymous ACL protection and zero deep SQL offset overhead.

  • Multilingual / Unicode Support: Native UTF-8 slug generation for Persian, Arabic, Cyrillic, Latin, and CJK alphabets.

  • Modern ACP Interface: Responsive administration dashboard with live crawl statistics and preview tools.

  • Zero-SQL append_sid Hot Path: Zero database queries during runtime outbound link rewriting.

  • Official Website: https://www.phpbbseo.ir/

  • GitHub Repository: https://github.com/phpbb-seo/seo-framework

(Note: USU and phpBB SEO Framework use different internal architectures and are not drop-in compatible).


Features (Historical USU)

  • Full SEO-friendly URL rewriting preserving original USU URL patterns
  • Canonical URL generation
  • Automatic duplicate URL detection and 301 redirects
  • Forum, Topic, User, and Search URL rewriting
  • Advanced, Mixed, and Simple rewrite modes
  • High-performance URL caching
  • Compatible with phpBB 3.3.x and PHP 8.4

Compatibility

Component Version
phpBB 3.3.x
PHP 8.4
License GNU General Public License v2.0

Ultimate SEO URL (USU) — Legacy Project

Important

This repository is maintained for existing installations and backward compatibility.

For NEW phpBB installations, do not install USU.

Use the new phpBB SEO Framework instead:
🔗 https://github.com/phpbb-seo/seo-framework

  • Legacy / Maintenance Status: USU remains available as a stable compatibility project for existing websites that depend on its historical URL structure.
  • Existing Installations: Existing USU users should NOT uninstall or attempt automatic migration.
  • New Installations: New phpBB 3.3.x boards should install phpBB SEO Framework, the actively developed next-generation SEO platform.

Successor: phpBB SEO Framework

phpBB SEO Framework is the modern successor to Ultimate SEO URL for new phpBB installations.

Key features of phpBB SEO Framework (Lite Edition):

  • SEO-Friendly Permalinks: Customizable URL pattern templates for forums, topics, members, and usergroups.

  • Persistent Slug Index: Framework-owned persistent slug storage providing fast and deterministic URL resolution without modifying phpBB core tables.

  • Canonical URLs & Automatic 301 Redirects: Seamlessly normalizes legacy native URLs (viewtopic.php?t=123) and historical stale slugs.

  • Titles & Meta Engine: Pattern-driven meta titles and clean plain-text description normalization.

  • Scalable XML Sitemap Suite: Keyset-based streaming architecture with strict Anonymous ACL protection and zero deep SQL offset overhead.

  • Multilingual / Unicode Support: Native UTF-8 slug generation for Persian, Arabic, Cyrillic, Latin, and CJK alphabets.

  • Modern ACP Interface: Responsive administration dashboard with live crawl statistics and preview tools.

  • Zero-SQL append_sid Hot Path: Zero database queries during runtime outbound link rewriting.

  • Official Website: https://www.phpbbseo.ir/

  • GitHub Repository: https://github.com/phpbb-seo/seo-framework

(Note: USU and phpBB SEO Framework use different internal architectures and are not drop-in compatible).


Features (Historical USU)

  • Full SEO-friendly URL rewriting preserving original USU URL patterns
  • Canonical URL generation
  • Automatic duplicate URL detection and 301 redirects
  • Forum, Topic, User, and Search URL rewriting
  • Advanced, Mixed, and Simple rewrite modes
  • High-performance URL caching
  • Compatible with phpBB 3.3.x and PHP 8.4

Compatibility

Component Version
phpBB 3.3.x
PHP 8.4
License GNU General Public License v2.0

🛠️ PHP 8.0 - 8.4 Production Compatibility Patches

This specific branch includes critical production patches optimized to run the v2.0.3 Framework under modern environments (tested on phpBB 3.3.19 and PHP 8.4.27) without triggering white pages, strict type validation errors, or bootstrap container crashes.

The following architectural issues have been fixed:

1. Metadata & ACP Validation Fixes

  • Updated composer.json by adding the mandatory "authors" block and configuring the proper PSR-4 "autoload" namespaces to prevent phpBB Extension Manager from rejecting the package as invalid.

2. Strict Type & TypeError Resolutions (PHP 8.x Type Hinting Mismatches)

  • Fixed multiple mismatched return type definitions inside acp/usu.php (such as set_phpbb_seo_links() and write_cache()) where arrays or booleans were being returned instead of strict strings.
  • Fixed core/core.php read_config() method which was missing a final return true; statement, causing a fatal error under PHP 8.
  • Enforced type-casting via strict integer formatting (int) for database configuration limits (topics_per_page, posts_per_page, forum_id, and topic_id) across listener.php and sync modules to comply with modern PHP 8 strict function signatures.

3. Trait Syntactical Corrections

  • Resolved a critical syntax parse error inside core/traits/rewriter.php (around line 342) where an escaped parameter default ('/') was breaking the compiler PHP parsing mechanism.
  • Patched pagination float-to-int assignment constraint regarding the mathematical floor() behavior inside the viewtopic context of listener.php.

4. Server Config Generative Improvements

  • Optimized the automated .htaccess rules generator to compile an output fully aligned with phpBB 3.3 standards, cleaning up Front Controller recursion anomalies, adding sitemap routing overrides, and structuring isolated directory paths for parent categories.

Existing Installations

Note

USU is no longer recommended for new phpBB installations. The documentation below is provided solely for administrators maintaining an existing USU-powered board.

For new installations, please install phpBB SEO Framework.

Upgrading / Maintaining Existing Boards

  1. Back up your database and existing extension files.
  2. Unpack the extension into:

Existing Installations

Note

USU is no longer recommended for new phpBB installations. The documentation below is provided solely for administrators maintaining an existing USU-powered board.

For new installations, please install phpBB SEO Framework.

Upgrading / Maintaining Existing Boards

  1. Back up your database and existing extension files.
  2. Unpack the extension into:
    ext/phpbbseo/usu/
    
  3. In the phpBB Administration Control Panel (ACP), navigate to Customise » Manage Extensions.
  4. Ensure Ultimate SEO URL is enabled.
  5. Purge the phpBB cache.
  6. Verify that your URL rewriting rules in .htaccess remain active.

Development & Maintenance Philosophy

This repository represents the compatibility and maintenance branch of the classic Ultimate SEO URL extension.

Its primary objectives are:

  • Preserve backward compatibility for historical URL formats
  • Maintain stable URL generation on modern PHP versions
  • Provide long-term stability for existing communities

Active development of new features (XML Sitemaps, Metadata engines, OpenGraph, Schema.org) is conducted exclusively on the phpBB SEO Framework platform.


Maintained by phpBB SEO


License

This project is licensed under the GNU General Public License v2.0 (GPL-2.0).
https://opensource.org/licenses/GPL-2.0

About

Ultimate phpBB SEO Friendly URL extension

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages