Важно! Внесение изменений в файлы шаблонов WooCommerce. Руководство по пользовательским типам записей: создание, выведение и дополнительные поля Создание дополнительных полей для пользовательских типов записей
Мы также включим функцию редактора записей Custom Fields (пользовательские или произвольные поля) для каждого типа и отобразим поля в новых шаблонах.
В WordPress пользовательские типы записей дают вам полный контроль над тем, как отображать контент вашим пользователям. Если вы создаёте записи в своём блоге, вы можете создать индивидуальные стили только для них. Если вы пишете отзывы о музыке или фильмах, вы можете добавлять дополнительные области для ввода в нужных публикациях, и они не будут отображаться в других публикациях блога.
Но прежде чем мы продолжим, давайте разберёмся с тем, что такое пользовательские записи.
Что такое произвольные типы записей WordPress?
Если коротко, то произвольные типы записей WordPress позволяют вам сортировать публикации по их содержимому. В WordPress типы публикаций по умолчанию: Запись, Страница, Медиафайлы и др.
Обычно вы пишете все ваши публикации в разделе Записи в админ консоли, затем присваиваете им категорию. Все записи различных типов находятся в одном списке, что затрудняет их различие по типу содержимого.
Произвольные типы записей со своими собственными ссылками в админ консоли ведут вас к списку записей этого типа. Созданным таким образом публикациям могут быть присвоены категории, такие как обычная запись, поэтому у вас есть абсолютная свобода сортировать и представлять публикации любым способом.
В примере выше, если пользователь перейдёт в раздел базы данных фильмов (movie) на вашем сайте, публикации с отзывами (review) не будут включены. Если вы, к примеру, сделаете категории ‘Action’ и ‘Romance’, ваши пользователи смогут пойти в категорию фильмов Action и увидеть все отзывы и фильмы категории.
Когда создаёте новый тип публикации, у вас есть множество настроек, таких как: где в админ-меню будет расположена ссылка, будет ли этот тип включён в результаты поиска, будет ли поддерживаться отображение фрагмента текста, разрешены ли комментарии и так далее.
Вы можете изменить различные тексты названий (заданные с использованием массива $labels ), такие как переименовать Add New Post в Add New Movie . Например, вы можете переименовать текст Featured Image (Изображение записи) в Add Poster (Добавить постер) .
Вы также можете включить функцию пользовательских полей в своём редакторе публикаций, которая по умолчанию спрятана и должна быть включена при помощи ссылки Screen Options вверху редактора.
Продолжая пример с Movies и Movie Reviews, публикации Movie могут добавлять пользовательские/произвольные поля для таких параметров как год выпуска, режисёр, рейтинги многие другие с кратким обзором фильмы в виде содержимого записи.
Обычно любое поле, которое вы создадите, доступно в любом типе записей, поэтому плагин требует ограничений для каждого поля, где ему быть доступным.
Создание новых типов записей
Когда вы создаёте значительные изменения в WordPress, одним из доступных вариантов реализации является создание плагина . Вы также можете создавать новые произвольные типы записей в файле functions.php . Для этого руководства мы создадим плагин и продолжим использовать пример с базой данных movie/reviews (фильмы/отзывы).
Для создания пользовательского типа записи нужно написать несколько функций, которые вызывают функцию WordPress с названием register_post_type() с двумя параметрами. Ваша функция должна быть привязана к хуку действия(action hook) init , иначе произвольный тип записи не будет зарегистрирован верно.
// The custom function MUST be hooked to the init action hook add_action("init", "lc_register_movie_post_type"); // A custom function that calls register_post_type function lc_register_movie_post_type() { // Set various pieces of text, $labels is used inside the $args array $labels = array("name" => _x("Movies", "post type general name"), "singular_name" => _x("Movie", "post type singular name"), ...); // Set various pieces of information about the post type $args = array("labels" => $labels, "description" => "My custom post type", "public" => true, ...); // Register the movie post type with all the information contained in the $arguments array register_post_type("movie", $args); }
Все пользовательские функции должны иметь префикс, чтобы избежать конфликтов с другими плагинами или функциями темы. Здесь будет использоваться префикс LC.
Два параметра для функции register_post_type() это:
- Название типа записи, максимум 20 символов, и не должно содержать пробелов и заглавных букв
- Ассоциативный массив, под названием $args , который содержит информацию о типе записи в виде пар ключ значение ‘key’ => ‘value’
Массив $args
Наиболее часто используемые ключи для массива $args показаны ниже, все не являются обязательными:
- labels – массив array , который задаёт разные фрагменты текста, например ‘Добавить новую запись’ может быть переименована в ‘Добавить новый фильм’. Ключи для массива labels с пояснениями описаны ниже;
- description – короткое и ёмкое описание типа записи, оно может быть отображено в шаблонах типов, но больше нигде не используется;
- public – видно ли тип записи для автором и посетителей, значение по умолчанию FALSE, что значит он не появляется даже в Админ консоли;
- exclude_from_search – будут ли записи этого типа появляться в результатах обычного поиска, значение по умолчанию противоположное значению public;
- publicly_queryable – можно ли получить запись этого типа с помощью URL-адреса, например, http://www.mywebsite.com/?post_type=movie, или в расширенном использовании через функцию query_posts(). Значение по умолчанию, это значение public;
- show_ui – подключаются ли ссылки меню и редактор сообщений в панели управления администратора. Значение по умолчанию –public;
- show_in_nav_menus – будут ли записи этого типа добавляться в меню навигации, созданные на странице Внешний вид ->Меню, значение по умолчанию – это значение public;
- show_in_menu – отображается ли ссылка типа записи в навигации админ консоли. FALSE – скрывает ссылку. TRUE – добавляет ссылку как новую ссылку верхнего уровня. Ввод строки позволяет разместить ссылку внутри существующей ссылки верхнего уровня, то есть ввести параметры options-general.php располагает её под ссылкой Настройки.
- show_in_admin_bar – появится ли этот тип записей выше Admin bar, под ссылкой + New
- menu_position – позиция новой ссылки в меню навигации админ консоли, 5 располагает ниже Записей, 100 располагает ниже Настроек, весь список позиций можно найти в WordPress Codex
- hierarchical – может ли запись быть назначена к родительской записи, если значение TRUE, то массив $supports должен содержать параметр ‘page-attributes’
- supports – выборочно включает функции записи такие как: изображения, фрагменты текста, произвольные поля и др. Если установлено в FALSE, то вместо массива выключается редактор для этого типа поста – полезно, если вы хотите закрыть все записи этого типа от редактирования, но оставить видимыми (список значений массива ниэе)
- taxonomies – массив таксономий, который может быть применён к публикациям этого типа, таксономии должны быть уже зарегистрированными – отсюда они не создаются!
- has_archive – будут ли у записей этого типа архивные страницы, URL имеет структуру постоянной ссылки и описательная часть URL – это параметр 1 функции register_post_types(), то есть http://www.mywebsite.com/movie_reviews/ покажет все записи movie_review.
- query_var – TRUE или FALSE определяет, может ли запись быть показанной, вписывая в виде запроса в URL тип записи и имя записи, то есть ‘http://www.mywebsite.com/?movie =the-matrix ‘. Если вы вводите строку текста, нужно располагать текст после символа?, таким образом ‘film’ будет выглядеть в результате как ‘?film =the-matrix ‘.
Массивы labels
Первый ключ в массиве $args называется labels (ярлыки) и должен быть массивом. Он задаёт различные фрагменты текста, относящиеся к типу записи. Так как здесь может быть много данных, лучше всего создать массив с названием $labels для их хранения. Приведенный выше код немного проясняет, что это значит.
Ниже представлены некоторые важные ключи для массива labels, все не являются обязательными:
- name – общее названия для типа сообщений, например, movies (фильмы)
- singular_name – название для одной записи этого типа, например, movie (фильм)
- add_new – замена текста ‘Add New’ (Добавить новую) на указанный текст, например, ‘Add Movie’ (Добавить фильм)
- add_new_item – замена для ‘Add New Post’ (Добавить новую запись), например, на ‘Add New Movie’ (Добавить новый фильм)
- edit_item – замена для ‘Edit Post’ (Редактировать запись), например, на ‘Edit Movie’ (Редактировать Фильм)
- featured_image – замена для ‘Featured Image’ (Изображение записи) в редакторе записи, например, на ‘Movie Poster’
- set_featured_image – замена ‘Set Featured Image’, к примеру, на такой вариант ‘Add Movie Poster’
- menu_name – изменение текста ссылки на верхнем уровне, текст для ссылки по умолчанию имя ключа
Массив supports
// Enable specific features in the post editor for my post type $supports = array ("title", "editor", "author", "thumbnail"); // Disable ALL features of the post editor for my post type $supports = FALSE;Один из ключей в массиве $args называется supports . Это простой массив, где вы записываете список функций редактора записи, которые вы хотите включить для своего типа записи. По умолчанию только название (title) и редактор (editor) включены.
Вы также можете поставить FALSE вместо массива, для отключение всех функций редактора, выключая и title, и область добавления контента. Это означает, что запись не может быть отредактирована, но по прежнему полностью видна.
Вот перечень функций, которые вы можете включить в массиве $supports :
- title (название)
- editor (редактор)
- author – ПРИМЕЧАНИЕ: это позволяет вам изменять автора публикации
- thumbnail (иконка)
- excerpt (фрагмент текста)
- trackbacks (трекбек)
- custom-fields (произвольное поле)
- comments (комментарии)
- revisions (версии)
- page-attributes (атрибуты страницы)
- post-formats (форматы записи)
Создание произвольного типа записи WordPress через плагин
Теперь, когда мы знаем, какие параметры нужны для функции, мы можем создать свой плагин, написать собственную функцию и прикрепить её к событию init .
lc_custom_post_movie() to the init action hook add_action("init", "lc_custom_post_movie"); // The custom function to register a movie post type function lc_custom_post_movie() { // Set the labels, this variable is used in the $args array $labels = array("name" => __("Movies"), "singular_name" => __("Movie"), "add_new" => __("Add New Movie"), "add_new_item" => __("Add New Movie"), "edit_item" => __("Edit Movie"), "new_item" => __("New Movie"), "all_items" => __("All Movies"), "view_item" => __("View Movie"), "search_items" => __("Search Movies"), "featured_image" => "Poster", "set_featured_image" => "Add Poster"); // The arguments for our post type, to be entered as parameter 2 of register_post_type() $args = array("labels" => $labels, "description" => "Holds our movies and movie specific data", "public" => true, "menu_position" => 5, "supports" => array("title", "editor", "thumbnail", "excerpt", "comments", "custom-fields"), "has_archive" => true, "show_in_admin_bar" => true, "show_in_nav_menus" => true, "has_archive" => true, "query_var" => "film"); // Call the actual WordPress function // Parameter 1 is a name for the post type // Parameter 2 is the $args array register_post_type("movie", $args); } // Hook lc_custom_post_movie_reviews() to the init action hook add_action("init", "lc_custom_post_movie_reviews"); // The custom function to register a movie review post type function lc_custom_post_movie_reviews() { // Set the labels, this variable is used in the $args array $labels = array("name" => __("Movie Reviews"), "singular_name" => __("Movie Review"), "add_new" => __("Add New Movie Review"), "add_new_item" => __("Add New Movie Review"), "edit_item" => __("Edit Movie Review"), "new_item" => __("New Movie Review"), "all_items" => __("All Movie Reviews"), "view_item" => __("View Movie Reviews"), "search_items" => __("Search Movie Reviews")); // The arguments for our post type, to be entered as parameter 2 of register_post_type() $args = array("labels" => $labels, "description" => "Holds our movie reviews", "public" => true, "menu_position" => 6, "supports" => array("title", "editor", "thumbnail", "excerpt", "comments", "custom-fields"), "has_archive" => true, "show_in_admin_bar" => true, "show_in_nav_menus" => true, "has_archive" => true); // Call the actual WordPress function // Parameter 1 is a name for the post type // $args array goes in parameter 2. register_post_type("review", $args); }
Ели вы включите этот плагин, то увидите новую ссылку в панели навигации админ консоли, сразу после ссылки Записи.
При наведении мыши будет показаны пункты меню ‘View All’ (Показать все) и ‘Add New’ (Добавить новую), текст будет соответствовать тому, который был задан в массиве $labels . Посмотрите в редакторе, где изменились ссылки.
Ограничение произвольных полей для заданных записей
При добавлении своих полей в запись поля сохраняются и вы можете быстро добавить любое к новой записи. Произвольные поля, которые вы добавили будут появляться в выпадающем списке каждой записи. Это может затруднить поиск нужного поля в определённых типах записей. Если вы хотите ограничить произвольные поля, чтобы они были доступны только для отдельных типов записей, то самый простой способ – через плагин.
get_post_meta()
- принимает 3 параметра и возвращает результат
- первый параметр – ID записи, вы можете использовать здесь $post->ID для получения ID текущей отображаемой записи
- второй параметр – имя произвольного поля записи, чувствительное к регистру
- третий параметр имеет тип boolean, называется $single и может быть TRUE (возвращает результат в виде строки) или FALSE (возвращает массив).
ID, "Box Art", TRUE); if (!empty($movie_box_art)) { ?>ПРИМЕЧАНИЕ: Вы можете создать несколько настраиваемых полей с тем же именем и разными значениями. Если существует несколько полей с одинаковым именем, установка FALSE вернёт их массив.
" alt=" ">
Поскольку функция get_post_meta() возвращает значение, вы можете использовать значение в условном выражении для соответствующего изменения внешнего вида.
В примере выше мы проверяем, содержит ли фильм (movie) box art, назначенный ему в виде произвольного поля. Если $movie_box_art не пустое, вывести div и image.
Отображение Advanced Custom Fields
// Display field value the_field("FIELD NAME"); // Return field value get_field("FIELD NAME");Плагин Advanced Custom Fields предлагает свои собственные функции и шорткоды для отображения полей.
the_field(‘ FIELD NAME’);
Отображает значение указанного поля, вы должны использовать имя поля (Field Name), которое вы указали при создании группы полей.
get_field(‘FIELD NAME’);
Возвращает значение указанного поля, удобно для условных выражений.
Это те функции, которые вам, скорее всего, понадобятся. Есть много дополнительных функций, и вы можете найти их в .
Шорткоды
Вы можете отображать поля непосредственно в записи, используя шорткод выше.
Отображение произвольного типа записей на главной странице
// Hook our custom function to the pre_get_posts action hook add_action("pre_get_posts", "add_reviews_to_frontpage"); // Alter the main query function add_reviews_to_frontpage($query) { if (is_home() && $query->is_main_query()) { $query->set("post_type", array("post", "movie", "review")); } return $query; }Пользовательские типы записей не отображаются на главной странице по умолчанию, поэтому вам нужно создать новую функцию, которая вызывает установленный метод объекта WP_Query WordPress.
Функция проверяет, находится ли посетитель на главной странице, и является ли активный запрос основным, созданным WordPress.
$query->set() принимает два параметра:
- первый параметр – приоритет, который вы хотите изменить, в нашем случае мы изменяем приоритет post_type
- второй параметр – массив, который вы хотите передать как значение признака post_type
В примере кода выше массив начинается с ‘post’ – вот почему каждая запись WordPress имеет тип ‘post’ и мы всё ещё хотим включить её на главной странице.
Если на главной странице вы хотите использовать только пользовательские записи заданного типа, вы можете удалить‘posts’ и использовать свой собственный тип сообщений.
Значение, которое вы вводите должно соответствовать параметру 1 функции register_post_type() .
Заключение
В этом руководстве, мы показываем как создать пользовательские типы и какие данные вам нужно иметь для этого. Гибкость произвольных типов публикаций предоставляет ценную функциональность для любого сайта на WordPress.
Get a valuable feedback from your customers by giving them the freedom to share their impressions freely. Let them rate your products and/or services straight on your website. See below the key features that come standard with our online review system.
Reviews & Ratings
Embed PHP Review Script into your website and let clients share their experience with the products and services you offer. They can rate by criteria and give both positive and negative feedback.
Multiple Languages
The PHP review system can speak not only English, but any language you may need. You can translate all titles and system messages from the admin page using unique IDs for each piece of text.
Editable Rating Criteria
Depending on the type of business, review system admins can
set different rating criteria to be shown in the front-end form.
Each of these criteria is rated with 1 to 5 stars.
Email & SMS Notifications
Set up the online review system to send Email & SMS alerts when a new review has been posted. You can easily specify which users to receive these messages from the Users menu.
Multiple User Types
Create unlimited client types depending on the industry and services used. Hotel ratings can go with following user types: Family with kids, Couple, Business trip etc. They appear as labels in the reviews.
Responsive & Attractive
The review and rating script runs on all devices, seamlessly adapting to various screen sizes. In accord with your website branding, you can pick the best matching front-end theme among 10 color options.
A quick tips box next to the review form allows you to add some witty words and draw customers out. The review system filters reviews by user type. Customers can rate other clients" ratings, too.
With a Developer Licence you get the source code and can make any custom changes to the PHP Review Script. We can also modify the customer review system upon request.
Ответ
На основе https://toster.ru/q/276441 Понятное дело, многое зависит от проекта, поэтому данный пост стоит адаптировать под ваш случай.
* Безопасность:
- Каждый аргумент метода простого типа должен проверяться на тип в случае его проксирования и на граничные значения в случае обработки. Чуть что не так - бросается исключение. Если метод с несколькими аргументами на 80% состоит из поверки из аргументов - это вполне нормально))
- Никаких trigger_error, только исключения.
- Исключения ДОЛЖНЫ быть человеко-понятны, всякие "Something went wrong" можно отдавать пользователю, но в лог должно попасть исключение со стектрейсом и человеко-понятным описанием, что же там пошло не так.
- Каждый аргумент (объект) метода должен быть с тайпхинтингом на этот его класс, или интерфейс.
- За eval как правило жесткий выговор
- @ допускается только в безвыходных ситуациях, например проверка json_last_error.
- Перед работой с БД - обязательная проверка данных.
- Никаких == и!=. Со swtich - единственное исключение, по ситуации.
- Если метод возвращает не только bool, а еще что-то - жесткая проверка с ===, или!== обязательна.
- Никаких условий с присваиваниями внутри. while($row = ...) - тоже недопустимо.
- Магические геттеры/сеттеры разрешаются только в безвыходных ситуациях, в остальном - запрещены.
- Конкатенации в sql - только в безвыходных ситуациях.
- Параметры в sql - ТОЛЬКО через плейсхолдеры.
- Никаких глобальных переменных.
- Даты в виде строки разрешаются только в шаблонах и в БД, в пхп коде сразу преобразуется в \DateTimeImmutable (в безвыходных ситуациях разрешено \DateTime)
- Конечно зависит от проекта, но как правило должно быть всего две точки входа: index.php для web и console(или как-то по другому назваться) - для консоли.
* Кодстайл PSR-2 + PSR-5 как минимум, + еще куча более жестких требований (для начала все то что в PSR помечено как SHOULD - становится MUST)
- В PhpStorm ни одна строчка не должна подсвечиваться (исключением является typo ошибки, например словарик не знает какой-то из аббревиатур, принятых в вашем проекте). При этом разрешается использовать /** @noinspection *** */ для безвыходных ситуаций.
- Если кто-то говорит, что пишет в другом редакторе и у него не подсвечивается, все равно отправляется на доработку.
* Организация кода:
- Никаких глобальных функций.
- Классы без неймспейса разрешаются только в исключительно безвыходных ситуациях.
* Тестируемость (в смысле простота тестирования) кода должна быть высокая.
- Покрытие кода обязательно для всех возможных кейсов использования каждого публичного метода с моками зависимостей.
* Принципы MVC:
- Никаких обработок пользовательского ввода в моделях, от слова совсем.
- Никаких запросов в БД из шаблонов.
- Никаких верстки/js/css/sql-ин в контроллерах.
- В моделях НИКАКОЙ МАГИИ, только приватные свойства + геттеры с сеттерами.
- В моделях разрешено использовать метод save(при наличии такого разумеется) только в исключительных ситуациях. Во всех остальных - либо insert, либо update.
* Принципы SOLID:
- Никаких универсальных объектов, умеющих все.
- Если метод для внутреннего пользования - private, никаких public.
- Статические методы разрешаются только в случае безвыходности.
* Принцип DRY разрешено нарушать в случаях:
- Явного разделения обязанностей
- В тестах (каждый тест должен быть независимым, на сколько это возможно)
* Работа с БД:
- Запрос в цикле должен быть РЕАЛЬНО обоснован.
- За ORDER BY RAND() жесткий выговор
- Поиск не по ключам (конечно если таблица НЕ на 5 строк) запрещен.
- Поиск без LIMIT (опять же если таблица НЕ на 5 строк) запрещен.
- SELECT * - запрещен.
- Денормализация БД должна быть обоснована.
- MyISAM не используется (так уж)))
- Множественные операции обязательно в транзакции, с откатом если что-то пошло не так.
- БД не должна содержать бизнес логики, только данные в целостном виде.
- Не должно быть нецелесообразного дерганья БД там, где без этого можно обойтись.
* Кэш должен очищаться по двум условиям (не по одному из, а именно по двум):
- Время.
- Протухание по бизнес логике.
Разрешается по только времени в безвыходных ситуациях, но тогда время - короткий период.
- При расчете ключей кэша должна использоваться переменная из конфигурации приложения (на случай обновлений кэш сбрасывается кодом, а не флашем кэш-сервера). В случае использования множества серверов - это очень удобный и гибкий инструмент при диплое.
* О людях:
- "Я привык писать так и буду дальше" - не вопрос, ревью пройдешь только когда поменяешь свое мнение.
- "Я пишу в vim-е и мне так удобно" - здорово, код консолью я тоже в нем пишу)) но есть требования к коду, если в них не сможешь - не пройдешь ревью.
- "Я скопировал этот страшный метод и поменял 2 строчки" - это конечно замечательно, но по блейму автор всего этого метода ты, так что давай без ерунды, хорошо?
- "Оно же работает!" - вот эта фраза переводится примерно так: "да, я понимаю, что пишу полную ерунду, но не могу писать нормально потому, что не могу", я правильно тебя понял?))
- "У меня все работает!" - рад за тебя, а как на счет продакшна?
- "Там все просто" - не используй слово "просто", от слова "совсем". Вот тебе кусок кода (первого попавшегося со сложной бизнес логикой), где там ошибка (не важно есть она, или нет)? Ты смотришь его уже 2 минуты, в чем проблема, там же все "просто"))
* Всякое:
ActiveRecord (это я вам как в прошлом фанат Yii говорю) - полный отстой, примите за исходную. По факту у вас бесконтрольно по проекту гуляют модельки с подключением к БД. Не раз натыкался на то, что в тех же шаблонах вызывают save, или update (за такое надо сжигать).
Основное:
1. Наличие критических ошибок и устаревших функций.
2. Использование паттернов, элегантность решений.
3. Читабельность кода, наличие коментариев, наличие доков.
4. Соблюдение парадигм и соглашений (например, нарушение MVC).
Второстепенно\непринципиально:
1. Быстродействие кода (за исключением хайлоад)
2. Потребление памяти (за исключением бигдаты)
3. Эфективность SQL запросов (за исключением совсем уж несуразных)
4. Избегание в данных момент неважных, но потенциально узких мест (например замедление работы файловой системы при большом количестве картинок в папке аплоада)
5. Новизна примененых технологий.
6. Оправданое\Неоправднанное\Избыточное Велосипедирование.
- Код не содержит явных и потенциальных ошибок.
- Код работает так, как это описано в документации, техническом задании или сопроводительных комментариях.
- Стиль кодирования соответствует принятым правилам кодирования
- Код имеет сопроводительные комментарии в соответствии с phpDoc
- Вложенность блоков не превышает 4-го уровня.
- Код не генерирует сообщения уровня Strict, Warning, Notice, Deprecated. Если этого невозможно избежать, то непосредственно перед строкой, которая это генерирует необходимо принудительно отключить error_reporting, а непосредственно после строки включить error_reporting в исходное значение (которое было до этого). Такой код должен быть задокументирован специальным образом.
- Закомментированный кусок кода должен быть удален.
- В PHP коде (за исключением phpTemplate) запрещены вставки HTML, JavaScript. Все вставки должны производиться через специальные шаблоны.
- Классы, функции, переменные и константы должны логически именоваться человекопонятным способом на английском языке в соответствии со стандартами кодирования. Не допускается именование транслитом на русском, либо на иных языках
- Область видимости переменных и методов классов всегда должна быть определена (private, protected, public).
- Размер одного метода не должен превышать 40-50 строк.
- Переменная, используемая в цикле, либо в условном блоке должна быть инициализирована заранее.
- Переменная в любой момент времени должна содержать только один тип. Пустая переменная должна содержать null. (не допускается $var = false; $var = "test"; . Допускается $var = null; $var = "test";).
- При передаче объектов классов в методы должен использоваться контроль типов.
First, from a code organization standpoint, it’d be better to put all of the review logic into one or more includable files and then include it on product pages:
Include("includes/reviews.php");
This way, the product pages can remain unadulterated and the same review code can easily be used, or modified, as needed. The reviews.php script would do several things:
- Show the review form
- Handle the review form
- List the existing reviews
- Handle secondary actions, such as flagging reviews or comments as inappropriate, indicating that reviews were helpful, adding comments to reviews, indicating that comments where helpful, and so forth
Hopefully you’ve done plenty of web development already, so you know that a form for adding reviews would just be like so:
Clearly you’d want to use some CSS to make it pretty, but that’s the basic idea. The main catch is that the product ID and product type (or whatever the database must have in order to associate a review with an item) must be stored in hidden inputs. You’d have the PHP script that displays the product write these values to the inputs.
If login is required, you might add (PHP) code that only shows the form to logged-in users, or prints a comment saying the user must log in to review the product. Similarly, if you have a system in place for guaranteeing a person only ever reviews a product once, you’d have PHP check for that scenario before showing this form.
The form submission could go to a new page, but then the user would need to click the Back button to return to the product page, which isn’t ideal. I would instead submit the form back to the product page. For example, on any dynamic website, the same PHP script is used to display all the content of a specific type. In my Effortless E-Commerce with PHP and MySQL book, the first example site uses the page.php script to show any page of content. The action attribute of the form would point to the same page.php . You can accomplish this by just leaving the attribute empty, or by using PHP to dynamically set the value.
If the PHP page that lists the products requires that a value identifying the product be passed in the URL, then the form would need to store that value in a hidden input as well. (That may already be the case, with the product_id input, depending upon how the site is set up.) Secondarily, the product script would also need to be updated to allow for the product value to be received via POST .
For the reviews.php script to know when to handle a form submission, it can check how the script was accessed:
If ($_SERVER["REQUEST_METHOD"] == "POST") { // Handle the form.
When the review form is submitted, the form data should be validated. You should also apply strip_tags() to the data to prevent Cross-Site Scripting (XSS) attacks or other bad behavior. And non-numeric values would be run through an escaping function, such as mysqli_real_escape_string() . Or you could just use prepared statements or stored procedures for better security and performance.
If you add an anchor to the form’s action attribute action="page.php#reviews "the user will be taken to the reviews section of the page upon the submission, which is a nice touch.
If the reviews.php script is also handling some of the other actionsinappropriate reviews or comments, helpful indicators, etc.the script would need to watch for those submissions, too. I would use hidden inputs named “task” to indicate which action is being taken.
In a separate article, I demonstrate how to use Ajax for a simple rating system. Similar Ajax code could be used for the review system, too.
