Contributors: Takahashi_Fumiki, hametuha
Tags: faq,help
Tested up to: 6.9
Stable Tag: 1.0.4
License: GPL 3.0 or later
License URI: https://www.gnu.org/licenses/gpl-3.0.html

FAQ template plugin by Hametuha.

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.

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 answers user questions based on your FAQ content using a large language model. It uses wp-ai-client (experimental) bundled via Composer, which requires an AI service to be configured in WordPress. Since wp-ai-client is still experimental, its API may change in future releases.

You can configure AI behavior and rate limiting from Settings > Hamelp in the admin panel.

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.

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.

You can use shortcode hamelp-search in page content.

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

And you can call in your theme altenatively.

<?php echo do_shortcode( '[hamelp-search][/hamelp-search]' ) ?>

Install itself is easy. Auto install from admin panel is recommended. Search with hamelp.

1. Donwload and unpack plugin file, upload hamelp folder to /wp-content/plugins directory.
2. Activate it from admin panel.

How can I contribute?

You can contribute to our github repo. Any issues or PRs are welcomed.

• Add AI Overview Feature.
• Bump minimum requirements: PHP >=7.4, WordPress >= 6.6

• Add structured data for FAQPage.

• Bugfix and change glocal functions.

• Fix taxonomy to be shown in Gutenberg.

• Fix no vendor directory bug.

• Initial release.