Add AI Search to your WordPress site

What is WordPress

WordPress is a popular content management system (CMS) designed for creating and managing websites.

Get an API key

Go to the yoursearchbox Dashboard
Select your project under Projects
Go to the Integrations tab
Click on Create integration
Select Web
Provide a Name and URL (optional) for the integration
Click on Create
Click the Example < /> button to get your API key and view suggested settings

Install custom code plugin

This plugin is required to add custom code in order to create a widget.

Open WordPress admin panel
Select the Plugins tab
Open the Add New Plugin section
Install the Head & Footer Code plugin

Creating the container

Add a container for the widget. You can do this using the built-in WordPress functionality.

Open the Appearance tab
Select Editor mode
Select the area to which you want to add the SearchBar widget
Add a Custom HTML block

Example:

Initialize the widget

Next, under the Tools tab open Head & Footer Code option. Add the code below to the HEAD Code section:

<script
  id="yoursearchbar-script"
  src="https://unpkg.com/@yoursearchbar/uikit-js@0.3.7/dist/embed.js"
  type="module"
  defer
></script>
 
<script defer>
  const yoursearchbarScript = document.getElementById("yoursearchbar-script");
 
  // configure and initialize the widget
  const addyoursearchbarWidget = () => {
    const yoursearchbarWidget = yoursearchbar().embed({
      componentType: "SearchBar",
      targetElement: document.getElementById("yoursearchbar"),
      properties: {
        baseSettings: {
          apiKey: "yoursearchbar_API_KEY", // required
          integrationId: "yoursearchbar_INTEGRATION_ID", // required
          organizationId: "yoursearchbar_ORGANIZATION_ID", // required
          primaryBrandColor: "#26D6FF", // your brand color, widget color scheme is derived from this
          organizationDisplayName: "yoursearchbar",
          // ...optional settings
          theme: {
            stylesheetUrls: ["/path/to/stylesheets"], // optional
            // ...optional settings
          },
        },
        modalSettings: {
          // optional settings
        },
        searchSettings: {
          // optional settings
        },
        aiChatSettings: {
          // optional settings
          botAvatarSrcUrl: "https://mydomain.com/mylogo", // use your own bot avatar
          quickQuestions: [
            "Example question 1?",
            "Example question 2?",
            "Example question 3?",
          ],
        },
      },
    });
  };
 
  yoursearchbarScript.addEventListener("load", () => {
    if (document.body) addyoursearchbarWidget(); // initialize the widget
  });
</script>

Save Custom Code

Click on the "Save Changes" button.
Navigate to your web application to ensure the widget is installed correctly.

For a full list of customizations, please refer to the Chat Button documentation.

Chat Button Chat Button