WordPressプラグインまたはテーマを開発する際に避けるべき9つの間違い
公開: 2020-09-30WordPressプラグインまたはテーマを作成したいですか? プラグインとテーマの開発を成功させるには、試行錯誤が必要であることに注意してください。 最も経験豊富な開発者でさえ、コードを台無しにすることがあります。間違いを完全に回避することは不可能ですが、簡単に回避できる一般的なエラーがいくつかあります。 あなたを助けるために、私はあなたのWordPressプラグインまたはテーマを開発するときに避けるべき9つの一般的な間違いを集めました。
間違い#1:迅速な解決策を優先して品質を犠牲にする
一部の開発者は、小さなプラグインやテーマを開発するときにショートカットを見つけようとします。 彼らは一貫性のないコーディングを行い、最も簡単で最速のソリューションを見つけようとします。
ただし、実際には、高度で機能性の高いプラグインまたはテーマを開発する簡単な方法はありません。 一部のプラグインとテーマは、比較的迅速かつ簡単に開発できます。 たとえば、すべての管理者通知を非表示にするプラグインや、JavaScriptスニペットを挿入するプラグインを開発するのにそれほど時間はかかりません。 ただし、より複雑なプラグインやテーマに関しては、「不正行為」やコピーによって機能が低下したり、さまざまなエラーやパフォーマンスの欠陥が発生したりする可能性があります。
プラグイン/テーマのプロトタイプを作成するだけの場合でも、整理されたコーディングのベストプラクティスに従うことが重要です。 最も人気のある製品の多くはプロトタイプとして始まったことを忘れないでください。 「迅速で汚い」アプローチを採用すると、初日から技術的負債の蓄積が始まります。
クリーンで、適切に記述され、最適化されたコードを開発すると、開発時間が10〜30%増加しますが、長期的には間違いなく価値があります。 一日の終わりには、メンテナンス可能で、パフォーマンスが高く、機能的なプラグインまたはテーマを入手できます。
間違い#2:コード変更の追跡に失敗する
コードの変更を追跡できないことは、すべてのWordPress開発者が避けるべきもう1つのよくある間違いです。 プロジェクトの唯一の開発者であるかどうかに関係なく、すべてのテーマとプラグインはバージョン管理下で管理する必要があります。
プロジェクトの唯一の開発者であるかどうかに関係なく、すべてのテーマとプラグインはバージョン管理下で管理する必要があります。
バージョン管理システムは、すべての変更を記録および追跡することで役立ちます。 これにより、あなたや他の開発者は、テーマやプラグインがさらに開発されるのと同じプロジェクトで作業することができます。 また、Gitなどのバージョン管理システムは、各開発者が行ったすべての変更を登録します。これは、大規模なプロジェクトで作業する場合に特に便利です。 Gitを使用する場合は、リリース管理の健全な分岐ワークフローとしてGitFlowを使用することをお勧めします。
間違い#3:名前空間を使用できない
名前空間は、変数、クラス、および関数のグループに対して個別の領域を作成する必要がある場合に役立ちます。 これにより、バージョンPHP 5.6以前に存在し、名前空間を使用して制御できなかったプラグインの競合が防止されます。
これは、JavaScriptのgeometryと呼ばれる名前空間を示すソースコードの例です。 このパッケージの定義により、クラスCircleを、他のプログラマーが定義できる他のクラスと区別することができます。
namespace Geometry; class Circle { private $radius; public circle($r) { $radius = $r; } public get_radius() { return $radius; } public get_area() { return pi() * $radius * $radius; } }
間違い#4:WordPressナンスを利用していない
最新のセキュリティ慣行に従うことは、プラグインまたはテーマの機能を確保することと同じくらい重要です。 WordPressはナンスを使用して、リクエストの信頼性を検証するためのある程度の保護を提供します。 ノンスは、クロスサイトリクエストフォージェリ(CSRF)攻撃を防ぐのに特に役立ちます。
ナンスを作成するには、次の関数を使用します。
$nonce= wp_create_nonce( 'name');
ナンスに慣れていない場合は、このWordPressコードリファレンスを確認してください。
購読して、無料のコピーを入手してください
WordPressプラグインビジネスブック
サブスクリプションエコノミーで繁栄するWordPressプラグインビジネスを作成する正確な方法。
友達と共有する
友達のメールアドレスを入力してください。 スカウトの名誉であるこの本だけをメールで送ります。
共有していただきありがとうございます
素晴らしい-「WordPressプラグインビジネスブック」のコピーが送信されました。 私たちがもっと言葉を広めるのを手伝いたいですか? 続けて、その本を友達や同僚と共有してください。
購読していただきありがとうございます!
-「WordPressプラグインビジネスブック」のコピーをに送信しました。
メールにタイプミスがありますか? メールアドレスを編集して再送信するには、ここをクリックしてください。
購読して、無料のコピーを入手してください
WordPressプラグインビジネスブック
サブスクリプションエコノミーで繁栄するWordPressプラグインビジネスを作成する正確な方法。
友達と共有する
友達のメールアドレスを入力してください。 スカウトの名誉であるこの本だけをメールで送ります。
共有していただきありがとうございます
素晴らしい-「WordPressプラグインビジネスブック」のコピーが送信されました。 私たちがもっと言葉を広めるのを手伝いたいですか? 続けて、その本を友達や同僚と共有してください。
購読していただきありがとうございます!
-「WordPressプラグインビジネスブック」のコピーをに送信しました。
メールにタイプミスがありますか? メールアドレスを編集して再送信するには、ここをクリックしてください。
間違い#5:WordPressのコア機能を利用していない
多くの開発者は、既存のWordPressコア機能の可能性を最大限に活用できていません。 一部のテーマとプラグインには、カラーピッカーやjQueryなどのWordPressコアファイルに対応するファイルがあります。
追加のファイルを作成すると、パッケージの最終的なサイズと読み込み時間が長くなります。 これらのファイルを定期的に保守および更新する必要がありますが、これにも時間と労力がかかります。
WordPressが提供するものを利用することで、より軽量で機能的なテーマやプラグインを作成できます。
間違い#6:JavaScriptファイルとCSSファイルをキューに入れる
JavaScriptファイルとCSSファイルが不要なときにキューに入れることは、もう1つのよくある間違いです。 これにより、キューに入れられたすべてのファイルが追加のHTTPリクエストを追加するため、読み込み時間が遅くなり、検索エンジンのランキングが低下する可能性があります。
間違い#7:高度なテーマのためにJavaScriptコードを単一のメインファイルに配置する
JavaScriptを多用する高度なテーマを開発している場合は、JavaScriptコードを単一のメインファイルに配置しないことをお勧めします。 多くの開発者は、WordPressテーマのJavaScriptコードをmain.js、theme.js、またはcustom.jsという1つのメインファイルに配置することを選択します。 あなたがそれをしたくない理由はいくつかあります。 まず、テーマが最終的に大きくなるにつれて、ファイルのサイズも大きくなります。 このファイルはサイト全体に読み込まれるため、すべてのページの読み込みに時間がかかります。
次に、単一のファイルを作成すると、コードの管理が難しくなります。 たとえば、速度を向上させるために、wp_dequeue_script()などの関数を配置して、一部のページでコードをアンロードすることはできません。
これは、そのトピックについてもう少し説明するビデオです。
この間違いは、複雑なJavaScript構造を持つ高度なテーマにのみ関連することに注意してください。 JavaScriptでテーマがよりシンプルで軽量な場合、JavaScriptコードをメインファイルに配置しても、テーマの機能が損なわれることはありません。
間違い#8:コードを変更するための追加オプションを作成できない
コードに対して直接自動更新を実行すると、アクションとフィルターを使用して変更しない限り、手動によるコードの変更はすべて失われます。 そのため、変更のアクションとフィルターを有効にすることが非常に重要です。
このようにして、あなたや他の開発者は、プラグイン自体や親テーマを編集せずに機能を変更できるようになります。 さらに、フィルターとアクションを使用して、拡張機能やアドオンなどの追加機能を親プラグインまたはテーマに追加できます。
間違い#9:最新のコード設計手法を使用できない
正しいコード設計手法を使用しないことは、リストを閉じる最後の間違いです。 プラグインのサイズと性質に応じて、適切なコード構成を選択する必要があります。
それ以上の拡張を必要としない小さな単一目的のプラグインを構築することを計画している場合は、後で、さまざまなクラスで複雑なアーキテクチャを使用する必要はありません。
他のプラグインまたは多くのコードを必要とするプラグインで動作するプラグイン拡張機能を構築している場合は、オブジェクト指向プログラミング(OOP)アプローチを使用することをお勧めします。 OOPの背後にある主なアイデアは、より良い編成のためのクラスのように、コードをチャンクに配置することです。
また、PHPコードとHTMLコードを一緒に混合することはお勧めしません。 特にプラグインが複数の開発者によって保守されている場合は、Model-View-Controller(MVC)パターンを使用してそれらを分離しておくことをお勧めします。
要点
上で学んだように、最も一般的な間違いは通常、意図的ではありませんが、非常に残念な結果につながる可能性があります。
レビューでは、最も一般的な間違いは次のとおりです。
- 迅速な解決策を優先して品質を犠牲にする
- コード変更の追跡に失敗する
- 名前空間を使用できない
- WordPressナンスを利用していない
- WordPressのコア機能を利用していない
- JavaScriptおよびCSSファイルのエンキュー
- 高度なテーマのためにJavaScriptコードを単一のメインファイルに配置する
- コードを変更するための追加オプションを作成できない
- 最新のコード設計手法を使用できない
間違いを犯すことは避けられませんが、間違いが何であるかがわかったので、間違いを避けやすくなります。
テーマやプラグインを作成するときに他の間違いをしましたか? 以下のコメントであなたの経験を共有してください、そして避けるべきこれらの他の5つの間違いをお見逃しなく。
AlyseFalkからの寄稿。