In the previous post in this series, I showed how to add content to the post editor using a custom TinyMCE button. The problem with the approach, as we’ve covered thus far, is that the content that we’re adding to the editor is hard-coded.
We’re rarely going to want to be doing this, right? I mean, wouldn’t we rather grab input from the user and then add that to the editor?
For some, this may be creating a shortcode based on some input, for others it may be grabbing input, making an Ajax call, and then putting the result of the request into the editor, or it may be something as simple as taking whatever input the user has provided in a prompt and then adding it to the editor.
Though the latter case is not likely something that is a realistic use case (after all, if they just wanted to put something into the editor, why not just, you know, enter it into the editor?), it’s something that will make rounding out this series a bit more complete because it will show how to connect displaying a prompt to the user, grabbing the input, then using the TinyMCE API to drop the input into the editor.
So that’s what we’ll do.
User Input with TinyMCE and WordPress
I’m going to pick up exactly where I left off in the last post, so recall that the last bit of code that we saw was as follows:
prompt function in order to grab some input from the user.
Note that I don’t really recommend using this particular function for a number of reasons (security being one of them), but it’s easy to implement, makes it easy to read input from the user (whether or not they’ve specified anything), and then makes it easy to connect to the TinyMCE API.
In order to do that, let’s first create a function that will prompt the user to simply answer the question: What is your name?
Then, we’ll return the result of the prompt:
Of course, the user may not enter anything or the user may click “Cancel.” If that’s the case, then we need to set a default value of the string so that something is returned and can be entered into the post editor. In order to handle this, we’ll introduce a conditional into the code:
At this point, we can tie everything together such that we prompt the user for their name and then write the result to the editor:
Even if they don’t provide an answer, something will be written into the post editor.
More Advanced Use Cases
Obviously, this is a really simple article with a very, very basic use case. But the point isn’t to show how complicated something can be – after all, we’re all building different things so it would be hard for me to capture a use case that would work for everyone.
As mentioned at the beginning of the article, the actual use case of what we’ve shown here is kind of weak. That is, if the user wants to input information into the post editor, then s/he might as well do it; however, the purpose of the article isn’t to show how to simply grab input from the user and drop it into the editor.
Instead, it’s meant to show how to use the TinyMCE API to grab something from the user then add it to the editor.
Taking this a step further, you may be more interested in, say, displaying a modal dialog, having the user specify some input, make an Ajax request, then drop the result of the request into the editor.
Anyway, whatever the case, I hope this series has been helpful in terms of showing how to interface with the TinyMCE API for adding your own buttons, capturing input, and adding it to the post editor in WordPress.
TinyMCE and WordPress: Adding User Input was written by Tom. Check out additional articles on the full blog at Tom McFarlin.
Read more here:: TinyMCE and WordPress: Adding User Input