Советы по именованию файлов для плагина
Основываясь на некоторых советах, которые я прочитал[1], я тщательно назвал все свои php-файлы плагинов с моим принятым префиксом плагина, в данном случае "wpsm-". Все мои файлы классов имеют дополнительный квалификатор "класс", что делает их префикс "wpsm-class-".
Теперь, занимаясь утренней уборкой, пытаясь сосредоточиться на серьезном кодировании, я понял, что пока все мои php-файлы остаются в папке моего плагина, нет причин добавлять к ним все префиксы и удалять префикс на самом деле улучшает читабельность. Кроме того, если я помещу все свои файлы классов в папку "код" или "класс", мне не понадобится дополнительный префикс "класс".
Что читатели этого вопроса предлагают для моих соглашений об именовании в контексте, который я описал выше?
[1] Профессиональная разработка плагинов WordPress:
"При создании пользовательского плагина важно, чтобы вы добавляли префикс все с уникальным префиксом. Это означает, что все файлы плагинов, имена функций, имена переменных и все, что входит в ваш плагин".
2 answers
Конечно, нет необходимости называть файлы плагинов префиксами (хотя некоторые авторы плагинов любят это делать). Я подозреваю, что совет, который вы прочитали, касался функций в ваших файлах плагинов. Структурирование папок плагинов, как вы предлагаете (с использованием папки класса), - это нормально.
Смотрите эту ссылку для получения дополнительной информации о написании плагинов:
Http://codex.wordpress.org/Writing_a_Plugin
В частности, раздел "Предложения по разработке плагинов" ближе к концу где говорится:
Все функции в вашем плагине должны иметь уникальные имена, отличные от функций в ядре WordPress, других плагинах и темах. По этой причине рекомендуется использовать уникальный префикс имени функции для всех функций вашего плагина. Гораздо лучшей возможностью является определение функций вашего плагина внутри класса (который также должен иметь уникальное имя).
Что касается префикса имени плагина, я не могу не согласиться. Если все файлы хранятся в папке плагина (а почему бы и нет?), я не вижу никаких причин ставить перед каждым файлом имя плагина. Как вы отметили, это на самом деле ухудшает читабельность, и, на мой взгляд, это единственный эффект, который он оказывает. Файлы однозначно идентифицируются по папке, в которой они находятся. Я опускаю этот префикс в своих файлах плагинов.
Когда дело доходит до префикса класса -, ситуация не столь ясна. Опять же, я вижу, что ваши доводы в пользу этого, возможно, излишни, но лично я использую его для своих файлов плагинов ООП по двум причинам: во-первых, мне нравится называть вложенные папки плагинов по роли, которую файлы, которые они содержат, играют в плагине, т.Е. Мои вложенные папки плагинов обычно называются /включает, / модули, / администратор и тому подобное. Теперь могут быть классы, относящиеся к серверной части, которые входят в /admin. Классы, необходимые для плагин в /включает и классы для компонентов, которые пользователь может использовать или не использовать в /модулях. Все эти папки также могут содержать файлы, которые не являются объектно-ориентированными. Вторая причина заключается в том, что этот префикс рекомендуется Соглашениями об именовании Стандарта кодирования Wordpress.
Если ваш плагин когда-либо должен будет поддерживаться кем-то другим, то префикс класса имеет смысл.
Кроме того, стандарт также рекомендует дефисы для имен файлов, а не подчеркивания.