Custom Transliteration - Revision history

Lawrence: /* Custom Transliteration Function */

2020-12-15T13:32:55Z

‎Custom Transliteration Function

Lawrence: /* Custom Transliteration Function */

2020-12-15T13:32:36Z

‎Custom Transliteration Function

SarahK: /* Transliteration in WHMCS */

2020-05-27T21:04:50Z

‎Transliteration in WHMCS

SarahK: /* Custom Transliteration Function */

2020-05-27T21:02:47Z

‎Custom Transliteration Function

SarahK at 21:01, 27 May 2020

2020-05-27T21:01:21Z

Joshua at 13:07, 11 April 2017

2017-04-11T13:07:33Z

John at 15:38, 15 November 2011

2011-11-15T15:38:35Z

Matt: Created page with 'Transliteration is the practice of converting a text from one writing system into another in a systematic way. In WHMCS this is supported & can be used to automatically replace …'

2010-12-12T18:10:04Z

Created page with 'Transliteration is the practice of converting a text from one writing system into another in a systematic way. In WHMCS this is supported & can be used to automatically replace …'

New page

Transliteration is the practice of converting a text from one writing system into another in a systematic way.

In WHMCS this is supported & can be used to automatically replace characters in a clients profile data that would otherwise cause third party systems such as hosting control panels and domain registrars to reject the automated API requests containing those characters.

A default function included in WHMCS will automatically take care of and replace the most common special characters that cause problems for users but if you need to tailor it to your specific needs, then you can do so by creating a hook file as follows to override the default function, and specify your own custom character replacement process within it.

<?php

function hook_transliterate($string) {
$string = str_replace("ž","z",$string);
return $string;
}

add_hook("Transliteration",1,"hook_transliterate");

?>

The code above can simply be copied and pasted into a new file and saved into the /includes/hooks/ folder with any name to take effect, and you can then customise the character replacements done by that function as desired and just need to return the converted string at the end of the call.

@@ Line 19: / Line 19: @@
 </div>
-For an example of the above being used, a client with the name Jéssé žuckérbérg would be converted to Jesse Zuckerberg when performing a request using a module, such as a domain registrar.
+An example of the above being used: a client with the name Jéssé žuckérbérg would be converted to Jesse Zuckerberg when performing a request using a module, such as a domain registrar.
 Copy-and-paste the code above into a new file and save it in the <tt>/includes/hooks/</tt> directory. Then, you can customise the character replacements. You must specifically define this as the <tt>hook_transliterate</tt> function.
 To use this, return the converted string at the end of the call. You do not need to use the <tt>add_hook</tt> function with this feature.

@@ Line 18: / Line 18: @@
 <br/>?>
 </div>
 Copy-and-paste the code above into a new file and save it in the <tt>/includes/hooks/</tt> directory. Then, you can customise the character replacements. You must specifically define this as the <tt>hook_transliterate</tt> function.
 To use this, return the converted string at the end of the call. You do not need to use the <tt>add_hook</tt> function with this feature.

@@ Line 2: / Line 2: @@
 Transliteration is the practice of converting text from one writing system into another in a systematic way.
-You can use this with WHMCS to automatically replace characters in client profile data that third-party systems may reject. For example, a domain registrar's API might automatically reject certain characters in received requests.
+You can use this with WHMCS to automatically replace characters in [[Client_Management|client profile data]] that third-party systems may reject. For example, a domain registrar's API might automatically reject certain characters in received requests.
 ==Custom Transliteration Function==

@@ Line 9: / Line 9: @@
 <div class="source-cli">
 <?php
-</br>
+<br/>
-</br>function hook_transliterate($string) {
+<br/>function hook_transliterate($string) {
-</br>     $string = str_replace("ž","z",$string);
+<br/>     $string = str_replace("ž","z",$string);
-</br>     $string = str_replace("é","e",$string);
+<br/>     $string = str_replace("é","e",$string);
-</br>     return $string;
+<br/>     return $string;
-</br>}
+<br/>}
-</br>
+<br/>
-</br>?>
+<br/>?>
 </div>

@@ Line 1: / Line 1: @@
-Transliteration is the practice of converting a text from one writing system into another in a systematic way.
+==Transliteration in WHMCS==
-In WHMCS this is supported & can be used to automatically replace characters in a clients profile data that would otherwise cause third party systems such as hosting control panels and domain registrars to reject the automated API requests containing those characters.
+You can use this with WHMCS to automatically replace characters in client profile data that third-party systems may reject. For example, a domain registrar's API might automatically reject certain characters in received requests.
-A default function included in WHMCS will automatically take care of and replace the most common special characters that cause problems for users but if you need to tailor it to your specific needs, then you can do so by defining a '''hook_transliterate''' function within a file in the '''/includes/hooks/''' directory as follows to override the default function, and specify your own custom character replacement process within it.
+==Custom Transliteration Function==
- <?php
+<div class="source-cli">
 <?php
- function hook_transliterate($string) {
+</br>
-     $string = str_replace("ž","z",$string);
+</br>function hook_transliterate($string) {
-     $string = str_replace("é","e",$string);
+</br>     $string = str_replace("ž","z",$string);
-     return $string;
+</br>     $string = str_replace("é","e",$string);
+</br>     return $string;
+</br>}
- ?>
+</br>
-The code above can simply be copied and pasted into a new file and saved into the '''/includes/hooks/''' directory with any name to take effect. You can then customise the character replacements done by that function as desired and would just need to return the converted string at the end of the call. You do not need to use the '''add_hook''' function with this feature. The function must be specifically defined as '''hook_transliterate''' for it to work.
+Copy-and-paste the code above into a new file and save it in the <tt>/includes/hooks/</tt> directory. Then, you can customise the character replacements. You must specifically define this as the <tt>hook_transliterate</tt> function.