Install
Upload it under Plugins → Add New Plugin → Upload Plugin, then activate.
Install straight from GitHub with WP-CLI:
wp plugin install https://github.com/vektor-inc/vk-add-link-parameter/releases/download/0.1.0.0/vk-add-link-parameter.zipWordPress サイト内のすべてのリンク (<a>) やフォーム (<form>) に、指定した URL パラメータ(例: vwaf)を自動的に追加するプラグインです。
アフィリエイトパラメータやキャンペーントラッキング、または独自のパラメータを引き回す用途に便利です。
主な特徴
- クエリパラメータ(例:
vwaf)が URL に存在する場合、その値をすべてのリンクとフォームに自動付与します。 - フォーム送信時は、hidden input としてパラメータが自動挿入されます。
- JavaScript と PHP で構成されており、設置・運用がシンプルです。
インストール方法
vk-add-link-parameter.zipを WordPress のプラグインディレクトリにアップロードして展開します。- WordPress の「プラグイン」画面から有効化します。
- プラグインが自動で動作を開始します。
動作仕様
- パラメータ名は現状「vwaf」で固定されています(必要に応じてソースコードを編集してください)。
- 標準的な
<a>および<form>タグであればカスタム投稿やカスタムフォームでも動作します。 - サイト全体の公開ページで自動的に動作します。
開発者向け
PHP の関数名やクラス名、変数名の接頭辞は valp または VALP です。(仮)
( .phpcs.xml の WordPress.NamingConventions.PrefixAllGlobals を参照 )
(例)
function valp_display_aaaa() {
echo 'aaaa';
}
$valp_number = 1;
テキストドメインは vk-add-link-parameter です。(仮)
( .phpcs.xml の WordPress.WP.I18n を参照 )
PHP Unit Test はの中身は空のようですが、一応 vektor-inc/vk-wp-unit-test-tools が走るようになっています。
リリース時は4桁のタグを打てばリリースされます。
( .github/workflows/deploy.yml の on:push:tags を参照 )
(例)
git tag 1.11.11.0
git push origin 1.11.11.0
コマンドについて
初回のみ下記操作が必要です
npm install
composer install
npm run buildでビルドされます。npm run distでdist/vk-add-link-parameterにリリース用のディレクトリが生成されます。npm run zipでdist/vk-add-link-parameterの内容を zip で圧縮します。npm run make:zipはnpm run distとnpm run zipを順番に実行します。npm run lint:phpで PHP の lint ( phpcs ) が走ります。npm run format.phpで PHP のフォーマット ( phpcbf ) が走ります。npm run lint:jsで JS 等の lint やフォーマットが走ります。npm run phpunitで PHP Unit が走ります。 ( 現状ベクトルの Fatal Error テストのみ )
免責事項・ライセンス
GPLv2 もしくはそれ以降のバージョンで配布しています。
開発元: Vektor,Inc.
Releases
1 release. Each count is every asset in that release; expand a row for the breakdown.