Система уведомлений

Описание

Notification System plugin creates and maintains a notification system for users on WordPress site.

The plugin has the Options page in the site console, with relevant buttons and controls. Please see screenshots.

Админка

Notifications are custom posts of type notification. There is a standard custom post interface, with a menu in admin.

Администратор может создавать, редактировать и удалять уведомления. Одна таксономия доступна: Channel. Администратор может добавлять, редактировать и удалять термины таксономии. Чтобы ограничить уведомления некоторым пользователям, добавьте login пользователей в виде списка, разделённого запятыми.

Фронтенд

Plugin creates page /notifications «on the fly» — it does not exist in the database. Information on this page is visible only to the logged-in users (restricted by permissions in REST API Controller).

Plugin creates a popup window if url contains hash #notifications, like that: http://my.site.org/some-url#notifications. This is an easy way to show a popup window with notifications from anywhere. Just create a link like <a href="http://my.site.org#notifications">Notifications</a> and a click on this link will open a popup window with notifications.

Logged-in users can list notifications and filter them by a channel.

Show more button provides pagination of the notification list.

For those users who have the capability ‘edit_posts’, additional buttons are shown: Create, Update, and Delete. Popup windows provide relevant inputs. All notifications can be edited right from the frontend.

Администраторам сайта

Add a custom link to the menu, with #notifications url. Use any navigation label or space(s) for empty label. Save menu. On the site frontend, you will see a new menu item with icon and unread count. By clicking on this menu item, a popup window with notifications will be opened.

Разработчики

Create an element(s) with the class unread-notifications-count. The best place for such element(s) is somewhere in the header or menu. It(they) can be updated by plugin during custom JS event update_unread_counts. Example:

    const count = 5;
    document.dispatchEvent(
        new CustomEvent(
            'update_unread_counts',
            { 'detail': count }
        )
    );

Из кода php, счётчики могут быть обновлены для текущего пользователя с помощью действия ‘update_unread_counts’. Пример:

    do_action( 'update_unread_counts' );

Подготовлен к переводу

The plugin is prepared for translation. All strings are output via gettext functions. There is a .pot file in /language directory with strings collected.

Код

The PHP code conforms to PHP 7.0 level.
The JS code conforms to ES6 level.

Весь код проверен анализатором кода, и соответствует стандартам кодирования WordPress.