Commit a92f9292 authored by alexpott's avatar alexpott

Issue #2191115 by cs_shadow, alexrayu, JacobSanford, jhodgdon, Cottser: Clean...

Issue #2191115 by cs_shadow, alexrayu, JacobSanford, jhodgdon, Cottser: Clean up stale references to theme('foo') in documentation
parent 6477492e
...@@ -1183,10 +1183,10 @@ function template_preprocess_maintenance_task_list(&$variables) { ...@@ -1183,10 +1183,10 @@ function template_preprocess_maintenance_task_list(&$variables) {
* This function is called for theme hooks implemented as templates only, not * This function is called for theme hooks implemented as templates only, not
* for theme hooks implemented as functions. This preprocess function is the * for theme hooks implemented as functions. This preprocess function is the
* first in the sequence of preprocessing functions that are called when * first in the sequence of preprocessing functions that are called when
* preparing variables for a template. See _theme() for more details about the * preparing variables for a template.
* full sequence.
* *
* @see _theme() * See the @link themeable Default theme implementations topic @endlink for
* details.
*/ */
function template_preprocess(&$variables, $hook, $info) { function template_preprocess(&$variables, $hook, $info) {
// Tell all templates where they are located. // Tell all templates where they are located.
......
...@@ -298,11 +298,13 @@ public function getBaseHook($hook) { ...@@ -298,11 +298,13 @@ public function getBaseHook($hook) {
* for base hooks (e.g., 'block__node' for the base hook 'block') need to be * for base hooks (e.g., 'block__node' for the base hook 'block') need to be
* determined based on the full registry and classified as 'base hook'. * determined based on the full registry and classified as 'base hook'.
* *
* @see _theme() * See the @link themeable Default theme implementations topic @endlink for
* @see hook_theme_registry_alter() * details.
* *
* @return \Drupal\Core\Utility\ThemeRegistry * @return \Drupal\Core\Utility\ThemeRegistry
* The build theme registry. * The build theme registry.
*
* @see hook_theme_registry_alter()
*/ */
protected function build() { protected function build() {
$cache = array(); $cache = array();
......
...@@ -18,6 +18,9 @@ interface ThemeManagerInterface { ...@@ -18,6 +18,9 @@ interface ThemeManagerInterface {
/** /**
* Generates themed output. * Generates themed output.
* *
* See the @link themeable Default theme implementations topic @endlink for
* details.
*
* @param string $hook * @param string $hook
* The name of the theme hook to call. * The name of the theme hook to call.
* @param array $variables * @param array $variables
...@@ -25,8 +28,6 @@ interface ThemeManagerInterface { ...@@ -25,8 +28,6 @@ interface ThemeManagerInterface {
* *
* @return string * @return string
* The rendered output. * The rendered output.
*
* @see _theme
*/ */
public function render($hook, array $variables); public function render($hook, array $variables);
......
...@@ -72,8 +72,8 @@ ...@@ -72,8 +72,8 @@
* If the module wishes to act on the rendered HTML of the block rather than * If the module wishes to act on the rendered HTML of the block rather than
* the structured content array, it may use this hook to add a #post_render * the structured content array, it may use this hook to add a #post_render
* callback. Alternatively, it could also implement hook_preprocess_HOOK() for * callback. Alternatively, it could also implement hook_preprocess_HOOK() for
* block.html.twig. See drupal_render() and _theme() documentation respectively * block.html.twig. See drupal_render() documentation or the
* for details. * @link themeable Default theme implementations topic @endlink for details.
* *
* In addition to hook_block_view_alter(), which is called for all blocks, there * In addition to hook_block_view_alter(), which is called for all blocks, there
* is hook_block_view_BASE_BLOCK_ID_alter(), which can be used to target a * is hook_block_view_BASE_BLOCK_ID_alter(), which can be used to target a
......
...@@ -1327,7 +1327,9 @@ function hook_ENTITY_TYPE_view(array &$build, \Drupal\Core\Entity\EntityInterfac ...@@ -1327,7 +1327,9 @@ function hook_ENTITY_TYPE_view(array &$build, \Drupal\Core\Entity\EntityInterfac
* structured content array, it may use this hook to add a #post_render * structured content array, it may use this hook to add a #post_render
* callback. Alternatively, it could also implement hook_preprocess_HOOK() for * callback. Alternatively, it could also implement hook_preprocess_HOOK() for
* the particular entity type template, if there is one (e.g., node.html.twig). * the particular entity type template, if there is one (e.g., node.html.twig).
* See drupal_render() and _theme() for details. *
* See the @link themeable Default theme implementations topic @endlink and
* drupal_render() for details.
* *
* @param array &$build * @param array &$build
* A renderable array representing the entity content. * A renderable array representing the entity content.
...@@ -1337,10 +1339,10 @@ function hook_ENTITY_TYPE_view(array &$build, \Drupal\Core\Entity\EntityInterfac ...@@ -1337,10 +1339,10 @@ function hook_ENTITY_TYPE_view(array &$build, \Drupal\Core\Entity\EntityInterfac
* The entity view display holding the display options configured for the * The entity view display holding the display options configured for the
* entity components. * entity components.
* *
* @ingroup entity_crud
*
* @see hook_entity_view() * @see hook_entity_view()
* @see hook_ENTITY_TYPE_view_alter() * @see hook_ENTITY_TYPE_view_alter()
*
* @ingroup entity_crud
*/ */
function hook_entity_view_alter(array &$build, Drupal\Core\Entity\EntityInterface $entity, \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display) { function hook_entity_view_alter(array &$build, Drupal\Core\Entity\EntityInterface $entity, \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display) {
if ($build['#view_mode'] == 'full' && isset($build['an_additional_field'])) { if ($build['#view_mode'] == 'full' && isset($build['an_additional_field'])) {
...@@ -1363,7 +1365,9 @@ function hook_entity_view_alter(array &$build, Drupal\Core\Entity\EntityInterfac ...@@ -1363,7 +1365,9 @@ function hook_entity_view_alter(array &$build, Drupal\Core\Entity\EntityInterfac
* structured content array, it may use this hook to add a #post_render * structured content array, it may use this hook to add a #post_render
* callback. Alternatively, it could also implement hook_preprocess_HOOK() for * callback. Alternatively, it could also implement hook_preprocess_HOOK() for
* the particular entity type template, if there is one (e.g., node.html.twig). * the particular entity type template, if there is one (e.g., node.html.twig).
* See drupal_render() and _theme() for details. *
* See the @link themeable Default theme implementations topic @endlink and
* drupal_render() for details.
* *
* @param array &$build * @param array &$build
* A renderable array representing the entity content. * A renderable array representing the entity content.
...@@ -1373,10 +1377,10 @@ function hook_entity_view_alter(array &$build, Drupal\Core\Entity\EntityInterfac ...@@ -1373,10 +1377,10 @@ function hook_entity_view_alter(array &$build, Drupal\Core\Entity\EntityInterfac
* The entity view display holding the display options configured for the * The entity view display holding the display options configured for the
* entity components. * entity components.
* *
* @ingroup entity_crud
*
* @see hook_ENTITY_TYPE_view() * @see hook_ENTITY_TYPE_view()
* @see hook_entity_view_alter() * @see hook_entity_view_alter()
*
* @ingroup entity_crud
*/ */
function hook_ENTITY_TYPE_view_alter(array &$build, Drupal\Core\Entity\EntityInterface $entity, \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display) { function hook_ENTITY_TYPE_view_alter(array &$build, Drupal\Core\Entity\EntityInterface $entity, \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display) {
if ($build['#view_mode'] == 'full' && isset($build['an_additional_field'])) { if ($build['#view_mode'] == 'full' && isset($build['an_additional_field'])) {
......
...@@ -970,12 +970,8 @@ function hook_page_bottom(array &$page_bottom) { ...@@ -970,12 +970,8 @@ function hook_page_bottom(array &$page_bottom) {
/** /**
* Register a module or theme's theme implementations. * Register a module or theme's theme implementations.
* *
* The implementations declared by this hook have several purposes: * The implementations declared by this hook specify how a particular render
* - They can specify how a particular render array is to be rendered as HTML. * array is to be rendered as HTML.
* This is usually the case if the theme function is assigned to the render
* array's #theme property.
* - They can return HTML for default calls to _theme().
* - They can return HTML for calls to _theme() for a theme suggestion.
* *
* @param array $existing * @param array $existing
* An array of existing implementations that may be used for override * An array of existing implementations that may be used for override
...@@ -1001,19 +997,18 @@ function hook_page_bottom(array &$page_bottom) { ...@@ -1001,19 +997,18 @@ function hook_page_bottom(array &$page_bottom) {
* *
* @return array * @return array
* An associative array of information about theme implementations. The keys * An associative array of information about theme implementations. The keys
* on the outer array are known as "theme hooks". For simple theme * on the outer array are known as "theme hooks". For theme suggestions,
* implementations for regular calls to _theme(), the theme hook is the first * instead of the array key being the base theme hook, the key is a theme
* argument. For theme suggestions, instead of the array key being the base * suggestion name with the format 'base_hook_name__sub_hook_name'.
* theme hook, the key is a theme suggestion name with the format * For render elements, the key is the machine name of the render element.
* 'base_hook_name__sub_hook_name'. For render elements, the key is the * The array values are themselves arrays containing information about the
* machine name of the render element. The array values are themselves arrays * theme hook and its implementation. Each information array must contain
* containing information about the theme hook and its implementation. Each * either a 'variables' element (for using a #theme element) or a
* information array must contain either a 'variables' element (for _theme() * 'render element' element (for render elements), but not both.
* calls) or a 'render element' element (for render elements), but not both.
* The following elements may be part of each information array: * The following elements may be part of each information array:
* - variables: Used for _theme() call items only: an array of variables, * - variables: Only used for #theme in render array: an array of variables,
* where the array keys are the names of the variables, and the array * where the array keys are the names of the variables, and the array
* values are the default values if they are not passed into _theme(). * values are the default values if they are not given in the render array.
* Template implementations receive each array key as a variable in the * Template implementations receive each array key as a variable in the
* template file (so they must be legal PHP/Twig variable names). Function * template file (so they must be legal PHP/Twig variable names). Function
* implementations are passed the variables in a single $variables function * implementations are passed the variables in a single $variables function
...@@ -1041,7 +1036,7 @@ function hook_page_bottom(array &$page_bottom) { ...@@ -1041,7 +1036,7 @@ function hook_page_bottom(array &$page_bottom) {
* - function: If specified, this will be the function name to invoke for * - function: If specified, this will be the function name to invoke for
* this implementation. If neither 'template' nor 'function' are specified, * this implementation. If neither 'template' nor 'function' are specified,
* a default template name will be assumed. See above for more details. * a default template name will be assumed. See above for more details.
* - base hook: Used for _theme() suggestions only: the base theme hook name. * - base hook: Used for theme suggestions only: the base theme hook name.
* Instead of this suggestion's implementation being used directly, the base * Instead of this suggestion's implementation being used directly, the base
* hook will be invoked with this implementation as its first suggestion. * hook will be invoked with this implementation as its first suggestion.
* The base hook's files will be included and the base hook's preprocess * The base hook's files will be included and the base hook's preprocess
...@@ -1051,14 +1046,17 @@ function hook_page_bottom(array &$page_bottom) { ...@@ -1051,14 +1046,17 @@ function hook_page_bottom(array &$page_bottom) {
* suggestion may be used in place of this suggestion. If after * suggestion may be used in place of this suggestion. If after
* hook_theme_suggestions_HOOK() this suggestion remains the first * hook_theme_suggestions_HOOK() this suggestion remains the first
* suggestion, then this suggestion's function or template will be used to * suggestion, then this suggestion's function or template will be used to
* generate the output for _theme(). * generate the rendered output.
* - pattern: A regular expression pattern to be used to allow this theme * - pattern: A regular expression pattern to be used to allow this theme
* implementation to have a dynamic name. The convention is to use __ to * implementation to have a dynamic name. The convention is to use __ to
* differentiate the dynamic portion of the theme. For example, to allow * differentiate the dynamic portion of the theme. For example, to allow
* forums to be themed individually, the pattern might be: 'forum__'. Then, * forums to be themed individually, the pattern might be: 'forum__'. Then,
* when the forum is themed, call: * when the forum is rendered, following render array can be used:
* @code * @code
* _theme(array('forum__' . $tid, 'forum'), $forum) * $render_array = array(
* '#theme' => array('forum__' . $tid, 'forum'),
* '#forum' => $forum,
* );
* @endcode * @endcode
* - preprocess functions: A list of functions used to preprocess this data. * - preprocess functions: A list of functions used to preprocess this data.
* Ordinarily this won't be used; it's automatically filled in. By default, * Ordinarily this won't be used; it's automatically filled in. By default,
...@@ -1078,6 +1076,7 @@ function hook_page_bottom(array &$page_bottom) { ...@@ -1078,6 +1076,7 @@ function hook_page_bottom(array &$page_bottom) {
* - theme path: (automatically derived) The directory path of the theme or * - theme path: (automatically derived) The directory path of the theme or
* module, so that it doesn't need to be looked up. * module, so that it doesn't need to be looked up.
* *
* @see themeable
* @see hook_theme_registry_alter() * @see hook_theme_registry_alter()
*/ */
function hook_theme($existing, $type, $theme, $path) { function hook_theme($existing, $type, $theme, $path) {
......
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