sunlab/wn-profile-plugin

Frontend User's profile plugin for WinterCMS

dev-main 2022-07-18 09:51 UTC

This package is auto-updated.

Last update: 2024-04-18 13:29:22 UTC


README

This plugin allows you to create customized front-end user additional fields such as (but not limited to):

  • Social links (GitHub, Twitter, Facebook, ...)
  • Biography
  • Company
  • Website
  • Born date
  • Timezone
  • ... Many more, the only limits is your imagination

Under development plugin

This plugin is still under active development, please report any issue you meet or submit a PR.

Composer installation

composer require sunlab/wn-profile-plugin

Requirements

This plugin requires the Winter.User Plugin.

Create additional fields

In the backend, navigate to the settings of the plugin, under the Users settings' tab. Here you can add the fields you need, the only required is the name which will correspond to the attribute of the associated User model attributes.

The rest of the fields corresponds to how the field will be displayed in the backend User's form.

Access/update the fields from front-end

Access

The field you've just created is accessible directly from a User model, the same way you would access the name or email attributes of the model:

Name: {{ user.name }}
Email: {{ user.email }}
GitHub: {{ user.github }}
Twitter: {{ user.twitter }}

Front-end Update

Using the Account component of Winter.User, you just need to add a corresponding input in the update.htm partial of the component, all the profile's plugin custom fields is accessible under the user variable:

<input name="twitter"
       type="text"
       value="{{ user.twitter }}"
>

That's all! The plugin already handle the saving process.