WordPressのカスタマイズ方法やプラグインレビューを中心に、パソコン/動物/植物のことなどを紹介するホームページです
Plugin "WP Help" that allows you to create and display site operation manuals and help on the management screen

管理画面にサイトの操作マニュアルやヘルプを作成・表示できるプラグイン「WP Help」

公開日: バックエンド(管理)

WordPressで作ったサイトを複数の人で管理したり投稿したりする場合、操作マニュアルは必須ですよね。そんなときどうされていますか??

  1. 別にPDFなどでマニュアルファイルを作って配布する
  2. マニュアル用に別のサイトを用意する(下階層に非公開の別のWordPressを置く)
  3. 同一サイト内にカスタム投稿タイプを作り、パスワード保護や非公開で作る
  4. 特にマニュアルを持たず、都度メールや電話などで問い合わせに応じる

個人的には2か3が現実的だと思うのですがいかがでしょうか?

でも2だと第三者が見れないようにアクセスの制限をしたり、ユーザーの管理も必要になってきますから維持が面倒な気がしますし、3についても管理画面から直接閲覧できませんから、別にメニューを用意したり、アクセスの制限をしたりというのが必要になりますから、やはり面倒だと思います。

そんなときにおすすめなのが、今回紹介する「WP Help」。「WP Help」は管理画面のメニュー内にマニュアルページへのリンクを表示し、その場でマニュアルを見ることができるプラグイン。ちょっと他にはない、便利なプラグインです。

【WP Help】プラグインの用途や機能

公式ページには画像が1枚しかなく、イメージが湧かないと思いますので、画像を交えて機能を紹介します。

まずは、インストール後「投稿ヘルプ」というメニューをクリックして、マニュアル1というコンテンツを表示させた例(「ヘルプトピック」下のページはテストで任意に作ったものです)

このように「ヘルプトピック」の下にある「マニュアル1」をクリックすると、右側に即座にマニュアルが表示されます

また「ヘルプトピック」という文字列の上には設定 管理 新規追加というボタンがあり、

  • 設定・・・「投稿ヘルプ」「ヘルプトピック」文字列の変更、マニュアルリンクの表示位置、同期ソースの設定(これについては後述します)ができます
  • 管理・・・普通の投稿や固定ページの一覧と同じような画面で、マニュアルの編集などができます
  • 新規追加・・・普通の投稿や固定ページと同様にマニュアルの作成ができます

といったことができます。各画面は以下の通りです(投稿追加画面は割愛します)

本ページを最後に編集したときの環境・バージョンなど

プラグインは製作者によって日々更新されていくため、この紹介記事が最新バージョンのものであるとは限りません。参考までにこの記事の最終更新日時点におけるテスト環境、プラグインバージョン、プラグイン導入時の留意点などを記載しておきます。

プラグインを使用(試用)したテスト環境

  • テストサーバー:カラフルボックス管理画面にサイトの操作マニュアルやヘルプを作成・表示できるプラグイン「WP Help」の画像|Knowledge Base
  • WordPressのバージョン:5.5.1
  • PHPのバージョン:7.4.6
  • テーマ:ha-Basic(オリジナルテーマ)
  • プラグインのバージョン:記事更新時のバージョン  1.7.0/最新バージョン 1.7.0

本記事を参考にWordpressサイトへプラグインの導入を検討される方へ

Wordpressは古くから無料で配布されているサイト作成ツール(CMS)で、随時改良が加えられており、さまざまなバージョンが存在します。さらにWordpressを動かすためのプログラムであるPHP、サイトのデータを保存しておくためのデータベースについても様々なバージョンがあります。そしてWordpress本体同様にプラグインについてもさまざまなバージョンが存在します。本記事を参考にプラグインの導入をお考えの方は、以下に留意の上でインストールするようにしてください。
  • テスト環境での動作に基づいた紹介記事ですので、すべての環境で正常に動作するかどうかは不明です
  • ※本記事の内容についてはページ内に記載しているプラグインバージョンのものになります。現在のバージョンと異なる場合、機能などが異なる場合があります。※また、ページによってはテスト環境、テストしたプラグインバージョン等の表示が本文内にない場合、ページタイトル下にある最終更新日当時の情報となりますので、現在のバージョンでは全く違う機能となっているかも知れません。
  • プラグインに無料版と有料版(Pro版)がある場合、特に記載がなければ無料版の情報のみを紹介しています
  • このページでプラグインを使用する際に必要なショートコードやコードなどは、コピーして使用することができますが、環境によっては記号などが文字化けすることがあります。コピーしたのに動作しない場合は特に「”」「’」などの記号を入力し直してみてください。
  • プラグイン本体の動作不具合や質問などは公式サイトのフォーラムなどで行ってください(ここでは質問にお答えすることはできません)

【WP Help】プラグインの設定画面や表示画面の日本語化と翻訳

【WP Help】プラグインは有効化すると日本語で使用できるようになっていますので、英語が分からない方でも安心して使えます

