Cannot include custom TemplateHandler.php in upgrade safe way #4536

New issue

Open

opened 2026-02-20 16:19:10 -05:00 by deekerman · 0 comments

deekerman commented

2026-02-20 16:19:10 -05:00

Owner

Originally created by @wiatrp on GitHub (May 20, 2021).

Issue

I need a way to customize the include/TemplateHandler/TemplateHandler.php file. This file is included/required in many other files with calls like require_once('include/TemplateHandler/TemplateHandler.php'); or require_once 'include/TemplateHandler/TemplateHandler.php';. Because of this, I cannot create a custom file like what would be expected in custom/include/TemplateHandler/TemplateHandler.php

Expected Behavior

The include/TemplateHandler/TemplateHandler.php file require calls should look for a custom file first

Actual Behavior

The include/TemplateHandler/TemplateHandler.php file require calls just grab the non custom file

Possible Fix

Require once should be changed to search for custom files
Instead of: require_once('include/TemplateHandler/TemplateHandler.php');
Should be: require_once(get_custom_file_if_exists('include/TemplateHandler/TemplateHandler.php'));

Steps to Reproduce

Global search TemplateHandler.php to see all locations the file is used

Context

Your Environment

SuiteCRM Version used:
Browser name and version (e.g. Chrome Version 51.0.2704.63 (64-bit)):
Environment name and version (e.g. MySQL, PHP 7):
Operating System and version (e.g Ubuntu 16.04):

Originally created by @wiatrp on GitHub (May 20, 2021).    #### Issue   I need a way to customize the `include/TemplateHandler/TemplateHandler.php` file. This file is included/required in many other files with calls like `require_once('include/TemplateHandler/TemplateHandler.php');` or `require_once 'include/TemplateHandler/TemplateHandler.php';`. Because of this, I cannot create a custom file like what would be expected in `custom/include/TemplateHandler/TemplateHandler.php` #### Expected Behavior  The `include/TemplateHandler/TemplateHandler.php` file require calls should look for a custom file first #### Actual Behavior   The `include/TemplateHandler/TemplateHandler.php` file require calls just grab the non custom file #### Possible Fix  Require once should be changed to search for custom files Instead of: `require_once('include/TemplateHandler/TemplateHandler.php');` Should be: `require_once(get_custom_file_if_exists('include/TemplateHandler/TemplateHandler.php'));` #### Steps to Reproduce   1. Global search `TemplateHandler.php` to see all locations the file is used #### Context   #### Your Environment  * SuiteCRM Version used: * Browser name and version (e.g. Chrome Version 51.0.2704.63 (64-bit)): * Environment name and version (e.g. MySQL, PHP 7): * Operating System and version (e.g Ubuntu 16.04):