Note that the trimmarker removes characters from the end of the string to trim, so
$hello = 'Lorem ipsum dolor sit amet, lorem ipsum';
$trimmarker = '......................';
echo mb_strimwidth($hello, 0, 20, $trimmarker);
will only add the values of the trim marker, as the character number of $trimmarker is longer than the specified value to trim to, so it will return:
......................
It is therefore better to use this:
mb_strimwidth($hello, 0, 20). $trimmarker;
as the trimmarker won't remove characters of the string in order to make space for itself. It will return:
Lorem ipsum dolor si......................
mb_strimwidth
(PHP 4 >= 4.0.6, PHP 5, PHP 7)
mb_strimwidth — Get truncated string with specified width
Description
mb_strimwidth
( string
$str
, int $start
, int $width
[, string $trimmarker = ""
[, string $encoding = mb_internal_encoding()
]] ) : string
Truncates string str to specified width.
Parameters
-
str -
The string being decoded.
-
start -
The start position offset. Number of characters from the beginning of string (first character is 0), or if start is negative, number of characters from the end of the string.
-
width -
The width of the desired trim. Negative widths count from the end of the string.
-
trimmarker -
A string that is added to the end of string when string is truncated.
-
encoding -
The
encodingparameter is the character encoding. If it is omitted, the internal character encoding value will be used.
Return Values
The truncated string. If trimmarker is set,
trimmarker replaces the last chars to match the width.
Changelog
| Version | Description |
|---|---|
| 7.1.0 |
Support for negative starts and widths has been added.
|
Examples
Example #1 mb_strimwidth() example
<?php
echo mb_strimwidth("Hello World", 0, 10, "...");
// output: "Hello W..."
?>
See Also
- mb_strwidth() - Return width of string
- mb_internal_encoding() - Set/Get internal character encoding
add a note
User Contributed Notes 4 notes
felixstar4 at gmail dot com ¶
1 year ago
josiah dot ritchie at gmail dot com ¶
12 years ago
While having the option to append a string to the end is nice, you can run into the problem of having a space between the append if the width is truncated after a space. I find something like this to be more attractive in the output, although messy in the code.
rtrim(mb_strimwidth($string, 0, 24))."..."
CBieser ¶
11 years ago
<?php
function strimwidthCenter( $value, $length = 40 ) {
$valueEncoding = mb_detect_encoding( $value, 'auto', true );
if ( $length >= mb_strwidth( $value, $valueEncoding ) ) {
return $value;
}
$limited = '';
$firstWidth = ceil( $length/2 );
$secondStart = mb_strwidth( $value, $valueEncoding ) - ( $length - $firstWidth );
$secondWidth = $length - $firstWidth +1;
$limited = mb_strimwidth( $value, 0, $firstWidth, '...', $valueEncoding ) . mb_substr( $value, $secondStart, $secondWidth, $valueEncoding );
return $limited;
}
?>
Rich Mehta ¶
5 years ago
I had a problem (as in another comment) with a space being between the trailing dots and the subject being truncated. Here's how I fixed it:
<?php str_replace( " .", ".", mb_strimwidth( $subject, 0, 30, "..." ) ); ?>
