Builder Hooks - Revision history

Gaarai at 17:51, November 11, 2011

2011-11-11T17:51:34Z

Gaarai at 13:44, May 10, 2011

2011-05-10T13:44:30Z

Gaarai at 13:50, May 9, 2011

2011-05-09T13:50:09Z

Gaarai at 13:49, May 9, 2011

2011-05-09T13:49:57Z

Gaarai at 13:49, May 9, 2011

2011-05-09T13:49:40Z

Gaarai at 13:05, May 9, 2011

2011-05-09T13:05:33Z

Gaarai at 13:03, May 9, 2011

2011-05-09T13:03:02Z

Gaarai at 13:01, May 9, 2011

2011-05-09T13:01:44Z

Ronald: Created page with 'Action and filter hooks are part of the [http://codex.wordpress.org/Plugin_API WordPress plugin API]. Builder provides a large variety of hooks that offer developers a wealth of …'

2010-07-01T23:11:20Z

Created page with 'Action and filter hooks are part of the [http://codex.wordpress.org/Plugin_API WordPress plugin API]. Builder provides a large variety of hooks that offer developers a wealth of …'

New page

Action and filter hooks are part of the [http://codex.wordpress.org/Plugin_API WordPress plugin API]. Builder provides a large variety of hooks that offer developers a wealth of customization options.

== List of Actions ==
; [[Hooks/Action Reference/builder_add_meta_data|builder_add_meta_data]] : Runs inside the head tag of the site in order to insert meta tags for SEO purposes.

; [[Hooks/Action Reference/builder_extension_add_stylesheet|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.

; [[Hooks/Action Reference/builder_extension_run_functions|builder_extension_run_functions]] : This action is fired immediately after the [[Hooks/Action Reference/builder_sidebar_register_layout_sidebars|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.

; [[Hooks/Action Reference/builder_finish|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.

; [[Hooks/Action Reference/builder_layout_engine_identified_layout|builder_layout_engine_identified_layout]] : Fires immediately after the active layout for the view is determined. The layout id is passed as an argument.

; [[Hooks/Action Reference/builder_layout_engine_render|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.

; [[Hooks/Action Reference/builder_layout_engine_render_container|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 [[Hooks/Action Reference/builder_layout_engine_render_container_contents|builder_layout_engine_render_container_contents]] action.

; [[Hooks/Action Reference/builder_layout_engine_render_container_contents|builder_layout_engine_render_container_contents]] : This action runs inside the [[container]] [[wrappers]]. The function run by this action fires the [[Hooks/Action Reference/builder_layout_engine_render_modules|builder_layout_engine_render_modules]] action.

; [[Hooks/Action Reference/builder_layout_engine_render_content|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.

; [[Hooks/Action Reference/builder_layout_engine_render_footer|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.

; [[Hooks/Action Reference/builder_layout_engine_render_header|builder_layout_engine_render_header]] : This is the first action called by the default [[Hooks/Action Reference/builder_layout_engine_render|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.

; [[Hooks/Action Reference/builder_layout_engine_render_modules|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 [[Hooks/Action Reference/builder_module_render|builder_module_render]] action.

; [[Hooks/Action Reference/builder_module_enqueue_admin_scripts|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.

; [[Hooks/Action Reference/builder_module_enqueue_admin_styles|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.

; [[Hooks/Action Reference/builder_module_render|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 [[Hooks/Action Reference/builder_module_render_MODULE|builder_module_render_MODULE]] to tell a specific module to render.

; [[Hooks/Action Reference/builder_module_render_MODULE|builder_module_render_MODULE]] : This action is called by the [[Hooks/Action Reference/builder_module_render|builder_module_render]] action. Each module latches onto its specific version of this action to enable it to be rendered where needed.

; [[Hooks/Action Reference/builder_module_render_contents|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 [[Hooks/Action Reference/builder_module_render_contents_MODULE|builder_module_render_contents_MODULE]] action.

; [[Hooks/Action Reference/builder_module_render_contents_MODULE|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.

; [[Hooks/Action Reference/builder_module_render_element_block|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 [[Hooks/Action Reference/builder_module_render_element_block_MODULE|builder_module_render_element_block_MODULE]] action.

; [[Hooks/Action Reference/builder_module_render_element_block_MODULE|builder_module_render_element_block_MODULE]] : This action is called by the [[Hooks/Action Reference/builder_module_render_element_block|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]].

; [[Hooks/Action Reference/builder_module_render_element_block_contents|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 [[Hooks/Action Reference/builder_module_render_element_block_contents_MODULE|builder_module_render_element_block_contents_MODULE]] action.

; [[Hooks/Action Reference/builder_module_render_element_block_contents_MODULE|builder_module_render_element_block_contents_MODULE]] : This action is called by the [[Hooks/Action Reference/builder_module_render_element_block_contents|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.

; [[Hooks/Action Reference/builder_module_render_sidebar_block|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 [[Hooks/Action Reference/builder_module_render_sidebar_block_MODULE|builder_module_render_sidebar_block_MODULE]] action.

; [[Hooks/Action Reference/builder_module_render_sidebar_block_MODULE|builder_module_render_sidebar_block_MODULE]] : This action is called by the [[Hooks/Action Reference/builder_module_render_element_sidebar_contents|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.

; [[Hooks/Action Reference/builder_module_render_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 [[Hooks/Action Reference/builder_module_render_sidebar_block_contents_MODULE|builder_module_render_sidebar_block_contents_MODULE]] action.

; [[Hooks/Action Reference/builder_module_render_sidebar_block_contents_MODULE|builder_module_render_sidebar_block_contents_MODULE]] : This action is called by the [[Hooks/Action Reference/builder_module_render_sidebar_block_contents|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.

; [[Hooks/Action Reference/builder_modules_loaded|builder_modules_loaded]] : This action is run after all the module files have been loaded.

; [[Hooks/Action Reference/builder_register_modules|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.

; [[Hooks/Action Reference/builder_sidebar_register|builder_sidebar_register]] : This action is fired by [[modules]] in order to have the [[BuilderSidebars]] class register a [[sidebar]].

; [[Hooks/Action Reference/builder_sidebar_register_layout_sidebars|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]].

; [[Hooks/Action Reference/builder_sidebar_render|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.

; [[Hooks/Action Reference/builder_start|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.

== List of Filters ==
; [[Hooks/Filter Reference/builder_filter_container_inner_wrapper_attributes|builder_filter_container_inner_wrapper_attributes]] : This filter allows the complete customization of the attributes of the [[Container|Container's]] inner [[wrapper]] div.

; [[Hooks/Filter Reference/builder_filter_container_outer_wrapper_attributes|builder_filter_container_outer_wrapper_attributes]] : This filter allows the complete customization of the attributes of the [[Container|Container's]] outer [[wrapper]] div.

; [[Hooks/Filter Reference/builder_filter_current_layout|builder_filter_current_layout]] : This filter allows external code to modify which layout is active for a particular view.

; [[Hooks/Filter Reference/builder_filter_register_sidebar_options|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.

; [[Hooks/Filter Reference/builder_footer_credit|builder_footer_credit]] : This filter runs inside [[Builder Core|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.

; [[Hooks/Filter Reference/builder_get_available_views|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.

; [[Hooks/Filter Reference/builder_get_container_width|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.

; [[Hooks/Filter Reference/builder_get_current_layout|builder_get_current_layout]] : This filter allows access to the current view's layout ID.

; [[Hooks/Filter Reference/builder_get_extension_data|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.

; [[Hooks/Filter Reference/builder_get_extension_directories|builder_get_extension_directories]] : This filter allows for adding or removing directories to search for extensions.

; [[Hooks/Filter Reference/builder_get_extensions|builder_get_extensions]] : When passed an empty array, this filter returns an array containing the data on all found extensions.

; [[Hooks/Filter Reference/builder_get_modules|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.

; [[Hooks/Filter Reference/builder_module_filter_calculated_widths|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.

; [[Hooks/Filter Reference/builder_module_filter_css_prefix|builder_module_filter_css_prefix]] : Filtering this string allows for changing the 'builder-module' prefix added to the module classes.

; [[Hooks/Filter Reference/builder_module_filter_element_inner_wrapper_attributes|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.

; [[Hooks/Filter Reference/builder_module_filter_element_outer_wrapper_attributes|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.

; [[Hooks/Filter Reference/builder_module_filter_inner_wrapper_attributes|builder_module_filter_inner_wrapper_attributes]] : This filter allows the complete customization of the attributes of a module's inner [[wrapper]] div.

; [[Hooks/Filter Reference/builder_module_filter_outer_wrapper_attributes|builder_module_filter_outer_wrapper_attributes]] : This filter allows the complete customization of the attributes of a module's outer [[wrapper]] div.

; [[Hooks/Filter Reference/builder_module_filter_render_fields|builder_module_filter_render_fields]] : This filter allows for modifying the [[$fields]] variable that contains all the data used to render a module.

; [[Hooks/Filter Reference/builder_module_filter_sidebar_inner_wrapper_attributes|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.

; [[Hooks/Filter Reference/builder_module_filter_sidebar_outer_wrapper_attributes|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.

; [[Hooks/Filter Reference/builder_module_filter_sidebar_wrapper_attributes|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.

; [[Hooks/Filter Reference/builder_module_filter_widths|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.

← Older revision		Revision as of 17:51, November 11, 2011
Line 137:		Line 137:

	; [[Hooks/Filter Reference/builder_filter_theme_settings_tabs\|builder_filter_theme_settings_tabs]] :		; [[Hooks/Filter Reference/builder_filter_theme_settings_tabs\|builder_filter_theme_settings_tabs]] :
		+
		+	; [[Hooks/Filter Reference/builder_filter_title\|builder_filter_title]] : This filter runs inside the [[builder_add_title]] function to allow easy modification of the page title.

	; [[Hooks/Filter Reference/builder_footer_credit\|builder_footer_credit]] : This filter runs inside [[Builder Core\|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.		; [[Hooks/Filter Reference/builder_footer_credit\|builder_footer_credit]] : This filter runs inside [[Builder Core\|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.

@@ Line 90: / Line 90: @@
 ; [[Hooks/Action Reference/builder_sidebar_render|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.
-; [[Hooks/Action Reference/builder_start|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.
+; [[Hooks/Action Reference/builder_start|builder_start]] : This action indicates the first point where [[Builder core]] code begins to run.
 ; [[Hooks/Action Reference/builder_template_show_not_found|builder_template_show_not_found]] :

@@ Line 4: / Line 4: @@
 ; [[Hooks/Action Reference/builder_add_meta_data|builder_add_meta_data]] : Runs inside the head tag of the site in order to insert meta tags for SEO purposes.
-; [[Hooks/Action Reference/builder_add_title|builder_add_title]] : Renders the <code><title></code> tag.
+; [[Hooks/Action Reference/builder_add_title|builder_add_title]] : Renders the <title> tag.
 ; [[Hooks/Action Reference/builder_comments_popup_link|builder_comments_popup_link]] :

@@ Line 4: / Line 4: @@
 ; [[Hooks/Action Reference/builder_add_meta_data|builder_add_meta_data]] : Runs inside the head tag of the site in order to insert meta tags for SEO purposes.
-; [[Hooks/Action Reference/builder_add_title|builder_add_title]] : Renders the `<title>` tag.
+; [[Hooks/Action Reference/builder_add_title|builder_add_title]] : Renders the <code><title></code> tag.
 ; [[Hooks/Action Reference/builder_comments_popup_link|builder_comments_popup_link]] :

@@ Line 4: / Line 4: @@
 ; [[Hooks/Action Reference/builder_add_meta_data|builder_add_meta_data]] : Runs inside the head tag of the site in order to insert meta tags for SEO purposes.
-; [[Hooks/Action Reference/builder_add_title|builder_add_title]] :
+; [[Hooks/Action Reference/builder_add_title|builder_add_title]] : Renders the `<title>` tag.
 ; [[Hooks/Action Reference/builder_comments_popup_link|builder_comments_popup_link]] :

@@ Line 129: / Line 129: @@
 ; [[Hooks/Filter Reference/builder_filter_sidebar_default_widget_args|builder_filter_sidebar_default_widget_args]] :
 ; [[Hooks/Filter Reference/builder_filter_theme_settings_defaults|builder_filter_theme_settings_defaults]] :
@@ Line 135: / Line 137: @@
 ; [[Hooks/Filter Reference/builder_filter_theme_settings_tabs|builder_filter_theme_settings_tabs]] :
 ; [[Hooks/Filter Reference/builder_footer_credit|builder_footer_credit]] : This filter runs inside [[Builder Core|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.

@@ Line 136: / Line 136: @@
 ; [[Hooks/Filter Reference/builder_filter_theme_settings_tabs|builder_filter_theme_settings_tabs]] :
-; [[Hooks/Filter Reference/builder_filter_theme_settings_{$this->_parent->_active_tab}_meta_boxes|builder_filter_theme_settings_{$this->_parent->_active_tab}_meta_boxes]] :
+; [[Hooks/Filter Reference/builder_filter_theme_settings_*_meta_boxes|builder_filter_theme_settings_*_meta_boxes]] :
 ; [[Hooks/Filter Reference/builder_footer_credit|builder_footer_credit]] : This filter runs inside [[Builder Core|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.

@@ Line 3: / Line 3: @@
 == List of Actions ==
 ; [[Hooks/Action Reference/builder_add_meta_data|builder_add_meta_data]] : Runs inside the head tag of the site in order to insert meta tags for SEO purposes.
 ; [[Hooks/Action Reference/builder_extension_add_stylesheet|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.
@@ Line 9: / Line 23: @@
 ; [[Hooks/Action Reference/builder_finish|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.
 ; [[Hooks/Action Reference/builder_layout_engine_identified_layout|builder_layout_engine_identified_layout]] : Fires immediately after the active layout for the view is determined. The layout id is passed as an argument.
@@ Line 25: / Line 43: @@
 ; [[Hooks/Action Reference/builder_layout_engine_render_modules|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 [[Hooks/Action Reference/builder_module_render|builder_module_render]] action.
 ; [[Hooks/Action Reference/builder_module_enqueue_admin_scripts|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.
@@ Line 55: / Line 77: @@
 ; [[Hooks/Action Reference/builder_modules_loaded|builder_modules_loaded]] : This action is run after all the module files have been loaded.
 ; [[Hooks/Action Reference/builder_register_modules|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.
@@ Line 65: / Line 91: @@
 ; [[Hooks/Action Reference/builder_start|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.
 == List of Filters ==
 ; [[Hooks/Filter Reference/builder_filter_container_inner_wrapper_attributes|builder_filter_container_inner_wrapper_attributes]] : This filter allows the complete customization of the attributes of the [[Container|Container's]] inner [[wrapper]] div.
@@ Line 73: / Line 117: @@
 ; [[Hooks/Filter Reference/builder_filter_current_layout|builder_filter_current_layout]] : This filter allows external code to modify which layout is active for a particular view.
 ; [[Hooks/Filter Reference/builder_filter_register_sidebar_options|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.
 ; [[Hooks/Filter Reference/builder_footer_credit|builder_footer_credit]] : This filter runs inside [[Builder Core|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.
@@ Line 91: / Line 153: @@
 ; [[Hooks/Filter Reference/builder_get_modules|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.
 ; [[Hooks/Filter Reference/builder_module_filter_calculated_widths|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.
@@ Line 113: / Line 181: @@
 ; [[Hooks/Filter Reference/builder_module_filter_widths|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.