@@ -274,43 +274,49 @@ At the moment the available source plugin tags are the following:
274274Alter pattern configuration forms
275275---------------------------------
276276
277- When you want to extend a pattern with the additional configuration, you can alter UI Patterns configuration forms with two hooks .
277+ You can alter UI Patterns configuration forms by implementing `` hook_ui_patterns_display_settings_form_alter() `` .
278278
279- This sample hook implementation adds a CSS class input field to the pattern configuration.
280-
281- To alter the ``Layout form `` implement ``hook_ui_patterns_layouts_display_settings_form_alter ``.
282-
283- This form is rendered when you select a pattern as a layout.
279+ For example, the following implementation adds a CSS class input field to the pattern configuration:
284280
285281.. code-block :: php
286282
287283 <?php
288284
289285 /**
290- * Implements hook_ui_patterns_layouts_display_settings_form_alter ().
286+ * Implements hook_ui_patterns_display_settings_form_alter ().
291287 *
292288 * Add a css class name configuration option.
293289 */
294- function hook_ui_patterns_layouts_display_settings_form_alter(array & $form, PatternDefinition $definition, array $configuration) {
295- $class_name = isset($configuration['class_name']) ? $configuration['class_name'] : "";
296- $form['class_name'] = ['#type' => 'input', '#title' => 'Class name', '#default_value' => $class_name];
290+ function my_module_ui_patterns_display_settings_form_alter(array & $form, array $configuration) {
291+ $setting_value = isset($configuration['class_name']) ? $configuration[$key] : '';
292+ $form['class_name'] = [
293+ '#type' => 'input',
294+ '#title' => t('Class name'),
295+ ];
297296 }
298297
298+ This hook alter forms that are built using the ``PatternDisplayFormTrait `` trait, meaning:
299299
300- To alter the ``Pattern setting form `` implement ``hook_ui_patterns_display_settings_form_alter ``.
300+ - Display Suite field templates
301+ - Field groups
302+ - Views
301303
302- This form is rendered when viewing ``field patterns `` or ``fieldgroup patterns ``.
304+ If you want to alter an entity layout form that uses UI Patters for its layout use
305+ ``hook_ui_patterns_layouts_display_settings_form_alter() `` instead, for example:
303306
304307.. code-block :: php
305308
306309 <?php
307310
308311 /**
309- * Implements hook_ui_patterns_display_settings_form_alter ().
312+ * Implements hook_ui_patterns_layouts_display_settings_form_alter ().
310313 *
311314 * Add a css class name configuration option.
312315 */
313- function hook_ui_patterns_display_settings_form_alter(array & $form, array $configuration) {
314- $setting_value = isset($configuration['class_name']) ? $configuration[$key] : "";
315- $form['class_name'] = ['#type' => 'input', '#title' => 'Class name'];
316+ function hook_ui_patterns_layouts_display_settings_form_alter(array & $form, PatternDefinition $definition, array $configuration) {
317+ $class_name = isset($configuration['class_name']) ? $configuration['class_name'] : '';
318+ $form['class_name'] = [
319+ '#type' => 'input',
320+ '#title' => t('Class name'),
321+ ];
316322 }
0 commit comments