Публикация в группе: Плагин WP-Recall - Личный кабинет на WordPress

Категории группы: Полезное

Добавлено в закладки: 9

Плагин WP-Recall уже давно использует и развивает свой функционал произвольных полей.

Произвольные поля плагина широко используются для построения форм в самых различных дополнениях и в самом ядре. Если изучить порядок работы с этим функционалом, то станет понятен принцип работы и кастомизации с уже существующими формами, например, настройками профиля пользователя, формой публикации или полями формы регистрации. А разработчикам будет легче создавать опции к своим дополнениям. Почти все формы, требующие ввода и сохранения данных внутри плагина и его базовых дополнений строятся именно на произвольных полях, потому что это быстро и удобно,  а если взять этот функционал себе на вооружение для своих проектов, то он позволит съэкономить ценное время разработчика.

Структура данных поля

Произвольное поле при инициализации представляет собой массив с данными определяющими его тип и установленные параметры.

Массив для общего случая выглядит так:

В этом массиве наиболее важными параметрами являются 'type' и 'slug', первое определяет тип поля, а второй - его идентификатор, который, как правило, задает атрибут name у создаваемого поля. Slug должен быть уникальным для каждого поля внутри одной формы.

Почти всем полям для инициализации достаточно указанного набора параметров, но некоторые поля требуют указания дополнительных параметров. Рассмотрим, какие типы полей бывают, а затем подробно рассмотрим возможные параметры для каждого типа.

Типы полей

Для работы с функционалом произвольных полей важно знать их существующие типы и возможные настройки к ним.

На данный момент, существуют следующие типы полей:

  • text - простое текстовое поле
  • textarea - многострочное текстовое поле
  • select - выпадающий список
  • multiselect - поле множественного выбора из предложенных вариантов, данные сохраняются в массив
  • checkbox - чекбоксы, данные сохраняются в массив
  • radio - радиокнопки
  • number - числовое поле
  • email - указание email
  • date - указание даты, использует скрипт datepicker
  • time - указание времени, использует поведение текущего браузера
  • url - указание url, использует поведение текущего браузера
  • tel - указание телефона, используется поведение текущего браузера
  • runner - числовое значение, для указания используется скрипт ui slider
  • range - указание минимального и максимального значения в заданном диапазоне, используется скрипт ui slider, данные сохраняются в массив
  • dynamic - динамически добавляемые поля для указания множественных значений
  • hidden - скрытое поле
  • custom - произвольное содержимое

Каждый тип поля призван выполнять свою задачу, может иметь свой набор уникальных параметров и предустановленных значений, рассмотрим их подробнее.

Параметры полей

Для того чтобы создать произвольное поле типа text достаточно сформировать простой массив:

Как правило этого набора достаточно, чтобы создать поле, но всегда можно расширить и дополнить массив указанием дополнительных параметров, которые могут быть обязательными для определенных типов и необязательными, но возможными для всех типов полей.

Необязательные параметры:

  • title - определяет заголовок поля (строка)
  • notice - определяет подпись/пояснение к полю (строка)
  • default - определяет значения установленные по-умолчанию (строка, число, массив)
  • placeholder - определяет значение placeholder для полей типов: text, textarea, number, email, tel, url, date, time, dynamic (строка)
  • required - указание поля в качестве обязательного для заполнения, не действует для полей типа: runner, range, hidden (true/false)
  • maxlength - указание максимального количества символов в поле, действует для полей типа: text, textarea (число)
  • values - массив значений предлагаемых к выбору, действует для полей в которых необходимо выбирать из нескольких значений: checkbox, radio, select, multiselect, dynamic (массив)
  • value_min - минимальное значение, для полей: runner, range (число, по-умолчанию: 0)
  • value_max - максимальное значение, для полей: runner, range (число, по-умолчанию: 100)
  • value_step - шаг изменения значений, для полей: runner, range (число, по-умолчанию: 1)

Обязательные уникальные параметры:

  • content - содержит html-структуру, уникальный параметр для поля типа custom (строка)
  • value - установленное значения, уникальный параметр для поля типа hidden (строка, число)

Итак, мы рассмотрели типы полей и знаем какие параметры могут использоваться при их инициализации. Теперь мы можем строить произвольные формы с нужным набором полей под свои задачи.

Построение произвольной формы

Для начала определимся какие поля нам нужны для формы и создадим массив с данными этих полей:

Мы создали массив данных трех полей разных типов: checkbox, textarea, runner и указали для них широкий набор необязательных параметров, которые будут определять поведение поля в форме и его изначальное состояние.

Обратите внимание на параметр default первого поля типа checkbox, он указывает на выбор по-умолчанию для значения "Черный", так как в массиве существующих значений ему соответствует ключ массива со значением 1. Мы могли бы задать массив существующих значений в виде:

тогда значение параметра default будет равен array('black').

Итак, возвратимся к созданному массиву параметров, самое время начать его обработку и построить свою форму. Для обработки нам потребуется класса Rcl_Custom_Fields. Прогоним массив полей через цикл, поочередно отдавая данные полей в методы класса:

Я специально не стал перегружать код лишними html-тегами, но вы можете легко кастомизировать код под себя и свою верстку. В результате мы получим вполне себе полноценную форму, с нужными полями и предустановленными настройками.

HTML-структура полей формы будет соответствовать стандартам произвольных полей WP-Recall и будет повторяться из формы в форму, поэтому можно будет легко написать свои единые стили для всех своих форм.

Останется только подбить внешний вид формы и ее полей под свое видение и написать свой обработчик данных с полей, после этого форма будет готова и ей можно будет пользоваться.

Согласитесь, что для того, чтобы написать даже такую простую форму потребовалось бы куда больше времени, чем ушло на написание массива данных полей. Плюсы становятся еще более очевидными, если представить, что в форме необходимо вывести десятка полтора полей. Поэтому если вы пишете дополнение к плагину WP-Recall, то не упускайте возможность использовать существующий функционал произвольных полей плагина при создании форм - прирост производительности будет обеспечен!

Полезные хуки для работы с произвольными полями

Раз уж сам плагин активно строит формы через этот функционал, то мы можем получить массив произвольных полей нужной нам формы и поменять его под свою задачу. Для этого следует использовать существующие внутри плагина и его дополнений фильтры. Рассмотрим несколько примеров:

rcl_profile_fields

Фильтр получает все поля профиля предлагаемые пользователю для заполнения внутри его личного кабинета. Вы можете обработать их или добавить свое поле:

 

rcl_default_profile_fields

Через этот фильтр можно получить для обработки дефолтные поля пользовательского профиля, а также добавить в этот список свое поле, например:

 

rcl_public_form_fields

Этот фильтр позволяет получить данные полей формы публикации. Вторым параметром он передает данные формы, по нему можно получить форму для публикации определенного типа и обработать текущие поля или добавить свое:

Также функционал произвольных полей используется при формировании и выводе опций плагина и его дополнений, менеджера вкладок личного кабинета, да и сам менеджер произвольных полей, а также опции внутри каждого поля написаны с использованием функционала произвольных полей)

Функционал очень удобный и прошел обкатку временем, буду рад, если кто то будет использовать данный функционал в своих разработках и для кастомизации текущего функционала плагина WP-Recall. Если будут вопросы или замечания, пишите их в комментариях, обязательно отвечу.

2

Автор публикации

не в сети 13 минут

Андрей CS

10k

пока занят

Комментарии: 1750Публикации: 404Регистрация: 30-11--0001Продаж/Покупок: 16170/106