embedWidget() function - Documentation for SproutCMS

function embedWidget()

Embeds a widget into some text

File: /sprout/Helpers/ContentReplace.php, line 217
Namespace: Sprout\Helpers
Class: ContentReplace, Static method

Usage

string ContentReplace::embedWidget ( string $text , string $pattern , array $widget );

Arguments

string $text
```
The text containing the widget embed
```
string $pattern
```
The widget embed to replace
```

array $widget

as per lookupWidgets(), has keys and values
       matching the DB fields: 'type' (string), 'settings' (array),
       and 'embed_key' (string)

Return value

string
```
The text with the rendered widget
```