Commit 431dc2e3 authored by alexpott's avatar alexpott

Issue #2012812 by thedavidmeister, pwieck: drupal_render() can't distinguish...

Issue #2012812 by thedavidmeister, pwieck: drupal_render() can't distinguish between empty strings from theme() from an implemented hook and no hook being matched.
parent 58c54c35
...@@ -4689,25 +4689,32 @@ function drupal_render(&$elements) { ...@@ -4689,25 +4689,32 @@ function drupal_render(&$elements) {
// element have to be rendered there. If the internal #render_children // element have to be rendered there. If the internal #render_children
// property is set, do not call the #theme function to prevent infinite // property is set, do not call the #theme function to prevent infinite
// recursion. // recursion.
$theme_is_implemented = FALSE;
if (isset($elements['#theme']) && !isset($elements['#render_children'])) { if (isset($elements['#theme']) && !isset($elements['#render_children'])) {
$elements['#children'] = theme($elements['#theme'], $elements); $elements['#children'] = theme($elements['#theme'], $elements);
} // If theme() returns FALSE this means that the hook in #theme was not found
// If #theme was not set and the element has children, render them now. // in the registry. This is common for theme suggestions.
// This is the same process as drupal_render_children() but is inlined $theme_is_implemented = ($elements['#children'] !== FALSE);
// for speed. }
if ($elements['#children'] === '') { // #theme is either not set or does not exist in the registry.
if (!$theme_is_implemented) {
// If #theme is not implemented and the element has children, render them
// now. This is the same process as drupal_render_children() but is inlined
// for speed.
foreach ($children as $key) { foreach ($children as $key) {
$elements['#children'] .= drupal_render($elements[$key]); $elements['#children'] .= drupal_render($elements[$key]);
} }
}
// If #theme was not set, but the element has raw #markup, prepend the content // If #theme is not implemented and the element has raw #markup as a
// in #markup to #children. #children may contain the rendered content // fallback, prepend the content in #markup to #children. In this case
// supplied by #theme, or the rendered child elements, as processed above. If // #children will contain whatever is provided by #pre_render prepended to
// both #theme and #markup are set, then #theme is responsible for rendering // what is rendered recursively above. If #theme is implemented then it is
// the element. Eventually assigned #theme_wrappers will expect both the // the responsibility of that theme implementation to render #markup if
// element's #markup and the rendered content of child elements in #children. // required. Eventually #theme_wrappers will expect both #markup and
if (!isset($elements['#theme']) && isset($elements['#markup'])) { // #children to be a single string as #children.
$elements['#children'] = $elements['#markup'] . $elements['#children']; if (isset($elements['#markup'])) {
$elements['#children'] = $elements['#markup'] . $elements['#children'];
}
} }
// Add any JavaScript state information associated with the element. // Add any JavaScript state information associated with the element.
......
...@@ -932,8 +932,9 @@ function drupal_find_base_themes($themes, $key, $used_keys = array()) { ...@@ -932,8 +932,9 @@ function drupal_find_base_themes($themes, $key, $used_keys = array()) {
* properties are mapped to variables expected by the theme hook * properties are mapped to variables expected by the theme hook
* implementations. * implementations.
* *
* @return * @return string|false
* An HTML string representing the themed output. * An HTML string representing the themed output or FALSE if the passed $hook
* is not implemented.
* *
* @see themeable * @see themeable
* @see hook_theme() * @see hook_theme()
...@@ -982,7 +983,10 @@ function theme($hook, $variables = array()) { ...@@ -982,7 +983,10 @@ function theme($hook, $variables = array()) {
if (!isset($candidate)) { if (!isset($candidate)) {
watchdog('theme', 'Theme hook %hook not found.', array('%hook' => $hook), WATCHDOG_WARNING); watchdog('theme', 'Theme hook %hook not found.', array('%hook' => $hook), WATCHDOG_WARNING);
} }
return ''; // There is no theme implementation for the hook passed. Return FALSE so
// the function calling theme() can differentiate between a hook that
// exists and renders an empty string and a hook that is not implemented.
return FALSE;
} }
} }
......
...@@ -83,6 +83,59 @@ function testDrupalRenderBasics() { ...@@ -83,6 +83,59 @@ function testDrupalRenderBasics() {
} }
} }
/**
* Tests fallback rendering behaviour when #theme is not implemented.
*
* If #theme is set and is an implemented theme hook then theme() is 100%
* responsible for rendering the array including children and #markup.
*
* If #theme is not set or is not found in the registry then drupal_render()
* should recursively render child attributes of the array and #markup.
*
* This dual rendering behaviour is only relevant to the internal processing
* of drupal_render() before #theme_wrappers are called, so not #prefix and
* #suffix for example.
*/
function testDrupalRenderFallbackRender() {
// Theme suggestion is not implemented, #markup should be rendered.
$theme_suggestion_not_implemented_has_markup = array(
'#theme' => array('suggestionnotimplemented'),
'#markup' => 'foo',
);
$rendered = drupal_render($theme_suggestion_not_implemented_has_markup);
$this->assertIdentical($rendered, 'foo');
// Theme suggestion is not implemented, children should be rendered.
$theme_suggestion_not_implemented_has_children = array(
'#theme' => array('suggestionnotimplemented'),
'child' => array(
'#markup' => 'foo',
),
);
$rendered = drupal_render($theme_suggestion_not_implemented_has_children);
$this->assertIdentical($rendered, 'foo');
// Theme suggestion is implemented but returns empty string, #markup should
// not be rendered.
$theme_implemented_is_empty_has_markup = array(
'#theme' => array('common_test_empty'),
'#markup' => 'foo',
);
$rendered = drupal_render($theme_implemented_is_empty_has_markup);
$this->assertIdentical($rendered, '');
// Theme suggestion is implemented but returns empty string, children should
// not be rendered.
$theme_implemented_is_empty_has_children = array(
'#theme' => array('common_test_empty'),
'child' => array(
'#markup' => 'foo',
),
);
$rendered = drupal_render($theme_implemented_is_empty_has_children);
$this->assertIdentical($rendered, '');
}
/** /**
* Tests sorting by weight. * Tests sorting by weight.
*/ */
......
...@@ -204,7 +204,7 @@ function testRegistryRebuild() { ...@@ -204,7 +204,7 @@ function testRegistryRebuild() {
// throws an exception. // throws an exception.
$this->rebuildContainer(); $this->rebuildContainer();
$this->container->get('module_handler')->loadAll(); $this->container->get('module_handler')->loadAll();
$this->assertIdentical(theme('theme_test_foo', array('foo' => 'b')), '', 'The theme registry does not contain theme_test_foo, because the module is disabled.'); $this->assertIdentical(theme('theme_test_foo', array('foo' => 'b')), FALSE, 'The theme registry does not contain theme_test_foo, because the module is disabled.');
module_enable(array('theme_test'), FALSE); module_enable(array('theme_test'), FALSE);
// After enabling/disabling a module during a test, we need to rebuild the // After enabling/disabling a module during a test, we need to rebuild the
......
...@@ -164,9 +164,26 @@ function common_test_theme() { ...@@ -164,9 +164,26 @@ function common_test_theme() {
'variables' => array('foo' => 'foo', 'bar' => 'bar'), 'variables' => array('foo' => 'foo', 'bar' => 'bar'),
'template' => 'common-test-foo', 'template' => 'common-test-foo',
), ),
'common_test_empty' => array(
'variables' => array('foo' => 'foo'),
),
); );
} }
/**
* Provides a theme function for drupal_render().
*/
function theme_common_test_foo($variables) {
return $variables['foo'] . $variables['bar'];
}
/**
* Always returns an empty string.
*/
function theme_common_test_empty($variables) {
return '';
}
/** /**
* Implements hook_library_info_alter(). * Implements hook_library_info_alter().
*/ */
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment