{"id":89654,"date":"2018-08-07T05:54:21","date_gmt":"2018-08-07T05:54:21","guid":{"rendered":"https:\/\/wordpress.org\/plugins\/hamelp\/"},"modified":"2026-05-21T06:12:02","modified_gmt":"2026-05-21T06:12:02","slug":"hamelp","status":"publish","type":"plugin","link":"https:\/\/kk.wordpress.org\/plugins\/hamelp\/","author":1143171,"comment_status":"closed","ping_status":"closed","template":"","meta":{"version":"2.2.2","stable_tag":"2.2.2","tested":"7.0","requires":"6.6","requires_php":"7.4","requires_plugins":null,"header_name":"Hamelp","header_author":"Hametuha INC.","header_description":"FAQ generator by Hametuha.","assets_banners_color":"838179","last_updated":"2026-05-21 06:12:02","external_support_url":"","external_repository_url":"","donate_link":"","header_plugin_uri":"https:\/\/wordpress.org\/plugins\/hamelp","header_author_uri":"https:\/\/hametuha.co.jp","rating":0,"author_block_rating":0,"active_installs":0,"downloads":1641,"num_ratings":0,"support_threads":0,"support_threads_resolved":0,"author_block_count":0,"sections":["description","installation","faq","changelog"],"tags":{"1.0.0":{"tag":"1.0.0","author":"Takahashi_Fumiki","date":"2018-08-07 05:54:08"},"1.0.1":{"tag":"1.0.1","author":"Takahashi_Fumiki","date":"2018-08-08 10:05:03"},"1.0.2":{"tag":"1.0.2","author":"Takahashi_Fumiki","date":"2018-09-13 09:08:09"},"1.0.3":{"tag":"1.0.3","author":"Takahashi_Fumiki","date":"2019-01-28 06:12:32"},"1.0.4":{"tag":"1.0.4","author":"Takahashi_Fumiki","date":"2019-09-03 07:13:02"},"2.0.0":{"tag":"2.0.0","author":"Takahashi_Fumiki","date":"2026-01-26 11:27:30"},"2.0.1":{"tag":"2.0.1","author":"Takahashi_Fumiki","date":"2026-01-26 15:33:07"},"2.0.2":{"tag":"2.0.2","author":"Takahashi_Fumiki","date":"2026-01-27 14:33:04"},"2.1.0":{"tag":"2.1.0","author":"Takahashi_Fumiki","date":"2026-02-02 09:02:18"},"2.2.1":{"tag":"2.2.1","author":"Takahashi_Fumiki","date":"2026-05-21 05:04:23"},"2.2.2":{"tag":"2.2.2","author":"Takahashi_Fumiki","date":"2026-05-21 06:12:02"}},"upgrade_notice":[],"ratings":[],"assets_icons":{"icon-128x128.png":{"filename":"icon-128x128.png","revision":1920789,"resolution":"128x128","location":"assets","locale":"","width":128,"height":128},"icon-256x256.png":{"filename":"icon-256x256.png","revision":1920789,"resolution":"256x256","location":"assets","locale":"","width":256,"height":256}},"assets_banners":{"banner-1544x500.jpg":{"filename":"banner-1544x500.jpg","revision":1920764,"resolution":"1544x500","location":"assets","locale":"","width":1544,"height":500},"banner-772x250.jpg":{"filename":"banner-772x250.jpg","revision":1920764,"resolution":"772x250","location":"assets","locale":"","width":772,"height":250}},"assets_blueprints":{},"all_blocks":{"hamelp\/ai-overview":{"$schema":"https:\/\/schemas.wp.org\/trunk\/block.json","apiVersion":3,"name":"hamelp\/ai-overview","title":"AI FAQ Overview","category":"widgets","icon":"format-chat","description":"AI-powered FAQ search that answers user questions based on FAQ content.","textdomain":"hamelp","attributes":{"placeholder":{"type":"string","default":"Enter your question..."},"buttonText":{"type":"string","default":"Ask AI"},"showSources":{"type":"boolean","default":true}},"supports":{"html":false,"align":["wide","full"]},"editorScript":"file:.\/index.js","style":"file:.\/style-index.css","render":"file:.\/render.php","viewScript":"file:.\/view.js"},"hamelp\/search-box":{"$schema":"https:\/\/schemas.wp.org\/trunk\/block.json","apiVersion":3,"name":"hamelp\/search-box","title":"FAQ Search Box","category":"widgets","icon":"search","description":"Incremental search box for FAQ posts.","textdomain":"hamelp","attributes":{"label":{"type":"string","default":"Enter keyword and hit search."},"btn":{"type":"string","default":"Search"}},"supports":{"html":false,"align":["wide","full"]},"editorScript":"file:.\/index.js","style":"hamelp-incsearch","viewScript":"hamelp-incsearch","render":"file:.\/render.php"}},"tagged_versions":["1.0.0","1.0.1","1.0.2","1.0.3","1.0.4","2.0.0","2.0.1","2.0.2","2.1.0","2.2.1","2.2.2"],"block_files":[],"assets_screenshots":[],"screenshots":[]},"plugin_section":[],"plugin_tags":[1643,3066],"plugin_category":[],"plugin_contributors":[146156,83237],"plugin_business_model":[],"class_list":["post-89654","plugin","type-plugin","status-publish","hentry","plugin_tags-faq","plugin_tags-help","plugin_contributors-hametuha","plugin_contributors-takahashi_fumiki","plugin_committers-hametuha","plugin_committers-takahashi_fumiki"],"banners":{"banner":"https:\/\/ps.w.org\/hamelp\/assets\/banner-772x250.jpg?rev=1920764","banner_2x":"https:\/\/ps.w.org\/hamelp\/assets\/banner-1544x500.jpg?rev=1920764","banner_rtl":false,"banner_2x_rtl":false},"icons":{"svg":false,"icon":"https:\/\/ps.w.org\/hamelp\/assets\/icon-128x128.png?rev=1920789","icon_2x":"https:\/\/ps.w.org\/hamelp\/assets\/icon-256x256.png?rev=1920789","generated":false},"screenshots":[],"raw_content":"<!--section=description-->\n<p>This plugin add new custom post type 'FAQ'. With some functionality, you can build help center for your user.\nWhat is help center? We collect examples at our <a href=\"https:\/\/github.com\/hametuha\/hamelp\/wiki\">github wiki<\/a>.<\/p>\n\n<h4>Creating Portal<\/h4>\n\n<p>This plugin will provide...<\/p>\n\n<ul>\n<li>Custom post type with single page and archive page.<\/li>\n<li>Custom taxonomy associated to CPT.<\/li>\n<li>Incremental search box.<\/li>\n<li>AI Overview(Since 2.0.0)<\/li>\n<\/ul>\n\n<h4>AI Overview<\/h4>\n\n<p>AI Overview answers user questions based on your FAQ content using a large language model.\nIt uses the <a href=\"https:\/\/github.com\/WordPress\/wp-ai-client\">wp-ai-client<\/a> bundled with WordPress core since WordPress 7.0, which requires an AI service to be configured in WordPress.<\/p>\n\n<p><strong>Requirements:<\/strong> AI Overview requires <strong>WordPress 7.0 or later<\/strong>. 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.<\/p>\n\n<p>You can configure AI behavior and rate limiting from <strong>Settings &gt; Hamelp<\/strong> in the admin panel. The settings page also includes a <strong>Rebuild Catalog Now<\/strong> button to manually refresh the FAQ catalog used as LLM context.<\/p>\n\n<p>Using the Block<\/p>\n\n<p>Add the <strong>AI FAQ Overview<\/strong> block in the block editor. The block has the following options:<\/p>\n\n<ul>\n<li><strong>Placeholder<\/strong> \u2014 Input placeholder text.<\/li>\n<li><strong>Button Text<\/strong> \u2014 Submit button label.<\/li>\n<li><p><strong>Show Sources<\/strong> \u2014 Display related FAQ links below the answer.<\/p>\n\n<p>Using the Template Function<\/p><\/li>\n<\/ul>\n\n<p>You can also use <code>hamelp_render_ai_overview()<\/code> in your theme templates:<\/p>\n\n<pre>\n&lt;?php echo hamelp_render_ai_overview(); ?&gt;\n<\/pre>\n\n<p>The function accepts an optional array of arguments:<\/p>\n\n<pre>\n&lt;php\necho hamelp_render_ai_overview( [\n    'placeholder'  =&gt; 'Ask a question...',\n    'button_text'  =&gt; 'Ask AI',\n    'show_sources' =&gt; true,\n] );\n?&gt;\n<\/pre>\n\n<p>The function automatically enqueues the required JavaScript and CSS assets.<\/p>\n\n<h4>Search Box<\/h4>\n\n<p>The incremental FAQ search box is available in three forms.<\/p>\n\n<p>Using the Block<\/p>\n\n<p>Add the <strong>FAQ Search Box<\/strong> block in the block editor. The block has the following options:<\/p>\n\n<ul>\n<li><strong>Label<\/strong> \u2014 Input placeholder text.<\/li>\n<li><p><strong>Button Text<\/strong> \u2014 Submit button label.<\/p>\n\n<p>Using the Shortcode<\/p><\/li>\n<\/ul>\n\n<p>You can use shortcode <code>hamelp-search<\/code> in page content.<\/p>\n\n<pre>\n[hamelp-search label='Enter your question here.'][\/hamelp-search]\n<\/pre>\n\n<p>Using the Template Function<\/p>\n\n<p>You can also call <code>hamelp_render_search_box()<\/code> directly from your theme templates:<\/p>\n\n<pre>\n&lt;?php echo hamelp_render_search_box( [\n    'label' =&gt; 'Enter your question here.',\n    'btn'   =&gt; 'Search',\n] ); ?&gt;\n<\/pre>\n\n<!--section=installation-->\n<p>Install itself is easy. Auto install from admin panel is recommended. Search with <code>hamelp<\/code>.<\/p>\n\n<ol>\n<li>Donwload and unpack plugin file, upload <code>hamelp<\/code> folder to <code>\/wp-content\/plugins<\/code> directory.<\/li>\n<li>Activate it from admin panel.<\/li>\n<\/ol>\n\n<!--section=faq-->\n<dl>\n<dt id=\"how%20can%20i%20contribute%3F\"><h3>How can I contribute?<\/h3><\/dt>\n<dd><p>You can contribute to our github repo. Any <a href=\"https:\/\/github.com\/hametuha\/hamelp\/issues\">issues<\/a> or <a href=\"https:\/\/github.com\/hametuha\/hamelp\/pulls\">PRs<\/a> are welcomed.<\/p><\/dd>\n\n<\/dl>\n\n<!--section=changelog-->\n<h4>2.3.0<\/h4>\n\n<ul>\n<li>Add <strong>FAQ Search Box<\/strong> block (<code>hamelp\/search-box<\/code>). The existing <code>[hamelp-search]<\/code> shortcode continues to work and now shares the same render logic.<\/li>\n<li>Expose <code>hamelp_render_search_box()<\/code> as a public template function so themes can render the search box without going through the shortcode parser.<\/li>\n<\/ul>\n\n<h4>2.2.0<\/h4>\n\n<ul>\n<li>Remove bundled <a href=\"https:\/\/github.com\/WordPress\/wp-ai-client\">wp-ai-client<\/a> Composer dependency. AI Overview now uses the wp-ai-client bundled with WordPress core, which requires <strong>WordPress 7.0 or later<\/strong>.<\/li>\n<li>On WordPress versions earlier than 7.0, the AI Overview block and search form still render but submissions fail (no REST route). FAQ custom post type, incremental search, and other features remain functional.<\/li>\n<li>Auto-rebuild the FAQ catalog on plugin activation, so the AI Overview works out of the box without manually running <code>wp hamelp rebuild<\/code>.<\/li>\n<li>Add a <strong>Rebuild Catalog Now<\/strong> button to the settings page for manual catalog refresh.<\/li>\n<\/ul>\n\n<h4>2.1.0<\/h4>\n\n<ul>\n<li>Add user context to AI Overview for personalized responses.<\/li>\n<li>Add whitelist-based user role filtering for security (<code>hamelp_allowed_user_roles<\/code> filter).<\/li>\n<li>Add <code>hamelp_user_context<\/code> and <code>hamelp_display_user_roles<\/code> filters for customization.<\/li>\n<li>Add development hooks support for local environment testing.<\/li>\n<li>Remove bundled translations in favor of GlotPress (WordPress.org).<\/li>\n<\/ul>\n\n<h4>2.0.0<\/h4>\n\n<ul>\n<li>Add AI Overview Feature.<\/li>\n<li>Bump minimum requirements: PHP &gt;=7.4, WordPress &gt;= 6.6<\/li>\n<\/ul>\n\n<h4>1.0.4<\/h4>\n\n<ul>\n<li>Add <a href=\"https:\/\/developers.google.com\/search\/docs\/data-types\/faqpage\">structured data<\/a> for FAQPage.<\/li>\n<\/ul>\n\n<h4>1.0.3<\/h4>\n\n<ul>\n<li>Bugfix and change glocal functions.<\/li>\n<\/ul>\n\n<h4>1.0.2<\/h4>\n\n<ul>\n<li>Fix taxonomy to be shown in Gutenberg.<\/li>\n<\/ul>\n\n<h4>1.0.1<\/h4>\n\n<ul>\n<li>Fix no vendor directory bug.<\/li>\n<\/ul>\n\n<h4>1.0.0<\/h4>\n\n<ul>\n<li>Initial release.<\/li>\n<\/ul>","raw_excerpt":"FAQ template plugin by Hametuha.","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/kk.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin\/89654","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/kk.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin"}],"about":[{"href":"https:\/\/kk.wordpress.org\/plugins\/wp-json\/wp\/v2\/types\/plugin"}],"replies":[{"embeddable":true,"href":"https:\/\/kk.wordpress.org\/plugins\/wp-json\/wp\/v2\/comments?post=89654"}],"author":[{"embeddable":true,"href":"https:\/\/kk.wordpress.org\/plugins\/wp-json\/wporg\/v1\/users\/takahashi_fumiki"}],"wp:attachment":[{"href":"https:\/\/kk.wordpress.org\/plugins\/wp-json\/wp\/v2\/media?parent=89654"}],"wp:term":[{"taxonomy":"plugin_section","embeddable":true,"href":"https:\/\/kk.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_section?post=89654"},{"taxonomy":"plugin_tags","embeddable":true,"href":"https:\/\/kk.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_tags?post=89654"},{"taxonomy":"plugin_category","embeddable":true,"href":"https:\/\/kk.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_category?post=89654"},{"taxonomy":"plugin_contributors","embeddable":true,"href":"https:\/\/kk.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_contributors?post=89654"},{"taxonomy":"plugin_business_model","embeddable":true,"href":"https:\/\/kk.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_business_model?post=89654"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}