{"id":419,"date":"2011-05-22T19:37:35","date_gmt":"2011-05-22T23:37:35","guid":{"rendered":"http:\/\/cfdbplugin.com\/?page_id=419"},"modified":"2016-12-15T21:55:29","modified_gmt":"2016-12-16T02:55:29","slug":"cfdb-export-link","status":"publish","type":"page","link":"https:\/\/cfdbplugin.com\/?page_id=419","title":{"rendered":"[cfdb-export-link]"},"content":{"rendered":"

This documentation applies to version 2.6 and later<\/span><\/p>\n

Summary of Shortcode Options<\/strong><\/h1>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Option<\/strong><\/td>\nExample
\n<\/strong><\/td>\n		Description<\/strong><\/td>\n<\/tr>\n
form<\/strong><\/a><\/td>\n[cfdb-export-link form=\"myform\"<\/strong>]<\/code><\/td>\nRequired. Designates the form to display. All rows and columns are displayed by default<\/td>\n<\/tr>\n
role<\/strong><\/a><\/td>\n[cfdb-datatable form=\"myform\" role=\"Author\"<\/strong>]<\/code><\/td>\nMake short code only display output for user’s with minimum-required role. Choices are<\/p>\n
    \n
  • Administrator<\/li>\n
  • Editor<\/li>\n
  • Author<\/li>\n
  • Contributor<\/li>\n
  • Subscriber<\/li>\n
  • Anyone<\/li>\n<\/ul>\n

    WARNING<\/strong>: this setting is overridden by plugin setting in WP Admin page Contact -> Database Options -> Can See Submission when using shortcodes
    \n(since 2.4.1)\n<\/td>\n<\/tr>\n

show<\/strong><\/a><\/td>\n[cfdb-export-link form=\"myform\" show=\"col1,col2\"<\/strong>]<\/code><\/td>\nLimits columns to be shown to be those designated (comma-delimited list)<\/td>\n<\/tr>\n
hide<\/strong><\/a><\/td>\n[cfdb-export-link form=\"myform\" hide<\/span>=\"col1,col2\"<\/strong>]<\/code><\/td>\nDoes not show listed columns (comma-delimited list)<\/td>\n<\/tr>\n

tr><\/p>\n

header<\/strong><\/td>\n[cfdb-table form=\"myform\" header<\/span>=\"false\"<\/strong>]<\/code><\/td>\nShow or do not show the table header. Valid values are true<\/strong> (the default) and false<\/strong><\/td>\n<\/tr>\n
<\/a>headers<\/strong><\/td>\n[cfdb-table form=\"myform\" headers<\/span>=\"your-name=Name,ex_field1=Email\"<\/strong>]<\/code><\/td>\nAllows you to change the name displayed in the table header. Map a form field names to a more readable display names. (Since 2.5.1)<\/td>\n<\/tr>\n
limit<\/strong><\/a><\/td>\n[cfdb-export-link\u00a0form=\"myform\"\u00a0limit=\"10\"<\/strong>]<\/code><\/td>\nOne number: limit=”10″ means show first 10 rows. Is the same as limit=”0,10″
\nTwo Numbers: limit=”100,10″ means show 10 rows starting at row #100)<\/td>\n<\/tr>\n
random<\/strong><\/a><\/td>\n[cfdb-table form=\"myform\"\u00a0random=\"2\"<\/strong>]<\/code><\/td>\nDisplay 2 random rows from those that the short code finds. (Since 2.4)<\/td>\n<\/tr>\n
orderby<\/strong><\/a><\/td>\n[cfdb-export-link\u00a0form=\"myform\"\u00a0orderby=\"last-name,first-name\"<\/strong>]<\/code><\/td>\nSort rows by designated columns. Use “column-name desc” to sort in descending (reverse) order<\/td>\n<\/tr>\n
search<\/strong><\/a><\/td>\n[cfdb-export-link\u00a0form=\"myform\"\u00a0search<\/span>=\"Simpson\"<\/strong>]<\/code><\/td>\nSelect rows to display that have any cell with the search text in it (case insensitive). Intended to mimic behavior of the “Search” field in the DataTable<\/td>\n<\/tr>\n
filter<\/strong><\/a><\/td>\n[cfdb-export-link form=\"myform\" filter<\/span>=\"col1=Simpson\"<\/strong>]<\/code><\/td>\nSelect which rows to display based on filter expression. More powerful than “search”, it can filter on multiple columns with boolean and regular expressions. If both “search” and “filter” are specified, “search” is ignored.<\/td>\n<\/tr>\n
Options specific to this shortcode<\/em><\/td>\n<\/tr>\n
enc<\/strong><\/a><\/td>\n[cfdb-export-link form=\"myform\" enc<\/span>=\"CSVUTF8BOM\"<\/strong>]<\/code><\/td>\nSet the encoding\/format of the export file. Options are:<\/p>\n
urlonly<\/a><\/strong><\/td>\n[cfdb-export-link form=\"myform\"\u00a0urlonly<\/span>=\"true\"<\/strong>]<\/code><\/td>\nBy default an HTML anchor tag is output to make a clickable link. setting urlonly=”true” makes the shortcode only output the URL text<\/td>\n<\/tr>\n
linktext<\/a><\/strong><\/td>\n[cfdb-export-link form=\"myform\"\u00a0linktext<\/span>=\"Download\"<\/strong>]<\/code><\/td>\nBy default an HTML anchor tag that is output is labeled “Export”. Use this option to change the text of that link.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

Use [cfdb-export-link form=\"your-form\"]<\/code> with optional show<\/code>, hide<\/code> and filter<\/code> just like[cfdb-table]<\/code>.<\/p>\n

The purpose of this tag is to output an HTML link which, when clicked, will download a file in a CSV or related format. This is the same as the export options available in the Database page in the WP admin area.<\/p>\n

WARNING<\/strong>: When clicking your link, you will get a “Permission Denied<\/strong>” error unless the user has permission to see data according to the “Can See Submission data<\/strong>” option (see Database Options page). When a user has this access, he can then hand-craft URLs to download any and all data from any form in your database. Setting this option to “Anyone” opens up a security hole where any savvy user can construct URLs to see all the submitted form data you have. So use this option with care.<\/p>\n

Some people wish to have only those results downloaded that are associated with a specific user. That can be accomplished. See the page on filter variable substitution using\u00a0$user_login<\/a>. But note that although the short code link only shows that user’s data, a savvy user can change the link to see other data. The security options in the plugin’s Options panel allow one to set what level of user can see data (Administration, Editor, etc.) but this is a all-or-nothing proposition. Users that can see data can see all the data. And hacking the URL output by this short code is an easy way to see data that was not intended by a shortcode.<\/p>\n

 <\/p>\n

<\/a>Use enc<\/span> to indicate output file format. The choices are described above.<\/p>\n

 <\/p>\n

<\/a>Use urlonly<\/span> to only output the URL to the export instead of an HTML A tag.<\/p>\n

 <\/p>\n

<\/a>Use linktext<\/span> to change the label for the HTML A tag. By default the label is “Export”, for example:
\n<a href=”http:\/\/….”>Export<\/a><\/p>\n

 <\/p>\n","protected":false},"excerpt":{"rendered":"

Summary of Shortcode Options Option Example Description form Required. Designates the form to display. All rows and columns are displayed by default role Make short code only display output for user’s with minimum-required role. Choices are Administrator Editor Author Contributor Subscriber Anyone WARNING: this setting is overridden by plugin setting in WP Admin page Contact […]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":1577,"menu_order":6,"comment_status":"closed","ping_status":"closed","template":"page-without-sidebar.php","meta":{"jetpack_post_was_ever_published":false,"footnotes":""},"class_list":["post-419","page","type-page","status-publish","hentry"],"jetpack_shortlink":"https:\/\/wp.me\/P1mptf-6L","jetpack_sharing_enabled":true,"jetpack-related-posts":[],"_links":{"self":[{"href":"https:\/\/cfdbplugin.com\/index.php?rest_route=\/wp\/v2\/pages\/419","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/cfdbplugin.com\/index.php?rest_route=\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/cfdbplugin.com\/index.php?rest_route=\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/cfdbplugin.com\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/cfdbplugin.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=419"}],"version-history":[{"count":22,"href":"https:\/\/cfdbplugin.com\/index.php?rest_route=\/wp\/v2\/pages\/419\/revisions"}],"predecessor-version":[{"id":1428,"href":"https:\/\/cfdbplugin.com\/index.php?rest_route=\/wp\/v2\/pages\/419\/revisions\/1428"}],"up":[{"embeddable":true,"href":"https:\/\/cfdbplugin.com\/index.php?rest_route=\/wp\/v2\/pages\/1577"}],"wp:attachment":[{"href":"https:\/\/cfdbplugin.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=419"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}