BluePrint-Q
  • Namespace
  • Class

Namespaces

  • bpq
  • ski

Classes

  • admin
  • framework
  • help
  • sales
  • services
  • settings
  • walker_nav
  • walker_nav_edit
  • welcome
  • widget_contact
  • widget_menu
  • widget_profile
  • widget_social_custom
  • widget_social_share
  • widget_social_standard

Functions

  • admin_display_landing
  • admin_footer_left
  • admin_footer_right
  • admin_menus
  • admin_notice_menus
  • admin_notice_widgets
  • admin_title
  • ajax_login_user
  • analytics
  • append_read_more
  • body_classes
  • change_avatar_class
  • change_login_logo_image
  • change_login_logo_title
  • change_login_logo_url
  • change_read_more
  • change_search_form
  • change_widget_args
  • convert_symbol_sidebar_layout
  • cz_change_preview_author
  • cz_change_preview_category
  • cz_change_preview_content
  • cz_change_preview_date
  • cz_change_preview_tag
  • cz_register
  • cz_register_section_alarm
  • cz_register_section_analytics
  • cz_register_section_analytics_plugin_analytics
  • cz_register_section_articles
  • cz_register_section_bottom
  • cz_register_section_color
  • cz_register_section_favicon
  • cz_register_section_favicon_plugin_favicon
  • cz_register_section_flair
  • cz_register_section_format
  • cz_register_section_leader
  • cz_register_section_login
  • cz_register_section_login_plugin_login
  • cz_register_section_masthead
  • cz_register_section_navigation
  • cz_register_section_pagination
  • cz_register_section_pedestal
  • cz_register_section_preview
  • cz_register_section_shop
  • cz_register_section_sidebars
  • cz_register_section_top
  • cz_register_section_type
  • cz_template_include
  • display_alarm
  • display_article_scaffolding_left
  • display_article_scaffolding_right
  • display_bottom
  • display_breadcrumbs
  • display_comment
  • display_comments
  • display_highlight
  • display_masthead
  • display_navigation
  • display_pagination_above
  • display_pagination_below
  • display_pedestal
  • display_post_meta
  • display_sidebars_left
  • display_sidebars_right
  • display_top
  • favicon
  • force_clear
  • highlight_current_nav_item
  • init_plugin_analytics
  • init_plugin_banners
  • init_plugin_benefits
  • init_plugin_bridge
  • init_plugin_contact
  • init_plugin_favicon
  • init_plugin_highlight
  • init_plugin_login
  • init_plugin_menus
  • init_plugin_profile
  • init_plugin_sidebars
  • init_plugin_social
  • init_plugin_span
  • init_plugin_stripes
  • init_plugin_team
  • init_plugin_templates
  • init_plugin_testimonials
  • is_viewing_preview
  • landing_content
  • landing_design
  • landing_donate
  • landing_help
  • landing_included
  • landing_setup
  • landing_upgrade
  • menu_edit_setup
  • menu_edit_update
  • menu_edit_walker
  • metabox_benefit
  • metabox_header
  • metabox_sidebars
  • metabox_span
  • metabox_team
  • metabox_testimonial
  • partner_link
  • postbox_wrap_after
  • postbox_wrap_before
  • posttype_benefit
  • posttype_team
  • posttype_testimonial
  • queue_admin
  • queue_bootstrap
  • queue_bpq
  • queue_core
  • queue_customizer
  • queue_font_awesome
  • queue_login
  • queue_plugin_banners
  • queue_plugin_benefits
  • queue_plugin_highlight
  • queue_plugin_login
  • queue_plugin_menus
  • queue_plugin_sidebars
  • queue_plugin_social
  • queue_plugin_span
  • queue_plugin_stripes
  • queue_plugin_team
  • queue_plugin_testimonials
  • queue_shop
  • queue_tone
  • register_bottom_widgetized_areas
  • register_custom_widgets_plugin_contact
  • register_custom_widgets_plugin_menus
  • register_custom_widgets_plugin_profile
  • register_custom_widgets_plugin_social
  • register_extra_widgetized_areas
  • register_feature_support
  • register_masthead_widgetized_areas
  • register_menu_theme_locations
  • register_packaged_plugins
  • register_pedestal_widgetized_areas
  • register_sidebar_widgetized_areas
  • register_top_widgetized_areas
  • remove_sticky_posts
  • sample_alerts
  • sample_banners
  • sample_benefits
  • sample_buttons
  • sample_contact
  • sample_form_controls
  • sample_images
  • sample_lists
  • sample_marquees
  • sample_navigation
  • sample_overlays
  • sample_panels
  • sample_post_formats
  • sample_products
  • sample_progress_bars
  • sample_stripes
  • sample_tables
  • sample_team_members
  • sample_testimonials
  • sample_text_adornments
  • sample_typography
  • sample_wells
  • shop_add_to_cart_button_size
  • shop_add_to_cart_button_type
  • shop_change_login_url
  • shop_change_product_description_heading
  • shop_change_product_description_tab_title
  • shop_change_product_subheadings_size
  • shop_change_related_product_args
  • shop_display_image_disclaimer
  • shop_display_result_count
  • shop_display_sort_options
  • shop_display_stock
  • shop_icon
  • shop_single_after_meta
  • shop_template_path
  • shortcode_alert
  • shortcode_anchor
  • shortcode_banner
  • shortcode_benefit
  • shortcode_benefit_group
  • shortcode_image
  • shortcode_login_form
  • shortcode_root
  • shortcode_social_custom
  • shortcode_social_share
  • shortcode_social_standard
  • shortcode_split
  • shortcode_team
  • shortcode_template
  • shortcode_testimonial
  • should_use_excerpt
  • style_editor
  • tag_alarm
  • tag_article_scaffolding_left
  • tag_article_scaffolding_right
  • tag_benefit
  • tag_bottom
  • tag_breadcrumbs
  • tag_comments
  • tag_featured_image_emblem
  • tag_featured_image_pennant
  • tag_highlight
  • tag_login_form
  • tag_masthead
  • tag_navigation
  • tag_pagination_archive
  • tag_pagination_attachment
  • tag_pagination_comments
  • tag_pagination_nextpage
  • tag_pagination_single
  • tag_pedestal
  • tag_post_icon
  • tag_post_meta
  • tag_post_meta_author
  • tag_post_meta_categories
  • tag_post_meta_comments
  • tag_post_meta_date
  • tag_post_meta_edit
  • tag_post_meta_tags
  • tag_post_title
  • tag_read_more
  • tag_share_block
  • tag_sidebars_left
  • tag_sidebars_right
  • tag_stripe
  • tag_table
  • tag_team
  • tag_testimonial
  • tag_top
  • theme_activation
  • title
  • tones
  • unused_action
  • unused_filter
  • vc_alert
  • vc_anchor
  • vc_banner
  • vc_benefit
  • vc_benefit_group
  • vc_integrate
  • vc_row
  • vc_social_custom
  • vc_social_share
  • vc_social_standard
  • vc_split
  • vc_team
  • vc_template
  • vc_testimonial
  • vc_text_separator

