How to display an extension's form as a public Wordpress page

Question

I'm experimenting with the jQuery Repeater plugin to create multiple contacts via a single form. Using Civix, I've created an extension and a custom form. The form loads normally on the admin side, like:

http://site.org/wp-admin/admin.php?page=CiviCRM&q=civicrm/foo

What is the proper way to expose the form to the public site? The goal is to send the visitor to:

http://site.org/civicrm/foo

Once there, user will fill and submit the form, and the extension's hook will deal with the result. Given the warnings all over the docs about custom forms potentially breaking in future updates, does it even make sense to approach things this way? Or is it better to put the form on a WP page, using REST API calls to populate dropdowns and checkboxes, and deal with the result?

Answer 1

1. See also: http://wiki.civicrm.org/confluence/display/CRMDOC/Displaying+Public+Forms+in+WordPress+Frontend+Sites

2. If you generate a link programmatically with CRM_Utils_System::url(), there is a boolean parameter ($frontend) which determines whether the URL will use WP's frontend system or backend system. Most forms are in the backend, so the the default is to use backend. See also: https://github.com/civicrm/civicrm-core/blob/4.6.beta5/CRM/Utils/System.php#L212

3. It would be great to support clean URLs (http://site.org/civicrm/foo) on WordPress. I'm not a WordPress expert, and I've been told this is an esoteric area in WP (virtual pages?), but from Civi's perspective... we basically need some kind of rule in WP that maps all requests for "/civicrm/*" to CRM_Core_Invoke::invoke().

Answer 2

When you create the form in civix using

civix generate:form MyForm civicrm/myform

I believe the last parameter determines the WordPress page to have the parameters &page=CiviCRM&q=civicrm/myform&reset=1. If not then you likely need to implement a shortcode for it.

Note that after adding or modifying a route in the XML file, you must reset CiviCRMs "menu cache". This can be done in a web browser by visiting "/civicrm/menu/rebuild?reset=1"

Also beware: The form system is not well documented and may undergo significant revision after the CiviCRM 4.x series. In general, migrating basic pages will be easier than migrating basic forms, so you may want to consider to consider building your data-input UI using basic pages, the AJAX API, and/or the in-place editing API.