Hooks

def my_theme_options(args)
  args[:links] << link_to("My link", root_url)
end

Triggered when model_content.the_title was called

title: current content title

post: current content model

{content: (excerpt.present? ? excerpt : object.content.truncate(qty_chars)),

post: object}

Triggered when model_content.the_excerpt was called

content: current excerpt generated

post: current content model

Triggered when model_content.the_content was called

content: current content

post: current content model

image: current image url

post: current content model

flag: true/false. false => can't be visited

post: current content model

Triggered to filter collection of contents for current visitor for category page, post_type and post_tag.

active_record: current content records to be shown in the list.

Note: Above is for a single model.

Triggered when a model.the_title was called. This is only for models inherit from taxonomy, like: post, post_type, post_tag, category.

You can detect the model like this: args[:object].class.name == "PostType"

def my_plugin_options(args)
  args[:links] << link_to("My link", root_url)
end

Triggered for each request when the admin module is being accessed

Triggered for each request when the admin module was accessed

Triggered when the content list is loading. Permit you to add custom columns in the table (header).

from_body: true => for render table body columns

from_body: false => for render table header columns

content: custom variable where you can add your custom html

Triggered when the categories list is loading. Permit you to customize results.

categories: collection of categories

post_type: current post_type model

Permit to add custom html content into category form.
Sample:

def my_hook_for_category_form(args)
  args[:html] = "<div> <label>My label</label><br> 
                 <input name='my_custom_input' 
                 value='#{params[:category].custom_value}' />
                </div>"
end

Permit to add custom columns for the category list table (table header)

Triggered when the content list is loading. Permit you to customize records, tabs (buttons).

posts: collection of contents to be shown in the list

post_type: current post_type

btns: array of tabs, sample: published: "Published (#{args[:

posts_all].where(status: "published").size})

all_posts: the same as posts

render: current template to be rendered

Triggered to show the form for a new content.

post: new content model

post_type: current post_type

extra_settings: array of custom html to be shown on sidebar

render: current template to be rendered 

Triggered when a new content is being registered. Permit to add extra validations.

post: current content to be saved

post_type: current post_type

 Triggered after a new content was registered.

post: current content saved

post_type: current post_type

Triggered to show the form for edit a content.

post: new content model

post_type: current post_type

extra_settings: array of custom html to be shown on sidebar

render: current template to be rendered 

Triggered when a content is being updated. Permit to add extra validations.

post: current content to be updated

post_type: current post_type

post: current content updated

post_type: current post_type

Triggered when a content is being destroyed. Permit to add extra validations.

post: current content to be destroyed

post_type: current post_type

flag: true/false, indicate if content can be destroyed or not

Triggered when a content was destroyed. 

post: current content to be updated

post_type: current post_type

Permit to add custom templates in the dropdown of templates for post editor.

Permit to add custom layouts in the dropdown of layouts for post editor.

Triggered before save a new post draft.

Triggered after saved a new post draft.

Triggered before update a post draft.

Triggered after user was updated

Triggered to show edit user form.

Triggered to show new user form.

Triggered after user was saved.

Triggered after user was destroyed.

Permit to add custom roles to be listed in editing roles form
Sample: args[:roles_list][:manager] << { key: 'my_role_key', label: "my_custom_permission", description: "lorem ipsum"}
authorize! :manage, :my_role_key
Sample permission for post_types:
https://camaleon.website/documentation/category/40756-uncategorized/custom-models.html

