This is the documentation for concrete5 version 5.6 and earlier. View Current Documentation

The following is a list of page, file and user attributes that concrete5 makes use of.

 


concrete5 makes use of certain attributes for different options. For example, the page attribute "Exclude from Nav" (with the handle "exclude_nav") is created during installation. If it is assigned and checked to a particular page, that page will not show up in any navigations that the Auto-Nav block creates. The following list contains all page and file attributes used by the system, and what they're used for. Some of these are created during installation, some are not. To make use of these, simply create the attribute if it doesn't exist, with the proper handled and attribute type, which are both listed below.

Page Attributes

exclude_nav - Checkbox

When added to a page and checked, the page will not appear in any Auto-Nav view templates (regular, breadcrumb, header menu, etc...)

exclude_page_list - Checkbox

When added to a page and checked, the page will not appear in any Page List view templates.

header_extra_content - Text Area

When added to a page, the contents will be printed out when the "header_required" element is loaded (which happens automatically in every theme.)

exclude_search_index - Checkbox

When added to a page and checked, the page will not appear in the search index.

exclude_sitemapxml - Checkbox

When added to a page and checked, the page will not appear in the sitemap.xml file created by the Generate Sitemap job.

is_featured - Checkbox

Used by the page list to show only "featured" pages. Will not be available in the add/edit interface for a page list until it is created.

replace_link_with_first_in_nav - Checkbox

Used by the Auto-Nav. When added and activated for a particular page, and that page is linked to using the Auto-Nav, the parent page will not be linked to. Instead, the page with the lowest display order within the parent page will be linked to instead. (e.g. Click on "Locations" in a navigation, and actually link to "/locations/first-location" instead. 

nav_target - Text Field or Select Menu

When added to a page, the Auto-Nav and Page List blocks will use the saved value as the item's target, allowing site owners to control whether certain links open in certain windows/frames. (Note: requires concrete5 5.4.1)

File Attributes

width - Number

Contains the file's width, as set by the importer routine. Valid on images, and sometimes on PDFs and movie files.

height - Number

Contains the file's height, as set by the importer routine. Valid on images, and sometimes on PDFs and movie files.

User Attributes

profile_private_messages_enabled - Checkbox

Controls whether the user can receive private messages through their profile. They can change this value when they edit their profile.

profile_private_messages_notification_enabled - Checkbox

If the user has chosen to receive private messages, this setting controls whether they will be emailed when a private message comes through. 

disable_emails - Checkbox

Global email setting that should control whether the user receives any emails from their concrete5 site at all. Add-On developers should check this setting before sending emails to users. 

Loading Conversation