You are here

Home » API reference » Block reference 7

README.txt in Block reference 7

Same filename and directory in other branches
  1. 7.2 README.txt
Block reference README

CONTENTS OF THIS FILE
----------------------

  * Introduction
  * Installation
  * Usage
  * Theming
  * Notes


INTRODUCTION
------------
Defines a field type Block reference which creates a relationship to a block and
allows the block to be displayed as the content of the field.

Project page: http://drupal.org/project/blockreference.


INSTALLATION
------------
Install and enable the Block reference module.
For detailed instructions on installing contributed modules see:
http://drupal.org/documentation/install/modules-themes/modules-7


USAGE
-----
Block reference fields will now be available in the Field UI.
For detailed instructions on using the Field UI see:
http://drupal.org/documentation/modules/field-ui


THEMEING
--------
To assist in themeing blocks that are displayed using the block reference
module, the block reference element is available in the $variables array in
template_preprocess_block().

The element can be found at:

    $variables['elements']['#blockreference_element']

Note that the element will not be there for non-blockreference blocks so you
should first check the existence of the element before using its contents.


NOTES
-----
* Relationships are saved using the block's `bid`, not its delta +
  module.
* Block configuration visibility settings are respected since version
  7.x-1.14. If a referenced block does not appear when viewing the node,
  check the block's visibility settings on /admin/structure/block. Note
  that visibility settings are evaluated regardless of whether the
  block is assigned to a region.

File

README.txt
View source 
  1. 

  2. Block reference README

  3. 

  4. CONTENTS OF THIS FILE

  5. ----------------------

  6. 

  7.   * Introduction

  8.   * Installation

  9.   * Usage

  10.   * Theming

  11.   * Notes

  12. 

  13. 

  14. INTRODUCTION

  15. ------------

  16. Defines a field type Block reference which creates a relationship to a block and

  17. allows the block to be displayed as the content of the field.

  18. 

  19. Project page: http://drupal.org/project/blockreference.

  20. 

  21. 

  22. INSTALLATION

  23. ------------

  24. Install and enable the Block reference module.

  25. For detailed instructions on installing contributed modules see:

  26. http://drupal.org/documentation/install/modules-themes/modules-7

  27. 

  28. 

  29. USAGE

  30. -----

  31. Block reference fields will now be available in the Field UI.

  32. For detailed instructions on using the Field UI see:

  33. http://drupal.org/documentation/modules/field-ui

  34. 

  35. 

  36. THEMEING

  37. --------

  38. To assist in themeing blocks that are displayed using the block reference

  39. module, the block reference element is available in the $variables array in

  40. template_preprocess_block().

  41. 

  42. The element can be found at:

  43. 

  44.     $variables['elements']['#blockreference_element']

  45. 

  46. Note that the element will not be there for non-blockreference blocks so you

  47. should first check the existence of the element before using its contents.

  48. 

  49. 

  50. NOTES

  51. -----

  52. * Relationships are saved using the block's `bid`, not its delta +

  53.   module.

  54. * Block configuration visibility settings are respected since version

  55.   7.x-1.14. If a referenced block does not appear when viewing the node,

  56.   check the block's visibility settings on /admin/structure/block. Note

  57.   that visibility settings are evaluated regardless of whether the

  58.   block is assigned to a region.