このプラグインは WordPress の最新3回のメジャーリリースに対してテストされていません。もうメンテナンスやサポートがされていないかもしれず、最新バージョンの WordPress で使用した場合は互換性の問題が発生する可能性があります。

Plugin Notes Plus

説明

立ち上げてから時間が経ったサイトを見て「なんでこのプラグインをインストールしたんだろう ?」と自問したことはありませんか。本プラグインは、プラグインページにカラムを追加し、サイト独自のプラグインに関するメモを追加、編集、削除できるようにします。特定のプラグインがインストールされた理由や、どこでどのように使用されているかといったドキュメント提供を想定しています。

機能

  • 各プラグインに必要な数のメモを追加します。
  • 好きなようにメモを編集または削除できます。
  • 選べるアイコンを各メモに表示し、メモに含まれるコンテンツの種類 (情報、警告、リンクなど) をすばやく伝えます。
  • お好みで、基本的な HTML タグを使用したフォーマットが可能です。
  • ノートに含まれるリンクは自動で target="_blank" に変換します。
  • メモの追加と更新は Ajax を使用、遅いページの再読み込みは不要です。
  • プラグインに更新がある際は、WordPress の更新ページにもプラグインのメモを表示します。
  • フィルターを使用して、別カラムではなく、プラグイン説明の下にメモを表示することもできます。
  • フィルターを使用して、管理画面のプラグインメモを選択的に表示または非表示にできます。

スクリーンショット

  • プラグインを有効化すると、プラグインページに新しいカラムが表示され、インストールしたプラグインについてのサイト独自のメモを追加、編集、削除できます。

インストール

  1. プラグインのインストールは、WordPress 管理画面のプラグインディレクトリからでも、.zip ファイルを手動アップロードし、解答して /wp-content/plugins/ に設置するのでも可能です。
  2. 「プラグイン」メニューからプラグインを有効化します。
  3. プラグインページの「プラグインメモ」カラムでメモを追加、編集、削除します。

FAQ

別カラムではなく、プラグイン説明の下にメモを表示できますか。

バージョン1.2.4以降、フィルター plugin-notes-plus_note_placement を使用してプラグイン説明の下にメモを移動できます。

以下は、プラグイン説明の下にプラグインメモを配置するスニペット例です。子テーマの functions.php にも追加できます。これがないと、メモの位置はデフォルトでプラグインページの別のカラムになります。

function pnp_change_note_placement( $note_placement ) {

    $note_placement = 'description';

    return $note_placement;

}
add_filter( 'plugin-notes-plus_note_placement', 'pnp_change_note_placement' );

プラグインメモの横に表示するアイコンは変更できますか。

はい、plugin-notes-plus_icon_options フィルターを使用して、アイコンセットの変更が可能です。アイコンは WordPress dashicons で利用可能なリストから選んでください。

これは、1つのアイコンを削除し、選択リストに追加アイコンを追加するスニペット例です。子テーマの functions.php に追加できます。

function pnp_change_icon_options( $icon_options ) {

    // Remove key option
    unset( $icon_options['dashicons-admin-network'] );

    // Add smartphone option
    $icon_options['dashicons-smartphone'] = 'Smartphone';

    return $icon_options;
}
add_filter( 'plugin-notes-plus_icon_options', 'pnp_change_icon_options' );

使用可能な HTML リストと、リストの変更方法について。

以下の HTML タグが使用できます: a, br, p, b, strong, i, em, u, hr.

使用可能なタグのリストを変更するには、フィルター plugin-notes-plus_allowed_html を使用します。ただし、サイトを XSS 攻撃に対して脆弱にする可能性のあるタグを許可しないよう注意してください。

function pnp_change_allowed_html_tags( $allowed_tags ) {

    // Remove br from allowed tags
    unset( $allowed_tags['br'] );

    // Add img to allowed tags
    $allowed_tags['img'] = array();

    return $allowed_tags;
}
add_filter( 'plugin-notes-plus_allowed_html', 'pnp_change_allowed_html_tags' );

