CRM-17646 - Mark older hooks deprecated
authorColeman Watts <coleman@civicrm.org>
Sat, 26 Dec 2015 03:01:28 +0000 (22:01 -0500)
committerColeman Watts <coleman@civicrm.org>
Sat, 26 Dec 2015 03:09:50 +0000 (22:09 -0500)
CRM/Utils/Hook.php

index 706757b6d92d75b836a00e1c647533883dda8197..dc4907f3dd02c7210d2dedcb562ccb0194d2a014 100644 (file)
@@ -767,8 +767,9 @@ abstract class CRM_Utils_Hook {
   }
 
   /**
-   * This hook is called when CiviCRM needs to edit/display a custom field with options (select, radio, checkbox,
-   * adv multiselect)
+   * This hook is called when CiviCRM needs to edit/display a custom field with options
+   *
+   * @deprecated in favor of hook_civicrm_fieldOptions
    *
    * @param int $customFieldID
    *   The custom field ID.
@@ -779,8 +780,7 @@ abstract class CRM_Utils_Hook {
    *              to be careful to not overwrite the array.
    *   Only add/edit/remove the specific field options you intend to affect.
    * @param bool $detailedFormat
-   *   If true,.
-   *                the options are in an ID => array ( 'id' => ID, 'label' => label, 'value' => value ) format
+   *   If true, the options are in an ID => array ( 'id' => ID, 'label' => label, 'value' => value ) format
    * @param array $selectAttributes
    *   Contain select attribute(s) if any.
    *
@@ -1079,6 +1079,8 @@ abstract class CRM_Utils_Hook {
   /**
    * This hooks allows to change option values.
    *
+   * @deprecated in favor of hook_civicrm_fieldOptions
+   *
    * @param array $options
    *   Associated array of option values / id
    * @param string $name