Permit to register custom field elements, sample:
https://camaleon.website/documentation/category/139779-examples/create-custom-field.html
Params:
fields: Hash of existent fields.
Each field has this structure:
key: (String, required)
label: (String, required)
options: (Hash) includes:
  - required (boolean if the field support required option)
  - multiple: (boolean if the field support multiple values)
  - default_value: (String) default value for the field
  - translate: (boolean) if the field permit to be translatable
  - multiple_options: (Hash) {label: (String), default: (String "radio | checkbox"), use_no_default: (Boolean)} permit to enter option values for multiple checkboxes or group of radios

  - extra_fields: (Array({item}, {item})) list of fields with following structure:
    type: (String) text_box | checkbox | text_area | select | radio
    key: (String) key of the extra field
    label: (String) label of the extra field
    description: (String) description of the extra field
    values: (Array(value, value, ..)) array of values with the following structure: {value: (value of the option), label: (String label of the option)}. only for extra fields with type select|radio.
Samples: here.

Permit to customize the email values before to delivery the email:
template_name: (String) Name of the template to be rendered (default: "html_mailer/mailer.html.erb")
layout_name: (String) Name of the layout to be rendered (default: "mailer.html.erb")
mail_data: (Hash) This is a Hash that contain current email params, such us: to, from, subject, ...
files: (Array) This is an array of files to be attached in the email
format: (String) This is the format of the email, if this is empty, this will send a simple inline text (default html)

args =

{
  server: (String) local | aws,
  thumb: {w: (Integer), h: (Integer)},
  aws_settings: { # only for AWS
    region: (String),
    access_key: (String),
    secret_key: (String),
    bucket: (String),
    cloud_front: (String),
    aws_file_upload_settings: lambda{|settings| settings }, 
    aws_file_read_settings: lambda{|data, s3_file| data }
  }
}

Permit to customize the uploder.
aws_file_upload_settings : permit to add your custom attributes for file_upload https://docs.aws.amazon.com/sdkforruby/api/Aws/S3/Object.html#upload_file-instance_method
aws_file_read_settings: permit to read custom attributes from aws file and add to file parsed object

Permit to customize the settings of the file before to upload.

Permit to customize the thumbnail generation.

Triggered for each request when the frontend module is being accessed

Triggered for each request when the frontend module was accessed

Triggered to customize the layout for frontend. Default layout "index".

Triggered for access into home page (index)

Triggered when a category is being accessed.

category: current category

layout: current layout to be rendered

render: current template to be rendered

Triggered when a post type is being accessed.

post_type: current post_type

layout: current layout to be rendered

render: current template to be rendered

Triggered when a post tag is being accessed.

post_tag: current post_tag

layout: current layout to be rendered

render: current template to be rendered

Triggered to execute search request.

layout: current layout to be rendered

render: current template to be rendered

Triggered on render user profile on frontend

Triggered to execute ajax requests.

layout: nil

render_file: current template to be rendered

render_text: answer for ajax request

Triggered when a post (content) is being accessed.

post_type: Post_type of the current content

layout: current layout to be rendered

render: current template to be rendered

post: current content model

Triggered when SEO attributes are created.
You can customize or add extra attributes for SEO by this hook.
Receive a Hash with:
- seo_data: Hash with current seo attributes
- object: current model for current page.
     - home page: current_site
     - category page: Category
     - posttype page: Posttype
     - posttag page: Posttag
     - post page: Post

To see all attributes supported, visit here.
Sample:

def my_custom_seo(args)
  args[:seo_data][:title] = 
    "#{current_site.the_title} | 
     #{args[:object].the_title}" unless is_home?
  args[:seo_data][:twitter][:site] = 
    current_site.the_field("twitter_username")
    # Note: you need to add field
end

on_render_sitemap

triggered visiting https://localhost:3000/sitemap.xml
With hook "on_render_sitemap" you can
- skip post_types, categories, tags or posts
- you can change render file and layout
- you can add custom sitemap elements in the attr "custom", like: https://github.com/owen2345/camaleon-cms/issues/106#issuecomment-146232211
- you can customize your content for html or xml format 

on_render_robots

Triggered to show https://localhost:3000/robots.txt

on_render_rss

Triggered on https://localhost:3000/rss.rss

Triggered after login user. Also you can customize the redirect url after login

Triggered  after user was registered. Also permit to customize the redirect url after registered