/drupal7/modules/field/field.api.php - Diff - Club Drupal - Forge Centrale Marseille

Révision 4444412d

Ajouté par Julien Enselme il y a presque 10 ans

ID 4444412d69b63a2a92823d33010eb3e1e727e1c3
Parent 2ca260f4
Enfant b230fec6

Update drupal 7.27 -> 7.28

     <?php
     /**
      * @file
      * Hooks provided by the Field module.
      */
     /**
      * @addtogroup hooks
-...
      *   - delete: (optional) String containing markup (normally a link) used as the
      *     element's 'delete' operation in the administration interface. Only for
      *     'form' context.
+     *
      * @ingroup field_types
      */
     function hook_field_extra_fields() {
       $extra['node']['poll'] = array(
-...
      *   The associative array of 'pseudo-field' components.
+     *
      * @see hook_field_extra_fields()
+     *
      * @ingroup field_types
      */
     function hook_field_extra_fields_alter(&$info) {
       // Force node title to always be at the top of the list by default.
-...
      *   The source entity from which field values are being copied.
      * @param $source_langcode
      *   The source language from which field values are being copied.
+     *
      * @ingroup field_language
      */
     function hook_field_prepare_translation($entity_type, $entity, $field, $instance, $langcode, &$items, $source_entity, $source_langcode) {
       // If the translating user is not permitted to use the assigned text format,
-...
      */
     /**
      * @ingroup field_attach
      * @addtogroup field_attach
      * @{
      */
-...
      * This hook is invoked after the field module has performed the operation.
+     *
      * See field_attach_validate() for details and arguments.
+     *
      * @param $entity_type
      *   The type of $entity; e.g., 'node' or 'user'.
      * @param $entity
      *   The entity with fields to validate.
      * @param array $errors
      *   An associative array of errors keyed by field_name, language, delta.
      */
     function hook_field_attach_validate($entity_type, $entity, &$errors) {
       // @todo Needs function body.
-...
      *   - entity_type: The type of the entity to be displayed.
      *   - entity: The entity with fields to render.
      *   - langcode: The language code $entity has to be displayed in.
+     *
      * @ingroup field_language
      */
     function hook_field_language_alter(&$display_language, $context) {
       // Do not apply core language fallback rules if they are disabled or if Locale
-...
      *   An associative array containing:
      *   - entity_type: The type of the entity the field is attached to.
      *   - field: A field data structure.
+     *
      * @ingroup field_language
      */
     function hook_field_available_languages_alter(&$languages, $context) {
       // Add an unavailable language.
-...
      * @param $entity_type
      *   The type of entity; for example, 'node' or 'user'.
      * @param $bundle
      *   The bundle that was just deleted.
      *   The name of the bundle that was just deleted.
      * @param $instances
      *   An array of all instances that existed for the bundle before it was
      *   deleted.
-...
+    }
     /**
      * @} End of "defgroup field_attach".
      * @} End of "addtogroup field_attach".
      */
     /**
-...
+      }
+    }
     /**
      * @} End of "addtogroup field_storage
      */
     /**
      * Returns the maximum weight for the entity components handled by the module.
+     *
-...
      * @param $context
      *   The context for which the maximum weight is requested. Either 'form', or
      *   the name of a view mode.
+     *
      * @return
      *   The maximum weight of the entity's components, or NULL if no components
      *   were found.
+     *
      * @ingroup field_info
      */
     function hook_field_info_max_weight($entity_type, $bundle, $context) {
       $weights = array();
-...
       return $weights ? max($weights) : NULL;
+    }
     /**
      * @addtogroup field_types
      * @{
      */
     /**
      * Alters the display settings of a field before it gets displayed.
+     *
-...
+      }
+    }
     /**
      * @} End of "addtogroup field_types
      */
     /**
      * Alters the display settings of pseudo-fields before an entity is displayed.
+     *
-...
      *   - entity_type: The entity type; e.g., 'node' or 'user'.
      *   - bundle: The bundle name.
      *   - view_mode: The view mode, e.g. 'full', 'teaser'...
+     *
      * @ingroup field_types
      */
     function hook_field_extra_fields_display_alter(&$displays, $context) {
       if ($context['entity_type'] == 'taxonomy_term' && $context['view_mode'] == 'full') {
-...
      *   - instance: The instance of the field.
+     *
      * @see hook_field_widget_properties_alter()
+     *
      * @ingroup field_widget
      */
     function hook_field_widget_properties_ENTITY_TYPE_alter(&$widget, $context) {
       // Change a widget's type according to the time of day.
-...
+      }
+    }
     /**
      * @} End of "addtogroup field_storage".
      */
     /**
      * @addtogroup field_crud
      * @{
-...
+     *
      * @param $field
      *   The field being purged.
+     *
      * @ingroup field_storage
      */
     function hook_field_storage_purge_field($field) {
       $table_name = _field_sql_storage_tablename($field);
-...
+     *
      * @param $instance
      *   The instance being purged.
+     *
      * @ingroup field_storage
      */
     function hook_field_storage_purge_field_instance($instance) {
       db_delete('my_module_field_instance_info')
-...
      *   The (possibly deleted) field whose data is being purged.
      * @param $instance
      *   The deleted field instance whose data is being purged.
+     *
      * @ingroup field_storage
      */
     function hook_field_storage_purge($entity_type, $entity, $field, $instance) {
       list($id, $vid, $bundle) = entity_extract_ids($entity_type, $entity);
-...
+     *
      * @return
      *   TRUE if the operation is allowed, and FALSE if the operation is denied.
+     *
      * @ingroup field_types
      */
     function hook_field_access($op, $field, $entity_type, $entity, $account) {
       if ($field['field_name'] == 'field_of_interest' && $op == 'edit') {

Formats disponibles : Unified diff

Projet

Général

Profil

Club Drupal

Révision 4444412d

Ajouté par Julien Enselme il y a presque 10 ans