diff options
| author | webchick <webchick@24967.no-reply.drupal.org> | 2012-01-31 00:13:12 -0800 |
|---|---|---|
| committer | webchick <webchick@24967.no-reply.drupal.org> | 2012-01-31 00:13:12 -0800 |
| commit | 8abbf61f0eb99138574d3096c38c0f7fec4a6d13 (patch) | |
| tree | 81ea20990eb4ce31d31ab4a97456178024322f69 | |
| parent | 56234fa8eb6d17bdb6277781f8d2489b300c3bb8 (diff) | |
| download | brdo-8abbf61f0eb99138574d3096c38c0f7fec4a6d13.tar.gz brdo-8abbf61f0eb99138574d3096c38c0f7fec4a6d13.tar.bz2 | |
Issue #1372280 by sven.lauer: Document that field_info_field_by_id() may also be used for deleted fields.
| -rw-r--r-- | modules/field/field.info.inc | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/modules/field/field.info.inc b/modules/field/field.info.inc index 77e9b441a..3b36c0355 100644 --- a/modules/field/field.info.inc +++ b/modules/field/field.info.inc @@ -606,8 +606,9 @@ function field_info_fields() { * * @param $field_name * The name of the field to retrieve. $field_name can only refer to a - * non-deleted, active field. Use field_read_fields() to retrieve information - * on deleted or inactive fields. + * non-deleted, active field. For deleted fields, use + * field_info_field_by_id(). To retrieve information about inactive fields, + * use field_read_fields(). * * @return * The field array, as returned by field_read_fields(), with an @@ -628,7 +629,7 @@ function field_info_field($field_name) { * * @param $field_id * The id of the field to retrieve. $field_id can refer to a - * deleted field. + * deleted field, but not an inactive one. * * @return * The field array, as returned by field_read_fields(), with an |