Title: WP Help
Author: Mark Jaquith
Published: <strong>2011 年 5 月 18 日</strong>
Last modified: 2024 年 4 月 20 日

---

搜索插件

![](https://ps.w.org/wp-help/assets/banner-772x250.png?rev=2938042)

**该插件尚未通过WordPress的最新3个主要版本进行测试**。 当与较新版本的WordPress一起
使用时，可能不再受到维护或支持，并且可能会存在兼容性问题。

![](https://ps.w.org/wp-help/assets/icon.svg?rev=2938042)

# WP Help

 作者：[Mark Jaquith](https://profiles.wordpress.org/markjaquith/)

[下载](https://downloads.wordpress.org/plugin/wp-help.1.7.5.zip)

 * [详情](https://cn.wordpress.org/plugins/wp-help/#description)
 * [评价](https://cn.wordpress.org/plugins/wp-help/#reviews)
 *  [安装](https://cn.wordpress.org/plugins/wp-help/#installation)
 * [开发进展](https://cn.wordpress.org/plugins/wp-help/#developers)

 [支持](https://wordpress.org/support/plugin/wp-help/)

## 描述

Site operators can create detailed, hierarchical documentation for the site’s authors,
editors, and contributors, viewable in the WordPress admin. Powered by Custom Post
Types, you get all the power of WordPress to create, edit, and arrange your documentation.
Perfect for customized client sites. Never send another “here’s how to use your 
site” e-mail again!

**NEW**: You can now pull in help documents from another WP Help install, and they
will be automatically updated when the source documents change (even additions and
deletions!). Perfect for WordPress multisite installs, or consultants with a large
number of client installs.

## 屏幕截图

 * [[
 * The Publishing Help screen, which lists and displays available help documents.

## 安装

 1. Upload the `wp-help` folder to your `/wp-content/plugins/` directory
 2. Activate the “WP Help” plugin in your WordPress administration interface
 3. Visit “Publishing Help” in the menu to get started (note that you can change the
    location and title of this menu item)

## 常见问题

### Who can view the help documents?

Anyone who can save posts. So by default, Authors, Editors, Administrators, and 
Contributors

### Who can edit the help documents?

Anyone who can `publish_pages`. So by default, Editors and Administrators.

### How do I reorder the documents?

Just like you’d reorder pages. Change the `Order` setting for the page, in the `
Attributes` meta box. To make something be first, give it a large negative number
like `-100`.

### How do I link to another help page from a help page?

Use WordPress’ internal linking feature. When launched from a help document, it 
will only search for other help documents.

### How do I change the default help document?

Edit the help document you want to be the default. Check the “Set as default help
document” checkbox, and save. This will now be the default document.

### Why can’t I edit some documents?

Documents that came from another WP Help install that is currently connected, cannot
be edited (your changes would just be overwritten anyway). In order to edit these
documents, you need to disconnect from sync permanently, or edit the at their source
WP Help install.

### Will enabling sync delete my existing documents?

Enabling sync will delete any documents that came in via another sync source. **
But it will not delete locally-created documents.**

### Can I have multiple sync sources?

Not right now. But what you can do, is have a WP Help install that aggregates another
WP Help install and is then itself used as a source for the combination of the two
sites docs, to be delivered to a third site.

### Why can’t I reorder some docs using drag and drop?

You cannot internally sort synced documents — just move the whole “chunk” of synced
documents around.. Also, if a local help document is the only document in its level,
it won’t get a drag handle, because there’s nothing to reorder. Give it a sibling,
and you’ll be able to order them how you like.

## 评价

![](https://secure.gravatar.com/avatar/d1240bcdb1b04edb15eb0b6f34f7ad7d3c3e2cf3ac3c3413f2dde28443e96b82?
s=60&d=retro&r=g)

### 󠀁[This is great!](https://wordpress.org/support/topic/this-is-great-139/)󠁿

 [Morten Ellegaard Larsen](https://profiles.wordpress.org/ellegaarddk/) 2025 年 
4 月 8 日

For an agency delivering a lot of websites for users with little or no knowledge
of WordPress, this is a gem!I can combine general docs from a central hub, so I 
only have to maintain it one place, with local docs for the customized functions.
It’s simple, but I can use most blocks in the help documents.

![](https://secure.gravatar.com/avatar/88785161325d783588deba7eecbe48eea6cb98ba2053133ac7639c8090f7b467?
s=60&d=retro&r=g)

### 󠀁[Doesn’t work on Siteground hosting due to sever-level security rule](https://wordpress.org/support/topic/doesnt-work-on-siteground-hosting-due-to-sever-level-security-rule/)󠁿

 [Brian Shim](https://profiles.wordpress.org/brianrshim/) 2025 年 3 月 28 日

I noticed that the images, CSS, and JS files were not loading properly (had 403 
error) in the admin page for this plugin for my sites on Siteground hosting, so 
I contacted Siteground. Long story short, they have a security rule which blocks
the WP Help directory due to a previous security issue. Although the plugin will
technically still work, the images and formatting will be messed up, and you can’t
save your preference settings. If you get on chat with SG and get a ticket created,
a senior dev can disable this security setting to get WP Help to work properly, 
but it’s kind of a big pain.

![](https://secure.gravatar.com/avatar/0ab2881fc72a282455206a160d2872ad32b90d4ff01bd580c8150c03f76cbcc1?
s=60&d=retro&r=g)

### 󠀁[Very Useful plugin – great for managed hosting](https://wordpress.org/support/topic/very-useful-plugin-great-for-managed-hosting/)󠁿

 [corpconv](https://profiles.wordpress.org/corpconv/) 2024 年 6 月 13 日

This is an amazing plugin – the kind of thing you don’t know you need. For managed
hosting, it’s perfect. I’ve created help articles for clients on our own website
and I can push them out to all our hosted sites – how to create a new post, how 
to add a user, how to add a page to the menu, etc. I can also tailor how-to docs
to a specific website and add them just to that website. Best of both worlds. Please
keep this up – it’s saving me a ton of time and effort with client support. A+

![](https://secure.gravatar.com/avatar/cd257f389c91f137dab25f343b527123e887135b01921ebb6206e40cfa2eb636?
s=60&d=retro&r=g)

### 󠀁[Used for many years](https://wordpress.org/support/topic/used-for-many-years/)󠁿

 [Knut Sparhell](https://profiles.wordpress.org/knutsp/) 2024 年 5 月 16 日

This is one of the best plugins you can find. Does what is says, clean and nice.
The sync feature is just elegant, bust also very useful. Good for anyone, and a 
must have for agents and their clients.

![](https://secure.gravatar.com/avatar/989824b0e7508599671c7f979acc5f858c1a8313c0ae0e6a11a5d26bb3639805?
s=60&d=retro&r=g)

### 󠀁[So helpfull!](https://wordpress.org/support/topic/so-helpfull-10/)󠁿

 [Cyrille Sanson](https://profiles.wordpress.org/css31/) 2024 年 4 月 12 日

Congratulations on this practical plugin. Make a habit of installing it at the start
of a site’s development and add the important points for the site’s documentation
as you go along. Who hasn’t found themselves at a loss when returning to a site 
3 months later, having forgotten why a particular extension was installed or a particular
organisation chosen?

![](https://secure.gravatar.com/avatar/aa1afcfa60b2a6b6dae5253c638fe7e826608c35ba93e0e43186601006f2b4ec?
s=60&d=retro&r=g)

### 󠀁[Perfect for easily creating end user docs](https://wordpress.org/support/topic/perfect-for-easy-creating-of-end-user-docs/)󠁿

 [dgroskind](https://profiles.wordpress.org/dgroskind/) 2023 年 9 月 10 日

You can start creating documentation within a minute of installing the plugin. Intuitive
UI. A critical feature is being able to reorganize the menu of pages by dragging
them into place with the mouse.

 [ 阅读所有54条评价 ](https://wordpress.org/support/plugin/wp-help/reviews/)

## 贡献者及开发者

「WP Help」是开源软件。 以下人员对此插件做出了贡献。

贡献者

 *   [ Mark Jaquith ](https://profiles.wordpress.org/markjaquith/)

「WP Help」插件已被翻译至 20 种本地化语言。 感谢[所有译者](https://translate.wordpress.org/projects/wp-plugins/wp-help/contributors)
为本插件所做的贡献。

[帮助将「WP Help」翻译成简体中文。](https://translate.wordpress.org/projects/wp-plugins/wp-help)

### 对开发感兴趣吗?

您可以[浏览代码](https://plugins.trac.wordpress.org/browser/wp-help/)，查看[SVN仓库](https://plugins.svn.wordpress.org/wp-help/)，
或通过[RSS](https://plugins.trac.wordpress.org/log/wp-help/?limit=100&mode=stop_on_copy&format=rss)
订阅[开发日志](https://plugins.trac.wordpress.org/log/wp-help/)。

## 更新日志

#### 1.7.0

 * Block Editor (Gutenberg) support
 * Video display improvements
 * Smaller build

#### 1.6.0

 * CSS improvements (props @mrwweb).
 * Switch from CoffeeScript to ES6 and Babel.
 * Responsive styles.

#### 1.5.4

 * Bump supported WordPress version.

#### 1.5.3

 * Make add/manage buttons use proper permissions.
 * Update styles.
 * Bump minimum WordPress version.

#### 1.5.2

 * Make permissions more filterable.

#### 1.5.1

 * Fix a PHP error on the dashboard.

#### 1.5.0

 * Updated to Mark’s 2016 plugin framework for easier maintenance.

#### 1.4.1

 * More complete French translation.

#### 1.4

 * Added a Hebrew translation.

#### 1.3

 * Make the `wp_list_pages()` call filterable.
 * Added Serbian, Turkish, and Japanese translations.
 * Use a Dashicon for WordPress 3.8+.
 * RTL CSS styles.

#### 1.2

 * New or updated translations for Gujarati, Norwegian, and Brazilian Portuguese.
 * CSS fixes for WordPress 3.5.
 * More robust AJAX saving when save events overlap.

#### 1.1

 * Feature: drag and drop reordering of the documents list.
 * Feature: local /wp-admin/ links are rewritten when shared through the API so 
   that they’re wp-admin-relative and thus work on the destination site.
 * Improvement: more consistent cap checks, so plugins can consistently customize
   who can do what.
 * Improvement: restore settings form to previous state when “cancel” is clicked.
 * Bug fix: sort order is now synced.

#### 1.0

 * Feature: sync help documents from another WP Help install.
 * Feature: rename the page title.
 * Feature: rename the document list title.
 * Feature: choose the location of the menu item (Dashboard submenu, or one of three
   top level positions).
 * Feature: easier access to creation, editing, and management of documents.
 * Feature: dashboard widget.
 * Improvement: better UI for selecting the default document.

#### 0.3

 * Translation for: French. Squashes a PHP Notice. Add an action hook so people 
   can add their own styles.

#### 0.2

 * Translations for: Bulgarian, German, Spanish, Mexican Spanish, Macedonian, Dutch,
   Brazilian Portuguese, and Russian.

#### 0.1

 * Initial version

## 额外信息

 *  版本 **1.7.5**
 *  最后更新：**2 年前**
 *  活跃安装数量 **10,000+**
 *  WordPress 版本 ** 4.9 或更高版本 **
 *  已测试的最高版本为 **6.5.8**
 *  语言
 * [Czech](https://cs.wordpress.org/plugins/wp-help/) 、 [Danish](https://da.wordpress.org/plugins/wp-help/)、
   [Dutch](https://nl.wordpress.org/plugins/wp-help/) 、 [English (US)](https://wordpress.org/plugins/wp-help/)、
   [Finnish](https://fi.wordpress.org/plugins/wp-help/) 、 [French (France)](https://fr.wordpress.org/plugins/wp-help/)、
   [German](https://de.wordpress.org/plugins/wp-help/) 、 [Gujarati](https://gu.wordpress.org/plugins/wp-help/)、
   [Hebrew](https://he.wordpress.org/plugins/wp-help/) 、 [Italian](https://it.wordpress.org/plugins/wp-help/)、
   [Latvian](https://lv.wordpress.org/plugins/wp-help/) 、 [Norwegian (Bokmål)](https://nb.wordpress.org/plugins/wp-help/)、
   [Portuguese (Brazil)](https://br.wordpress.org/plugins/wp-help/) 、 [Portuguese (Portugal)](https://pt.wordpress.org/plugins/wp-help/)、
   [Serbian](https://sr.wordpress.org/plugins/wp-help/) 、 [Spanish (Chile)](https://cl.wordpress.org/plugins/wp-help/)、
   [Spanish (Colombia)](https://es-co.wordpress.org/plugins/wp-help/) 、 [Spanish (Mexico)](https://es-mx.wordpress.org/plugins/wp-help/)、
   [Spanish (Spain)](https://es.wordpress.org/plugins/wp-help/) 、 [Spanish (Venezuela)](https://ve.wordpress.org/plugins/wp-help/)
   和 [Turkish](https://tr.wordpress.org/plugins/wp-help/).
 *  [翻译成简体中文](https://translate.wordpress.org/projects/wp-plugins/wp-help)
 * 标签
 * [client sites](https://cn.wordpress.org/plugins/tags/client-sites/)[clients](https://cn.wordpress.org/plugins/tags/clients/)
   [docs](https://cn.wordpress.org/plugins/tags/docs/)[documentation](https://cn.wordpress.org/plugins/tags/documentation/)
   [help](https://cn.wordpress.org/plugins/tags/help/)
 *  [高级视图](https://cn.wordpress.org/plugins/wp-help/advanced/)

## 评级

 4.8 星（最高 5 星）。

 *  [  48 条 5 星评价     ](https://wordpress.org/support/plugin/wp-help/reviews/?filter=5)
 *  [  5 条 4 星评价     ](https://wordpress.org/support/plugin/wp-help/reviews/?filter=4)
 *  [  0 条 3 星评价     ](https://wordpress.org/support/plugin/wp-help/reviews/?filter=3)
 *  [  0 条 2 星评价     ](https://wordpress.org/support/plugin/wp-help/reviews/?filter=2)
 *  [  1 条 1 星评价     ](https://wordpress.org/support/plugin/wp-help/reviews/?filter=1)

[Your review](https://wordpress.org/support/plugin/wp-help/reviews/#new-post)

[查看全部评论](https://wordpress.org/support/plugin/wp-help/reviews/)

## 贡献者

 *   [ Mark Jaquith ](https://profiles.wordpress.org/markjaquith/)

## 支持

有话要说吗？是否需要帮助？

 [查看支持论坛](https://wordpress.org/support/plugin/wp-help/)

## 捐助

您愿意支持这个插件的发展吗?

 [ 捐助此插件 ](http://txfx.net/wordpress-plugins/donate)