How to use Text Helper

Oct 17, 2019
By hissy for Designers
// >= 8.5.2
$text = app('helper/text');

// <= 8.5.1
$text = Core::make('helper/text');

// Like sanitize, but requiring a certain number of characters, and assuming a tail.
// You can set a max number of characters by the second parameter.
// You can set the tail by passing a string to the third parameter.
$string = $text->shortText($string, 255, '...');

// Alias of ->shortText()
$string = $text->shorten($string);

// Shortens and sanitizes a string but only cuts at word boundaries.
$string = $text->shortenTextWord($string, 255, '...');

// Alias of ->shortenTextWord()
$string = $text->wordSafeShortText($string);

// Leaves only characters that are alpha-numeric.
$string = $text->alphanum($string);
$string = $text->filterNonAlphaNum($string);

// Leaves only US-ASCII characters.
$string = $text->asciify($string);

// Leaves only characters that are valid in email addresses (RFC).
$string = $text->email($string);

// Scans passed text and automatically hyperlinks any URL inside it.
// If you want to set target=_blank, pass true to the second parameter.
// You can set default protocol with the third parameter.
$string = $text->autolink($string, true, 'https://');

// Scans passed text and automatically add hyperlinks to any twitter style @usernames in a string.
// If you want to set target=_blank, pass true to the second parameter.
// If you want to add hyperlinks to #hashtags also, pass true to the third parameter.
$string = $text->twitterAutolink($string, true, true);

// Takes a string and turns it into the CamelCase or StudlyCaps version.
$string = $text->camelcase($string);

// Takes a CamelCase string and turns it into camel_case.
$string = $text->uncamelcase($string);

// Takes a string like "Blah Blah" and turn it into "blah-blah".
$string = $text->handle($string);

// Takes a handle-based string like "blah_blah" or "blah-blah" or "blah/blah" and turns it into "Blah Blah".
$string = $text->unhandle($string);

// Always use this instead of htmlentities()
$string = $text->entities($string);

// Decodes html-encoded entities
$string = $text->decodeEntities($string);

// Always use this instead of htmlspecialchars()
$string = $text->specialchars($string);

// Combination of strip_tags(), autolink, nl2br
$string = $text->makenice($string);

This is not a complete list of the functions of text helper. To see it, please visit API document.

Recent Tutorials
How to update Add-Ons if not on the Update Add-Ons Menu item
Jul 4, 2022

How to manually download an add-on and update it when your site's core versions isn't considered compatible with the add-on version.

Generate a report with author information and form summaries in Concrete CMS.
May 9, 2022

In Concrete CMS, you can use a form to initiate contact between logged-in users and then create helpful reports. After form submissions are collected, they can be searched, sorted, and exported as a spreadsheet. This tutorial will detail how to add author information to a report using the advanced search.

How to clone and customize Atomik theme
Feb 14, 2022
By linuxoid.

How to clone and customize Atomik theme

Update jQuery to 3.5 on Concrete CMS version 8.5.x
Dec 1, 2021
By hissy.

If you have to take some time to fix your site to work with version 9 and want to update jQuery immediately, you can override it.

Add-On Developers: Get Your Add-Ons Ready for Concrete CMS 9.0
Aug 6, 2021
By andrew.

Concrete CMS 9.0 is coming! But there are some changes in version 9 that might affected your add-ons and themes. This document aims to answer questions about the most common ways that your add-ons might need to be changed, and common problems you'll run into.

Permissions for editors in a multilingual site
Jun 2, 2021
By myq.

How to set up a multilingual Concrete CMS site for groups of language-specific editors

Was this information useful?
Thank you for your feedback.