You are here

Home » API reference » Webform 7.4 » webform.api.php

function _webform_display_component in Webform 7.4

Same name and namespace in other branches
  1. 6.3 webform.api.php \_webform_display_component()
  2. 7.3 webform.api.php \_webform_display_component()

Display the result of a submission for a component.

The output of this function will be displayed under the "Results" tab then "Submissions". This should output the saved data in some reasonable manner.

Parameters

$component: A Webform component array.

$value: An array of information containing the submission result, directly correlating to the webform_submitted_data database table schema.

$format: Either 'html' or 'text'. Defines the format that the content should be returned as. Make sure that returned content is run through check_plain() or other filtering functions when returning HTML.

$submission: The submission. Used to generate tokens.

Return value

array A renderable element containing at the very least these properties:

  • #title
  • #weight
  • #component
  • #format
  • #value

Webform also uses #theme_wrappers to output the end result to the user, which will properly format the label and content for use within an e-mail (such as wrapping the text) or as HTML (ensuring consistent output).

Related topics

Sample Webform Component
In each of these examples, the word "component" should be replaced with the, name of the component type (such as textfield or select). These are not actual hooks, but instead samples of how Webform integrates with its own built-in components.

File

./webform.api.php, line 1029
Sample hooks demonstrating usage in Webform.

Code

function _webform_display_component($component, $value, $format = 'html', $submission = array()) {
  return array(
    '#title' => $component['name'],
    '#weight' => $component['weight'],
    '#theme' => 'webform_display_textfield',
    '#theme_wrappers' => $format == 'html' ? array(
      'webform_element',
    ) : array(
      'webform_element_text',
    ),
    '#post_render' => array(
      'webform_element_wrapper',
    ),
    '#field_prefix' => $component['extra']['field_prefix'],
    '#field_suffix' => $component['extra']['field_suffix'],
    '#component' => $component,
    '#format' => $format,
    '#value' => isset($value[0]) ? $value[0] : '',
  );
}