Drupal
/
drupal
mirror of https://git.drupalcode.org/project/drupal.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Issue #3033900 by pcambra: Fix documentation on field_ui.api.php

merge-requests/1119/head
Alex Pott 2019-04-02 17:08:27 +01:00
parent 3f9f063dd1
commit de09969baf
No known key found for this signature in database
GPG Key ID: 31905460D4A69276
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
core/modules/field_ui/field_ui.api.php
View File

@ -17,7 +17,7 @@
* The instantiated field formatter plugin. * The instantiated field formatter plugin.
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition. * The field definition.
* @param $view_mode * @param string $view_mode
* The entity view mode. * The entity view mode.
* @param array $form * @param array $form
* The (entire) configuration form array. * The (entire) configuration form array.
@ -27,9 +27,9 @@
* @return array * @return array
* Returns the form array to be built. * Returns the form array to be built.
* *
* @see \Drupal\field_ui\DisplayOverView * @see \Drupal\field_ui\Form\EntityViewDisplayEditForm::thirdPartySettingsForm()
*/ */
function hook_field_formatter_third_party_settings_form(\Drupal\Core\Field\FormatterInterface $plugin, \Drupal\Core\Field\FieldDefinitionInterface $field_definition, $view_mode, $form, \Drupal\Core\Form\FormStateInterface $form_state) { function hook_field_formatter_third_party_settings_form(\Drupal\Core\Field\FormatterInterface $plugin, \Drupal\Core\Field\FieldDefinitionInterface $field_definition, $view_mode, array $form, \Drupal\Core\Form\FormStateInterface $form_state) {
$element = []; $element = [];
// Add a 'my_setting' checkbox to the settings form for 'foo_formatter' field // Add a 'my_setting' checkbox to the settings form for 'foo_formatter' field
// formatters. // formatters.
@ -50,7 +50,7 @@ function hook_field_formatter_third_party_settings_form(\Drupal\Core\Field\Forma
* The instantiated field widget plugin. * The instantiated field widget plugin.
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition. * The field definition.
* @param $form_mode * @param string $form_mode
* The entity form mode. * The entity form mode.
* @param array $form * @param array $form
* The (entire) configuration form array. * The (entire) configuration form array.
@ -60,9 +60,9 @@ function hook_field_formatter_third_party_settings_form(\Drupal\Core\Field\Forma
* @return array * @return array
* Returns the form array to be built. * Returns the form array to be built.
* *
* @see \Drupal\field_ui\FormDisplayOverView * @see \Drupal\field_ui\Form\EntityFormDisplayEditForm::thirdPartySettingsForm()
*/ */
function hook_field_widget_third_party_settings_form(\Drupal\Core\Field\WidgetInterface $plugin, \Drupal\Core\Field\FieldDefinitionInterface $field_definition, $form_mode, $form, \Drupal\Core\Form\FormStateInterface $form_state) { function hook_field_widget_third_party_settings_form(\Drupal\Core\Field\WidgetInterface $plugin, \Drupal\Core\Field\FieldDefinitionInterface $field_definition, $form_mode, array $form, \Drupal\Core\Form\FormStateInterface $form_state) {
$element = []; $element = [];
// Add a 'my_setting' checkbox to the settings form for 'foo_widget' field // Add a 'my_setting' checkbox to the settings form for 'foo_widget' field
// widgets. // widgets.
@ -81,15 +81,15 @@ function hook_field_widget_third_party_settings_form(\Drupal\Core\Field\WidgetIn
* *
* @param array $summary * @param array $summary
* An array of summary messages. * An array of summary messages.
* @param $context * @param array $context
* An associative array with the following elements: * An associative array with the following elements:
* - formatter: The formatter object. * - formatter: The formatter plugin.
* - field_definition: The field definition. * - field_definition: The field definition.
* - view_mode: The view mode being configured. * - view_mode: The view mode being configured.
* *
* @see \Drupal\field_ui\DisplayOverView * @see \Drupal\field_ui\Form\EntityViewDisplayEditForm::alterSettingsSummary()
*/ */
function hook_field_formatter_settings_summary_alter(&$summary, $context) { function hook_field_formatter_settings_summary_alter(array &$summary, array $context) {
// Append a message to the summary when an instance of foo_formatter has // Append a message to the summary when an instance of foo_formatter has
// mysetting set to TRUE for the current view mode. // mysetting set to TRUE for the current view mode.
if ($context['formatter']->getPluginId() == 'foo_formatter') { if ($context['formatter']->getPluginId() == 'foo_formatter') {
@ -110,9 +110,9 @@ function hook_field_formatter_settings_summary_alter(&$summary, $context) {
* - field_definition: The field definition. * - field_definition: The field definition.
* - form_mode: The form mode being configured. * - form_mode: The form mode being configured.
* *
* @see \Drupal\field_ui\FormDisplayOverView * @see \Drupal\field_ui\Form\EntityFormDisplayEditForm::alterSettingsSummary()
*/ */
function hook_field_widget_settings_summary_alter(&$summary, $context) { function hook_field_widget_settings_summary_alter(array &$summary, array $context) {
// Append a message to the summary when an instance of foo_widget has // Append a message to the summary when an instance of foo_widget has
// mysetting set to TRUE for the current view mode. // mysetting set to TRUE for the current view mode.
if ($context['widget']->getPluginId() == 'foo_widget') { if ($context['widget']->getPluginId() == 'foo_widget') {