Feedback form for WordPress plugins

Add a feedback form to your WordPress plugin. TellsU gives your plugin one PHP file to include. It shows the widget on your plugin’s admin pages, with a plain link instead when JavaScript is off. There’s nothing to install from Composer or npm, and nothing is sent until someone clicks.

Add it to your plugin

All of this is on your app’s Installation › WordPress tab in the TellsU dashboard, filled in for your plugin.

1. Choose your function prefix. WordPress needs plugins to prefix their function names, so use the one your plugin already uses: lower-case letters, digits and underscores, starting with a letter. The tab suggests one from your app’s name.

2. Add two files to your plugin. Download tellsu.min.js (the widget) and tellsu.php (made with your prefix) and put both in the same folder of your plugin. You can also copy tellsu.php or read it first.

3. Load it and show the widget. Include the file from your plugin’s main file, then call its function on each admin page that should show the widget, with your plugin’s version:

   require __DIR__ . '/tellsu.php';
   
   my_plugin_tellsu_feedback( MY_PLUGIN_VERSION );

Download tellsu.php again if you turn the faces on or off in your app’s settings, since it carries that choice.

What’s sent

When someone clicks the widget, the hosted page opens in a new tab with:

• your plugin’s version;
• WordPress and PHP as the host and runtime, with their versions;
• the active theme’s name;
• whether the site is a multisite;
• the screen: your admin page’s slug from ?page=, never its address;
• the sentiment, if a face was clicked.

The hosted page detects the browser and operating system itself, and shows your user everything that will be sent before they send it. Nothing about the site’s content, users or visitors is read.

Before you publish

WordPress.org requires plugins to describe external services in their readme. See Store listings for text to copy.