データはどこに保存されますか。

プラグインメモとメモ用メタデータは、名前が plugin_notes_plus で終わるカスタムテーブルに保存されます。当初のバージョン (1.0.0) では、メモは options テーブルに保存されていました。バージョン1.1.0のリリースで、既存のメモは options テーブルから plugin_notes_plus に移行しました。バージョン1.1.1へアップグレードすると、options テーブルのクリーンアップとメモの削除を実行します。

マルチサイトでの動作について。

マルチサイト内の各サイトは、独自のプラグインメモを保持します。さらに、ネットワーク管理者は独自のプラグインメモを管理できます。

特定のユーザーにプラグインメモを非表示にできますか。

バージョン1.2.6以降、フィルター plugin-notes-plus_hide_notes を使用して、プラグインメモの表示、非表示が変更可能になりました。

特定のユーザーに対し、プラグインメモを非表示にするスニペット例です。子テーマの functions.php に追加できます。これがないと、プラグインメモは、プラグインページを表示できるすべてのユーザーにデフォルトで表示します。

function pnp_hide_notes( $hide_notes ) {

    // logic to set $hide_notes to TRUE or FALSE

    return $hide_notes;

}
add_filter( 'plugin-notes-plus_hide_notes', 'pnp_hide_notes' );

評価

2022年5月17日
Just what I needed to leave notes for the next webmaster. Works beautifully!
2022年4月11日
I was about to build something like this and was thrilled this plugin not only existed, but is very well done! Thank you!
52件のレビューをすべて表示

貢献者と開発者

Plugin Notes Plus はオープンソースソフトウェアです。以下の人々がこのプラグインに貢献しています。

貢献者

“Plugin Notes Plus” は7ロケールに翻訳されています。 翻訳者のみなさん、翻訳へのご協力ありがとうございます。

“Plugin Notes Plus” をあなたの言語に翻訳しましょう。

開発に興味がありますか ?

コードを閲覧するか、SVN リポジトリをチェックするか、開発ログRSS で購読してみてください。

変更履歴

1.2.6

  • Added: Option to selectively hide or display plugin notes. Thanks to @garconis for the suggestion.

1.2.5

  • Fixed: PHP warning caused by deprecated usage of wp_localize_script. Thanks to @brianhenryie for finding this.

1.2.4

  • Added: Option to display notes beneath plugin description. Thanks to @antipole for the suggestion.

1.2.3

  • Added: Money icon option. Thanks to @brianhenryie.

1.2.2

  • Added: Updates for RTL compatibility. Thanks to @ramiy.
  • Removed: Unnecessary po and mo translation files.

1.2.1

  • Fixed: JavaScript error that sometimes happened on update-core.php if a plugin had no notes. Thanks to @brianhenryie for bringing this to my attention.
  • Added: Hungarian translation. Thanks to @tomek00.

1.2.0

  • Added: Plugin notes now display in a read-only format on the WordPress Updates page (update-core.php). Thanks to @douglsmith for the suggestion.
  • Fixed: Removed unnecessary multisite hook. Thanks to @foomagoo for pointing this out.

1.1.2

  • Fixed: Bug that prevented user from adding or updating notes after an ajax response. Thanks to @anticosti for helping to identify this bug.
  • Added: Spinning icon to indicate that a note is in the process of being deleted.

1.1.1

  • Added: Cleanup routine to remove notes from the options table. (If upgrading from 1.0.0, notes will first be migrated into their own table.)

1.1.0

  • Fixed: Bug that caused plugin notes to disappear on Windows servers due to discrepancies in the plugin file path related to forward vs. backslash. This update will recover missing notes. Thanks to @gwalsh66 for helping to identify this bug.
  • Changed: Plugin notes will now be stored in a custom table called $wpdb->prefix . 'plugin_notes_plus'
  • Added: Migration routine to move notes from the options table into their own table if upgrading from version 1.0.0
  • Added: Entry in the options table called ‘plugin_notes_plus_db_version’ to track the custom database table version

1.0.0

  • Initial release