yii2mod/yii2-link-preview LinkPreview widget renders page preview


Yii2 Link Preview Widget

LinkPreview widget automatically retrieves some information from the content of the link.

Latest Stable Version Total Downloads License Build Status


The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist yii2mod/yii2-link-preview "*"

or add

"yii2mod/yii2-link-preview": "*"

to the require section of your composer.json file.


1) Execute init migration:

php yii migrate/up --migrationPath=@vendor/yii2mod/yii2-link-preview/migrations

2) Define preview action in your controller:

public function actions()
    return [
        'link-preview' => LinkPreviewAction::className()

3) Add widget to your page as follows:

echo LinkPreview::widget([
    'selector' => '#your-input-id or .someclass',
    'clientOptions' => [
        'previewActionUrl' => \yii\helpers\Url::to(['link-preview'])

Example of usage with the ActiveForm and saving the page info

1) Create the basic form in the view:

<?php $form = \yii\widgets\ActiveForm::begin() ?>
    <div class="form-group">
        <label for="preview">Preview</label>
        <input name="preview" class="form-control" id="preview" placeholder="Preview">
    <?php echo \yii2mod\linkpreview\LinkPreview::widget([
        'selector' => '#preview',
        'clientOptions' => [
            'previewActionUrl' => \yii\helpers\Url::to(['link-preview'])
    ]) ?>
    <div class="form-group">
        <?= \yii\helpers\Html::submitButton('Save', ['class' => 'btn btn-primary']) ?>
<?php \yii\widgets\ActiveForm::end() ?>

2) Add the following code to your action for the saving page info:

$model = new LinkPreviewModel();
if ($model->load(Yii::$app->request->post()) && $model->validate()) {

// or the short version 

$linkPreviewId = LinkPreviewModel::saveAndGetId(Yii::$app->request->post());

GitHub Preview Example

Alt text

Video Link Preview Example

Alt text


GitHub Stars
GitHub Forks



1.3 is the latest of 8 releases

MIT license
25 github stars & 11 github forks
1 downloads in the last day
5 downloads in the last 30 days
1173 total downloads