BluePrint-Q
  • Namespace
  • Class

Namespaces

  • bpq
  • ski

Classes

  • bootstrap
  • convert
  • cz_checkbox_ctl
  • cz_color_palette_ctl
  • cz_date_picker_ctl
  • cz_detail_ctl
  • cz_divider_1_ctl
  • cz_divider_2_ctl
  • cz_drop_categories_ctl
  • cz_drop_ctl
  • cz_drop_image_sizes_ctl
  • cz_drop_menu_items_ctl
  • cz_drop_menus_ctl
  • cz_drop_pages_ctl
  • cz_drop_post_types_ctl
  • cz_drop_posts_ctl
  • cz_drop_tags_ctl
  • cz_drop_taxonomies_ctl
  • cz_drop_terms_ctl
  • cz_drop_users_ctl
  • cz_dummy_ctl
  • cz_media_library_ctl
  • cz_number_bar_ctl
  • cz_radio_image_align_x_ctl
  • cz_radio_image_align_y_ctl
  • cz_radio_image_alignment_ctl
  • cz_radio_image_ctl
  • cz_radio_image_sidebar_layout_ctl
  • cz_radio_image_site_span_layout_ctl
  • cz_radio_text_ctl
  • cz_text_area_ctl
  • cz_textbox_ctl
  • db
  • db_recordset
  • drop
  • mail
  • math
  • mb_checkbox_ctl
  • mb_ctl
  • mb_date_picker_ctl
  • mb_detail_ctl
  • mb_divider_ctl
  • mb_drop_ctl
  • mb_media_library_ctl
  • mb_number_bar_ctl
  • mb_radio_image_ctl
  • mb_radio_image_sidebar_layout_ctl
  • mb_radio_image_site_span_layout_ctl
  • mb_radio_text_ctl
  • mb_repeater_ctl
  • mb_text_area_ctl
  • mb_text_ctl
  • mb_text_notice_ctl
  • mb_textbox_ctl
  • media
  • metabox
  • path
  • post
  • question
  • sanitize
  • string
  • textbox

Traits

  • cz_supplement

Functions

  • customize_register_section
  • cz_enqueue
  • init
  • metabox_sample

Namespace ski

Classes summary

