Households

The Households module provides reusable, fieldable entities for managing households and the people who belong to them. It provides a structured way for Drupal sites to store household-level information separately from individual household member information.

Household is designed for sites that need to represent families, households, or similar groups of related people without requiring each person to have a Drupal user account.

Features

Households provides two primary content entity types:

Household

• Represents a family or household.
• Stores the household name and address.
• Supports custom fields through Drupal's Field UI.
• Supports bundles for sites that need different types of households.

Household Member

• Represents an individual belonging to a household.
• Associates each member with a Household entity.
• Stores first and last name, gender, email address, and phone number.
• Supports adult, teen, and child member types.
• Can identify a member as the head of household.
• Stores birth month, day, and year independently, allowing incomplete birth dates when only some information is known.
• Supports custom fields through Drupal's Field UI.
• Supports bundles for additional member types or site-specific implementations.

Both entity types integrate with Drupal's entity system, Views, permissions, and Field UI. This allows site builders to extend the entities with additional fields and create listings, reports, and other displays using familiar Drupal tools.

Households can be useful for churches, schools, nonprofit organizations, conferences, membership organizations, event registration systems, and other applications that need to maintain information about families or households.

Post-Installation

After installing Households, new Household and Household Member entity types are available in Drupal.

Create a Household to represent a family or household and enter its household-level information, such as its name and address. Household Member records can then be created and associated with that household.

Additional fields can be added to either entity through Drupal's Field UI. Form and display settings can also be configured independently for each bundle.

Drupal permissions control who can create, view, edit, delete, and administer Household and Household Member entities, including access to unpublished entities.

Views can be used to build administrative listings, directories, reports, and other displays using Household and Household Member data.

Additional Requirements

Households requires the Address module for storing structured household addresses.

The Telephone module included with Drupal core is also used for household member phone numbers.

Recommended modules/libraries

The following contributed modules may be useful depending on how Households is used:

• Inline Entity Form can be useful when Household or Household Member entities need to be created or edited as part of another entity form.

Households is built using Drupal's standard entity and field APIs, so many modules that work with fieldable content entities can be used to extend its functionality.

Similar projects

Drupal's Group module provides a powerful general-purpose system for organizing entities into groups with memberships, roles, and permissions.

Households has a narrower purpose. It provides dedicated Household and Household Member entities designed for representing household information and individual people within a household. It is intended for applications where household and family data are part of the site's domain model rather than a general-purpose grouping and access-control system.

Supporting this Module

Bug reports, feature requests, and patches are welcome through the project's Drupal.org issue queue.

Community Documentation

Additional documentation and examples can be added as the project develops.