Class walker_nav

Generates the markup for the main navigation area. This assumes Bootstrap 3's navbar capabilities, which only supports a depth of 2 - that is, 1 parent and 1 child only. Any menu items that are grandchildren or younger will have unexpected results.

Note: This class was originally copied from Walker_Nav_Menu, then modified to accomodate Bootstrap classes. This was done to ensure that the same WP hooks are in-place.

Note: Bootstrap can only support a single parent/child relation. There are no grandchildren support as of Bootstrap 3.0 - apparently, there is a thread where Mark Otto states something along the lines of: "grandchildren not being mobile-friendly". Therefore, at the top of each member function, you will see a chack to ensure that we do not process any items that are at the grandchild level or lower.

Example Bootstrap 3 navbar markup:
  • Menu item 1
  • Menu item 2
  • Menu item 3
    • Menu item 3a
    • Menu item 3b
Walker_Nav_Menu
Extended by bpq\walker_nav
Namespace: bpq
Uses: \Walker_Nav_Menu
Link: http://getbootstrap.com/components/#navbar
Located at services/bpq.service.menus.php

Methods summary

public
# start_lvl( string & $output, integer $depth = 0, array $args = array() )

Starts the list before the elements are added.

Starts the list before the elements are added.

Parameters

$output
string
$output Passed by reference. Used to append additional content.
$depth
integer
$depth Depth of menu item. Used for padding.
$args
array
$args An array of arguments. @see wp_nav_menu()

Since

3.0.0

See

Walker::start_lvl()
public
# end_lvl( string & $output, integer $depth = 0, array $args = array() )

Ends the list of after the elements are added.

Ends the list of after the elements are added.

Parameters

$output
string
$output Passed by reference. Used to append additional content.
$depth
integer
$depth Depth of menu item. Used for padding.
$args
array
$args An array of arguments. @see wp_nav_menu()

Since

3.0.0

See

Walker::end_lvl()
public
# start_el( string & $output, object $item, integer $depth = 0, array $args = array(), integer $id = 0 )

Start the element output.

Start the element output.

Parameters

$output
string
$output Passed by reference. Used to append additional content.
$item
object
$item Menu item data object.
$depth
integer
$depth Depth of menu item. Used for padding.
$args
array
$args An array of arguments. @see wp_nav_menu()
$id
integer
$id Current item ID.

Since

3.0.0

See

Walker::start_el()
public
# end_el( string & $output, object $item, integer $depth = 0, array $args = array() )

Ends the element output, if needed.

Ends the element output, if needed.

Parameters

$output
string
$output Passed by reference. Used to append additional content.
$item
object
$item Page data object. Not used.
$depth
integer
$depth Depth of page. Not Used.
$args
array
$args An array of arguments. @see wp_nav_menu()

Since

3.0.0

See

Walker::end_el()
public null
# display_element( object $element, array & $children_elements, integer $max_depth, integer $depth = 0, array $args, string & $output )

Traverse elements to create list from elements.

Traverse elements to create list from elements.

Display one element if the element doesn't have any children otherwise, display the element and its children. Will only traverse up to the max depth and no ignore elements under that depth. It is possible to set the max depth to include all depths, see walk() method.

This method should not be called directly, use the walk() method instead.

Parameters

$element
object
$element Data object.
$children_elements
array
$children_elements List of elements to continue traversing.
$max_depth
integer
$max_depth Max depth to traverse.
$depth
integer
$depth Depth of current element.
$args
array
$args An array of arguments.
$output
string
$output Passed by reference. Used to append additional content.

Returns

null
Null on failure with no changes to parameters.

Since

2.5.0

Magic methods summary

BluePrint-Q API documentation generated by ApiGen 2.8.0