【WP Help】プラグインのインストールと設定

インストール方法

インストールはプラグインの新規追加でプラグイン名で検索してインストールするか、ページ先頭の画像をクリックして表示されるWordpressのプラグイン公式配布ページがダウンロードしてからアップロードインストールします。

インストール方法の詳しい解説は

を参照ください

基本的な設定方法と使用方法

設定や基本的な使い方については上の用途や機能で紹介した通りですから、WordPressで投稿の追加などができる(このプラグインにたどり着いた方は当然できると思いますが・・)触ってみていただければ理解できると思います。

また、固定ページと同じように、編集画面で親子の設定をすれば階層構造を持たせることができるところも便利だと思います。

それからもう1つ便利な機能があります。それは「同期」という機能。あるサイト(メインサイトとします)で作ったマニュアルを、【WP Help】がインストールされている他のサイト(副サイト)へ波及させることができるようになっています。

やり方は、前述した設定画面で

メインサイトの「同期ソース」(青枠部分)に表示されているコードを、副サイトの「同期プル」欄へコピーするだけです。

そうしておくと、1日1回定期的に、副サイトはメインサイトのマニュアルを更新しにいくようになり、メインサイト側のマニュアルを変更すれば副サイトは常に最新のマニュアルを保つことができます。

また、同期されるのはメインサイトと副サイト両方にある部分だけなので、副サイトで独自に作ったマニュアルはそのまま維持されるようになっているのも秀逸なところだと思います

※同期についてはテストではうまくいきましたがお使いの環境でよくチェックしていただくことをおすすめします

【WP Help】プラグインの便利な使い方・カスタマイズ方法など

このプラグインをより便利に使うカスタマイズ技、テストサイトで使用した結果や感想、Wordpressのプラグイン公式配布ページには書かれていない情報、発見した不具合などを紹介します。

管理者だけに内容を表示する方法

前述したようにこのプラグインは、投稿権限のあるユーザーがすべてのマニュアルを見られる状態になっています。これがログインしたユーザーの権限によって制限できたら・・というところは今後の更新に期待したいところではありますが、バージョン1.7.0の段階で管理者だけに内容を表示させたい!という方もいらっしゃるでしょう(多分実用としてはこれが必要)。

そこで簡単なアクセス制限をかけて、管理者のみに内容を表示する方法を紹介しておきます。

※他の権限の人には内容を表示しないというものですので、

  • メニュー一覧にはメニュー自体が表示される
  • マニュアルページを開くことはできる
  • 開いたページ内で管理者向けの内容のみ他権限では出力されないようにする

という形になりますので悪しからず。また、今後プラグインを更新しても大丈夫なように、プラグインのプログラム自体に改変は加えません。

テーマのfunctions.phpへ以下のコードを追加します

/******if-adminショートコードで管理ユーザーのみにコンテンツを表示**********/
if ( !function_exists( 'hab_admin_show' ) ):
function hab_admin_show( $atts, $content = null ) {
if(current_user_can( 'administrator' )) {
$content = do_shortcode( shortcode_unautop( $content ) ); //ショートコードの中にショートコードがあっても実行するようにするコード
return '' . $content . '';
} else {
return '';
}
}
add_shortcode('if-admin', 'hab_admin_show');
endif;

そしてマニュアルの編集画面で、管理者権限を持つユーザーだけに表示させる内容を以下のショートコードで囲みます

[if-admin]
この間に管理者のみ表示するコンテンツを作る
[/if-admin]

これだけで、マニュアル本文内のコンテンツを管理者だけに表示する(管理者以外には表示させないようにする)ことができます。

今回は管理者権限だけ・・としましたが、公式コーデックなどで条件について調べていただければ、さらに細かい制限ができますから、用途に合わせてカスタマイズのチャレンジをしてみてください。

また、このカスタマイズは、このプラグインに限ったことではなく、通常の投稿や固定ページの本文でショートコードを使うことで、通常訪問者に表示されるページでも、その部分は管理者のみに限定して出力することができます(訪問者や他の権限の人にはソース上も表示されませんから、ソース表示して内容を見られる心配もありません)。

いちばんやさしいWordPressの教本 第4版 5.x対応 人気講師が教 える本格Webサイトの作り方 (「いちばんやさしい教本」シリーズ)
インプレス
大きな画面の操作手順で迷わない。人気のテーマで、パソコン&スマホ両対応のWebサイトを作れる!ソーシャルメディアとの連携やSEO対策、バックアップなどの運用面も丁寧に解説。
※表示している価格は単行本のものです
参考価格:1,738
※参考価格です。サービスやショップ、掲載時期などにより価格は異なりますのでご注意ください

WordPressのカスタマイズ・不具合対応などご相談ください

Wordpressのカスタマイズ、不具合解消のご相談はすべてココナラのダイレクトメッセージからお受けしております。まずはこちらのバナーからお気軽にお問い合わせください。

【スポンサーリンク】