bootstrap A utility class for performing operations on Bootstrap markup.
convert A utility class for performing conversions.
cz_checkbox_ctl Checkbox. Arg Options: desc, label, option_text
cz_color_palette_ctl Color palette. Arg Options: desc, label
cz_date_picker_ctl Date picker. Arg Options: desc, label
cz_detail_ctl Label and/or description. Arg Options: desc, label
cz_divider_1_ctl Divider. Arg Options: <none>
cz_divider_2_ctl Divider. Arg Options: <none>
cz_drop_categories_ctl Dropdown filled with posts. Arg Options: desc, label AND any of the arguments listed here: http://codex.wordpress.org/Function_Reference/get_categories
cz_drop_ctl Dropdown. Arg Options: choices, desc, label, none
cz_drop_image_sizes_ctl Dropdown filled with registered image sizes. Arg Options: desc, label
cz_drop_menu_items_ctl Dropdown filled with menu items. Arg Options: desc, label AND any of the arguments listed here: http://codex.wordpress.org/Function_Reference/wp_get_nav_menu_items
cz_drop_menus_ctl Dropdown filled with menus. Arg Options: desc, label AND any of the arguments listed here: http://codex.wordpress.org/Function_Reference/get_terms
cz_drop_pages_ctl Dropdown filled with pages. Arg Options: desc, label AND any of the arguments listed here: http://codex.wordpress.org/Function_Reference/get_pages
cz_drop_post_types_ctl Dropdown filled with post types. Arg Options: desc, label
cz_drop_posts_ctl Dropdown filled with posts. Arg Options: desc, label AND any of the arguments listed here: http://codex.wordpress.org/Template_Tags/get_posts
cz_drop_tags_ctl Dropdown filled with tags. Arg Options: desc, label AND any of the arguments listed here: http://codex.wordpress.org/Template_Tags/get_posts
cz_drop_taxonomies_ctl Dropdown filled with taxonomies. Arg Options: desc, label
cz_drop_terms_ctl Dropdown filled with taxonomy terms. Arg Options: desc, label, taxonomies AND any of the arguments listed here: http://codex.wordpress.org/Function_Reference/get_terms
cz_drop_users_ctl Dropdown filled with users. Arg Options: desc, label AND any of the arguments listed here: http://codex.wordpress.org/Function_Reference/get_users
cz_dummy_ctl Dummy control - contains no setting, just for display. Arg Options: <none>
cz_media_library_ctl Media library selector. This one is included because the image control that WP provides only allows users to upload a file from their local drive - they are not able to select an existing image already uploaded to their media library. Arg Options: desc, label
cz_number_bar_ctl Given a range of numbers and a step granularity, this control displays a slider bar (not a slideshow, but an actual bar with a thumb button) that lets the user choose a value between a given minimum and maximum. Arg Options: desc, display, label, max, min, step
cz_radio_image_align_x_ctl Radio images for horizontal alignment. Arg Options: desc, label Values: ml, mc, mr (l=left, c=center, r=right)
cz_radio_image_align_y_ctl Radio images for vertical alignment. Arg Options: desc, label Values: tc, mc, bc (t=top, m=middle, b=bottom)
cz_radio_image_alignment_ctl Radio images for alignment. Arg Options: desc, label Values: tl, tc, tr, ml, mc, mr, bl, bc, br (t=top, m=middle, b=bottom, l=left, c=center, r=right)
cz_radio_image_ctl Radio image. Arg Options: choices, desc, label
cz_radio_image_sidebar_layout_ctl Radio_images for sidebar layout. Arg Options: desc, label Values: 0, l1, l2, l1r1, r2, r1
cz_radio_image_site_span_layout_ctl Radio images for site span layout. Arg Options: desc, label Values: bleed-wide, bleed-narrow, boxed-narrow
cz_radio_text_ctl Radio text. Arg Options: choices, desc, label
cz_text_area_ctl Text area. Arg Options: desc, label, placeholder
cz_textbox_ctl Textbox. Arg Options: desc, label, placeholder
db The main database class where database interactions can be called.
db_recordset Wraps a mysqli_result and acts mostly as a pass-through to hide the underlying implementation should the recommended PHP method of database interaction change again - note: this class should really be used alongside 'select' queries, not 'update', 'delete', or 'insert'..
drop This class is responsible for offering various interfaces for drawing dropdown 'select' HTML elements.
mail A utility class for sending emails.
math A utility class related to math operations.
mb_checkbox_ctl Concrete class for a textbox that can be displayed inside of a metabox.
mb_ctl Acts as an abstract class for displaying and saving controls in metaboxes.
mb_date_picker_ctl Concrete class for a date picker that can be displayed inside of a metabox.
mb_detail_ctl Concrete class for a heading label and control description that can be displayed inside of a metabox.
mb_divider_ctl Concrete class for a horizontal divider.
mb_drop_ctl Concrete class for a dropdown that can be displayed inside of a metabox.
mb_media_library_ctl Concrete class for a media library selector that can be displayed inside of a metabox.
mb_number_bar_ctl Concrete class for a media library selector that can be displayed inside of a metabox.
mb_radio_image_ctl Concrete class for a set of radio image options that can be displayed inside of a metabox.
mb_radio_image_sidebar_layout_ctl Represents sidebar options: 0, l1, l2, l1r1, r2, r1
mb_radio_image_site_span_layout_ctl Represents span options: bleed-wide, bleed-narrow, boxed-narrow
mb_radio_text_ctl Concrete class for a set of radio options that can be displayed inside of a metabox.
mb_repeater_ctl Concrete class for repeating any of the other mb_ctl classes one under the other.
mb_text_area_ctl Concrete class for a textarea that can be displayed inside of a metabox.
mb_text_ctl Concrete class for plain text.
mb_text_notice_ctl Concrete class for stylized text.
mb_textbox_ctl Concrete class for a textbox that can be displayed inside of a metabox.
media The main WP database class where database interactions can be grouped together for consistency.
metabox Represents a single metabox.
path A utility class for performing operations on paths.
post A utility class for performing operations on or around WP posts.
question A utility class that queries WP.
sanitize This class performs sanitization on data input.
string A utility class for performing operations on strings.
textbox This class is responsible for offering various interfaces for drawing textbox 'input' HTML elements.

Traits summary

cz_supplement Defining a trait here means that we can continue to derive from the existing WP controls, but add in our additional attributes without changing the signature.

Functions summary

customize_register_section From your theme, hook into this function like so: if ( defined( 'WP_DEBUG' ) ) add_action( 'customize_register', 'ski\customize_register_section' );
cz_enqueue The ski-versions of the Customizer Controls largely rely on the corresponding JS and CSS for behavior, saving, and styling - include it once in here to save on retyping in most classes. Note that the last parameter to wp_enqueue_script forces the inclusion in the footer instead of the head for faster loading.
init A location to initialize any files/systems involved with this plugin.
metabox_sample From your theme, hook into this function like so: if ( defined( 'WP_DEBUG' ) ) add_action( 'admin_init', 'ski\metabox_sample' );
BluePrint-Q API documentation generated by ApiGen 2.8.0