Function __global->wordwrap
Definitions
sources_custom/phpstub.php
- Wraps a string to a given number of characters using a string break character.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: string
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $string | string | No | No | required parameter | N/A | N/A | Subject |
| $width | integer | No | No | 75 | N/A | N/A | The word wrap position |
| $break | string | No | No | N/A | N/A | The string to put at wrap points | |
| $cut | boolean | No | No | False | N/A | N/A | Whether to cut up words |
Returns
- Word-wrapped string
- Type: string
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Wraps a string to a given number of characters using a string break character.
*
* @param string $string Subject
* @param integer $width The word wrap position
* @param string $break The string to put at wrap points
* @param boolean $cut Whether to cut up words
* @return string Word-wrapped string
*/
function wordwrap(string $string, int $width = 75, string $break = '
', bool $cut = false) : string
* Wraps a string to a given number of characters using a string break character.
*
* @param string $string Subject
* @param integer $width The word wrap position
* @param string $break The string to put at wrap points
* @param boolean $cut Whether to cut up words
* @return string Word-wrapped string
*/
function wordwrap(string $string, int $width = 75, string $break = '
', bool $cut = false) : string
