Hamelp

描述

This plugin add new custom post type ‘FAQ’. With some functionality, you can build help center for your user.
What is help center? We collect examples at our github wiki.

Creating Portal

This plugin will provide…

• Custom post type with single page and archive page.
• Custom taxonomy associated to CPT.
• Incremental search box.
• AI Overview(Since 2.0.0)

AI Overview

AI Overview answers user questions based on your FAQ content using a large language model.
It uses the wp-ai-client bundled with WordPress core since WordPress 7.0, which requires an AI service to be configured in WordPress.

Requirements: AI Overview requires WordPress 7.0 or later. On older WordPress versions, the AI Overview block and template function will still appear in the editor and on the front-end, but the search form will not work (the REST endpoint that powers it is disabled). Other features of this plugin (FAQ custom post type, incremental search, shortcode) continue to work on WordPress 6.6+. Upgrade WordPress to 7.0 to enable AI Overview.

You can configure AI behavior and rate limiting from Settings > Hamelp in the admin panel. The settings page also includes a Rebuild Catalog Now button to manually refresh the FAQ catalog used as LLM context.

Using the Block

Add the AI FAQ Overview block in the block editor. The block has the following options:

• Placeholder — Input placeholder text.
• Button Text — Submit button label.

• Show Sources — Display related FAQ links below the answer.

  Using the Template Function

You can also use hamelp_render_ai_overview() in your theme templates:

<?php echo hamelp_render_ai_overview(); ?>

The function accepts an optional array of arguments:

<php
echo hamelp_render_ai_overview( [
    'placeholder'  => 'Ask a question...',
    'button_text'  => 'Ask AI',
    'show_sources' => true,
] );
?>

The function automatically enqueues the required JavaScript and CSS assets.

Search Box

The incremental FAQ search box is available in three forms.

Using the Block

Add the FAQ Search Box block in the block editor. The block has the following options:

• Label — Input placeholder text.

• Button Text — Submit button label.

  Using the Shortcode

You can use shortcode hamelp-search in page content.

[hamelp-search label='Enter your question here.'][/hamelp-search]

Using the Template Function

You can also call hamelp_render_search_box() directly from your theme templates:

<?php echo hamelp_render_search_box( [
    'label' => 'Enter your question here.',
    'btn'   => 'Search',
] ); ?>