Skip to content

nyaataco/ZipcodeManager

Repository files navigation

郵便番号エリア判定アプリ

郵便番号からサービス対応エリアかどうかを判定する WordPressプラグイン です。
管理画面から郵便番号を登録し、訪問ユーザーが入力した郵便番号がサービス提供エリアかどうかを判定します。

特定地域に限定したサービス(例:宅配、訪問サービス、地域限定キャンペーンなど)を提供する 小規模事業者 を想定して設計しました。
郵便番号から住所を判定するために、ZipCloud API を利用しています。

管理画面で郵便番号を登録後、JSONとして出力したものを判定に利用するので、固定ページを使うユーザはAPIのレスポンスに影響されません。


機能概要

管理画面

  • 郵便番号を入力すると、APIから住所を取得し、サービス対応エリアとして登録可能
  • 登録されたデータは WordPress のデータベースに保存され、JSON形式でも出力されるため、他システムとの連携も可能
  • 管理画面から簡単に登録・削除・確認が可能

個別ページ

  • ショートコード [zipcode_search] を設定することで、個別ページで利用可能
  • ユーザーが入力した郵便番号から、サービス対象エリアかどうかを判定
  • 対象エリア外の場合はその旨を表示

技術スタック

  • WordPress(管理画面カスタマイズ)
  • PHP(データ処理・API連携)
  • API連携(住所取得、ZipCloud API
  • JSONファイル出力

使い方

  1. このプラグイン(ZipcodeManager)をダウンロード
  2. WordPress の wp-content/plugins に配置
  3. プラグイン管理ページで「Zipcode Manager」を有効化
  4. 管理画面左メニューに「郵便番号管理」が追加されます

プラグイン管理ページで「Zipcode Manager」を有効化

管理画面左メニューに「郵便番号管理」が追加されます


表示メッセージのカスタマイズ

判定時に表示されるメッセージは自由に変更可能です。
初期設定では以下のように表示されます:

  • 対象エリア内:「〇〇はサービス対象エリアです。」
  • 対象エリア外:「申し訳ありません。対象外のエリアです。」

例:「〇〇市のデリバリーはお任せ!」など、自由に変更できます。


郵便番号の登録方法

  1. 郵便番号を入力し、「住所を取得」ボタンをクリック
  2. 表示された住所を確認し、必要に応じて表示名を変更
  3. 「保存」ボタンで登録完了

管理画面のイメージ:

管理画面のイメージ


郵便番号検索→保存イメージ:
管理画面のイメージ



個別ページへの登録方法

検索フォームを使用したいエリアにショートコード [zipcode_search] を設定してください。

管理画面のイメージ



個別ページでの使い方

郵便番号入力フォームに郵便番号を入力し、「検索」ボタンを押すと、サービス対象エリアかどうかが表示されます。

画面サンプル:

画面サンプル


使用例:

使用例



その他

  • 登録データは WordPress のデータベースに保存され、
  • zipcode-data ディレクトリに JSON 形式で書き出されます
  • 個別ページの表示部分はシンプルに設計しており、カスタマイズも容易です

注意事項

  • 本プラグインは ZipCloud API の利用規約に同意の上、非営利目的で使用しています
  • 本プラグインはポートフォリオ用に作成されたものです。利用に伴ういかなる事象にも作者は責任を負いません
  • このコードは Copilot と共に作成しました

About

郵便番号から対象エリアかどうかを判定するwordpressプラグインです

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors