Builder Hooks

Revision as of 08:03, May 9, 2011

Action and filter hooks are part of the WordPress plugin API. Builder provides a large variety of hooks that offer developers a wealth of customization options.

List of Actions

builder_add_meta_data 

Runs inside the head tag of the site in order to insert meta tags for SEO purposes.

builder_add_title 

builder_comments_popup_link 

builder_custom_settings 

builder_customize_theme_features 

builder_editor_add_custom_settings 

builder_editor_save_custom_settings 

builder_exporter_modify_zip_content 

builder_extension_add_stylesheet 

If a layout extension is selected for the rendering layout, this action fires off inside the head tag in order to add the extension's stylesheet to the layout.

builder_extension_run_functions 

This action is fired immediately after the builder_sidebar_register_layout_sidebars action if the current layout has an extension with a functions.php template file. This action is handled by the BuilderExtensions class and executes the functions.php file of the layout's active extension.

builder_finish 

This action runs after all the rendering processes have finished. A function is attached to this action that closes the body and html tags.

builder_import_export_add_attachment 

builder_import_export_cleanup 

builder_layout_engine_identified_layout 

Fires immediately after the active layout for the view is determined. The layout id is passed as an argument.

builder_layout_engine_render 

This action is fired by the template files to begin the Builder core rendering process. The default action response is to run the BuilderLayoutEngine class' render method. This action is a good place to hook modifications to other rendering actions since it occurs before any actual content is rendered.

builder_layout_engine_render_container 

This action starts the layout rendering process. The function attached to this action prints the container wrappers and fires the builder_layout_engine_render_container_contents action.

builder_layout_engine_render_container_contents 

This action runs inside the container wrappers. The function run by this action fires the builder_layout_engine_render_modules action.

builder_layout_engine_render_content 

This action is fired by the element block of the Content Module. Each template file should add a function to this action in order to render content.

builder_layout_engine_render_footer 

This action is fired by the element block of the Footer Module. The footer.php template file should add a function to this action in order to render footer content.

builder_layout_engine_render_header 

This is the first action called by the default builder_layout_engine_render function. The Builder core runs get_header and a function to output view and layout details for admin users off of this action.

builder_layout_engine_render_modules 

This action starts the module rendering process. The function hooked to this action builds the set of classes and ids for the modules and fires off the builder_module_render action.

builder_layout_engine_set_current_area_width 

builder_layout_engine_set_current_module 

builder_module_enqueue_admin_scripts 

This function is called by the BuilderLayoutEditor class. It allows modules to enqueue scripts that will be added when a module of its type if added or modified.

builder_module_enqueue_admin_styles 

This function is called by the BuilderLayoutEditor class. It allows modules to enqueue styles that will be added when a module of its type if added or modified.

builder_module_render 

This action is fired off once for each module that is rendered. The function attached to this calls the module-specific action builder_module_render_MODULE to tell a specific module to render.

builder_module_render_MODULE 

This action is called by the builder_module_render action. Each module latches onto its specific version of this action to enable it to be rendered where needed.

builder_module_render_contents 

This action is called inside the module wrappers of all modules. The default action is to fire off the module-specific builder_module_render_contents_MODULE action.

builder_module_render_contents_MODULE 

This action is fired off inside the module wrappers. The function attached to this action renders the blocks inside the module.

builder_module_render_element_block 

This action is called inside each module to start the process of rendering the element block. The default action is to fire off the module-specific builder_module_render_element_block_MODULE action.

builder_module_render_element_block_MODULE 

This action is called by the builder_module_render_element_block action. Each module latches onto its specific version of this action to enable it to render the module's element block.

builder_module_render_element_block_contents 

This action is called inside the module's element block wrappers of all modules. The default action is to fire off the module-specific builder_module_render_element_block_contents_MODULE action.

builder_module_render_element_block_contents_MODULE 

This action is called by the builder_module_render_element_block_contents action. Each module latches onto its specific version of this action to enable it to render the module's element block contents.

builder_module_render_sidebar_block 

This action is called inside each module to start the process of rendering the sidebar block. The default action is to fire off the module-specific builder_module_render_sidebar_block_MODULE action.

builder_module_render_sidebar_block_MODULE 

This action is called by the builder_module_render_sidebar_block_contents action. Each module latches onto its specific version of this action to enable it to render the module's sidebar block contents.

builder_module_render_sidebar_block_contents 

This action is called inside the module's sidebar block wrappers of all modules. The default action is to fire off the module-specific builder_module_render_sidebar_block_contents_MODULE action.

builder_module_render_sidebar_block_contents_MODULE 

This action is called by the builder_module_render_sidebar_block_contents action. Each module latches onto its specific version of this action to enable it to render the module's sidebar block contents.

builder_modules_loaded 

This action is run after all the module files have been loaded.

builder_post_widget_editor 

builder_pre_widget_editor 

builder_register_modules 

This action is fired immediately after the the BuilderModules class has loaded. Each module hooks to this action in order to know when to register itself.

builder_sidebar_register 

This action is fired by modules in order to have the BuilderSidebars class register a sidebar.

builder_sidebar_register_layout_sidebars 

This action is fired by the BuilderLayoutEngine class immediately after the active layout is determined. Builder's built-in response to this action is telling each module in the layout to register its sidebars.

builder_sidebar_render 

This action is fired by the sidebar blocks of modules. The default action is handled by the BuilderSidebars class' render_sidebar method.

builder_start 

This action runs at the top of the functions.php template file and indicates the first point where Builder core code begins to run.

builder_template_show_not_found 

builder_theme_features_loaded 

builder_theme_settings_loaded 

it_cache_rebuild_cache_builder-core 

it_cache_render_builder-core 

it_file_cache_prefilter_builder-core_javascript 

it_storage_do_upgrade_builder-theme-settings 

List of Filters

builder_filter_body_attributes 

builder_filter_closed_comments_message 

builder_filter_container_inner_wrapper_attributes 

This filter allows the complete customization of the attributes of the Container's inner wrapper div.

builder_filter_container_outer_wrapper_attributes 

This filter allows the complete customization of the attributes of the Container's outer wrapper div.

builder_filter_current_layout 

This filter allows external code to modify which layout is active for a particular view.

builder_filter_default_settings 

builder_filter_javascript_content 

builder_filter_module_sidebar_options 

builder_filter_module_sidebar_options_MODULE 

builder_filter_register_sidebar_options 

This filter allows access to the change the data sent to the register_sidebar function of WordPress. This data includes the widget and widget-title wrappers, the sidebar name, and the sidebar id.

builder_filter_sidebar_default_widget_args 

builder_filter_theme_settings_defaults 

builder_filter_theme_settings_tab_order 

builder_filter_theme_settings_tabs 

builder_filter_theme_settings_*_meta_boxes 

builder_footer_credit 

This filter runs inside Builder core's footer.php template file to allow easy modification of the footer credit. It may or may not be present in custom child themes.

builder_get_available_views 

This filter is used to retrieve the list of available site views. External code can use this filter to define new views.

builder_get_container_width 

This filter is used to determine the width of the layout's Container. This width is used as the maximum width for the modules.

builder_get_current_layout 

This filter allows access to the current view's layout ID.

builder_get_extension_data 

When passed an extension directory, this filter returns an array containing extension details: name, description, stylesheet path, stylesheet url, functions.php path, and functions.php url.

builder_get_extension_directories 

This filter allows for adding or removing directories to search for extensions.

builder_get_extensions 

When passed an empty array, this filter returns an array containing the data on all found extensions.

builder_get_modules 

This filter should be passed an empty array and will return an array containing the class instances of each module. This gives direct access to each module's data and methods.

builder_layout_engine_get_current_area_width 

builder_layout_engine_get_current_module 

builder_layout_filter_non_layout_post_types 

builder_module_filter_calculated_widths 

Once the module has performed the width calculations based upon the container_width and content_width, an array of the widths (full_sidebar_width, sidebar_widths, and element_widt) is filtered by this filter.

builder_module_filter_css_prefix 

Filtering this string allows for changing the 'builder-module' prefix added to the module classes.

builder_module_filter_element_inner_wrapper_attributes 

This filter allows the complete customization of the attributes of a module element block's inner wrapper div.

builder_module_filter_element_outer_wrapper_attributes 

This filter allows the complete customization of the attributes of a module element block's outer wrapper div.

builder_module_filter_inner_wrapper_attributes 

This filter allows the complete customization of the attributes of a module's inner wrapper div.

builder_module_filter_outer_wrapper_attributes 

This filter allows the complete customization of the attributes of a module's outer wrapper div.

builder_module_filter_render_fields 

This filter allows for modifying the $fields variable that contains all the data used to render a module.

builder_module_filter_sidebar_inner_wrapper_attributes 

This filter allows the complete customization of the attributes of a module sidebar block's inner wrapper div.

builder_module_filter_sidebar_outer_wrapper_attributes 

This filter allows the complete customization of the attributes of a module sidebar block's outer wrapper div.

builder_module_filter_sidebar_wrapper_attributes 

This filter allows the complete customization of the attributes of wrapper div surrounding the sidebar block's contents area.

builder_module_filter_widths 

This filter sends an array containing container_width and content_width. These widths can be modified to change the width calculations done by the module.

builder_module_register_styles 

builder_module_register_styles_MODULE 

it_storage_get_defaults_builder-theme-settings