Phone: '. $phone .'
': return $content . $new_html; } --- ### ````bbd_the_excerpt```` Use this filter to modify the post content for BBD archive views. Does not fire for non-BBD page views. Similar to `bbd_the_content`, except it fires for archive views instead of single post views. --- ### ````bbd_make_excerpt```` Unlike the `bbd_the_content` and `bbd_the_excerpt`, which are essentially wrappers for `the_content` and `the_excerpt` that fire only on the built-in WP single and archive views, the `bbd_make_excerpt` filter fires whenever the plugin is generating its own custom view (like search results from the search widget). You can use this filter to alter the excerpts shown for the posts in these cases. #### Parameters (string) $excerpt: The auto-generated excerpt #### Return (string) You must return the new excerpt that you wish to be displayed #### Examples # This example strips all HTML tags from the excerpt add_filter( 'bbd_make_excerpt', 'my_make_excerpt' ); function my_make_excerpt( $excerpt ) { return strip_tags( $excerpt ); } # This example gets rid of the excerpt altogether add_filter( 'bbd_make_excerpt', 'my_make_excerpt' ); function my_make_excerpt( $excerpt ) { return ''; } --- ### ````bbd_field_value```` Use this to filter values as they are retrieved by the plugin. Note that this filter applies to all fields, while the `bbd_field_value_{$field_name}` filter can be used for more specific targeting. Sequentially, this filter always fires before `bbd_field_value_{$field_name}`. #### Parameters (string) $value The field value before filtering (BBD_Field) $field The field object whose value we are getting (int) $post_id The post ID we are getting the value for #### Return (string) You must return the altered field value --- ### ````bbd_field_value_{$field_name}```` Use this to filter a field value before it is displayed on the front end. Use your own field name (meta key) in place of `{$field_name}`. Note that the filter fires whether or not the field has a value, as long as the field is selected for this view. #### Parameters (string) $value: The field value to be displayed (BBD_Field) $field: The field object that is being displayed (int) $post_id The post ID we are getting the value for #### Return (string) You must return the altered field value #### Example Below, we are filtering the value of a field called `email` and adding a mailto link. add_filter( 'bbd_field_value_email', 'my_email_value_filter' ); function my_email_value_filter( $value ){ $value = "" . $value . ""; return $value; } --- ### ````bbd_field_label_{$field_name}```` Use this filter to edit a filed's label and label wrap before it is displayed on the front end. Use your own field name (meta key) in place of `{$field_name}`. Note that the filter fires whether or not the field has a value, as long as the field is selected for this view. #### Parameters (array) $label { 'text' => (string) // The label text 'before' => (string) // HTML that comes before the label (Default: "") } (BBD_Field) $field: The field object that is being displayed #### Return (array) You must return the altered $label array #### Example Below, we are setting the `first_name` field's label text to "First" and the `last_name` field's label text to "Last" add_filter( 'bbd_field_label_first_name', 'my_first_name_label' ); function my_first_name_label( $label ) { $label['text'] = 'First'; return $label; } add_filter( 'bbd_field_label_last_name', 'my_last_name_label' ); function my_last_name_label( $label ) { $label['text'] = 'Last'; return $label; } --- ### ````bbd_search_widget_field_label_{$field_name}```` Use this to filter the label text for fields selected as search filters within the search widget #### Parameters (string) $label The label as it exists before filtering (BBD_Field) $field: The field object whose label is being filtered #### Return (string) You must return the altered $label string --- ### ````bbd_field_wrap_{$field_name}```` Similar to `bbd_field_label_{$field_name}`, except we are altering the entire wrapping element for a field. This can be particularly useful whenever two fields need to share the same parent wrapper, or when a particular class or id needs to be added to the HTML. #### Parameters (array) $wrap { 'before_tag' => 'div', 'after_tag' => 'div', 'classes' => (array), 'id' => (string), } (BBD_Field) $field: The field being displayed #### Return (array) You must return the $wrap array #### Example Below is a fairly involved example that uses the `bbd_field_wrap` filter along with `bbd_field_value` and `bbd_field_label` to do the following: * Append a space to the `first_name` field * Remove individual labels for the `first_name` and `last_name` fields * Remove the individual wrappers for the `first_name` and `last_name` fields and wrap them together in a single div First, append a space to the first name add_filter( 'bbd_field_value_first_name', 'my_first_name_value' ); function my_first_name_value( $value ) { return $value . ' '; } Then, empty out the labels for first and last name fields add_filter( 'bbd_field_label_first_name', 'my_name_label' ); add_filter( 'bbd_field_label_last_name', 'my_name_label' ); function my_name_label( $label ) { return array('before' => '', 'after' => '', 'text' => ''); } Finally, add a `` wrapper around the first and last name fields add_filter( 'bbd_field_wrap_first_name', 'my_name_wrap', 10, 2 ); add_filter( 'bbd_field_wrap_last_name', 'my_name_wrap', 10, 2 ); function my_name_wrap( $wrap, $field ) { // for the first name field if( 'first_name' == $field->key ) { $wrap['before_tag'] = 'p'; $wrap['after_tag'] = ''; $wrap['classes'][] = 'name-field'; $wrap['id'] = 'my-name-field'; } // for the last name field elseif( 'last_name' == $field->key ) { $wrap['before_tag'] = ''; $wrap['after_tag'] = 'p'; } return $wrap; } --- ### ````bbd_link_text```` Use to change the default "View Website" link text for auto detected URL fields (`web`, `website`, `url`, or matching `_website` or `_url`) #### Parameters (string) $text The link text currently set for display (default: "View Website") (BBD_Field) $field The field object currently being displayed #### Return (string) You must return the new link text for display #### Examples Below, we're changing the link text to 'Visit Webpage' add_filter( 'bbd_link_text', 'my_link_text' ); function my_link_text() { return 'Visit Webpage'; } For a more complex example, we can get the post currently being displayed and incorporate a custom field with the link text. In this example, for an author named John we would have the link text "View John's Website". Note that we are checking first that the post has a specific post type, `author`. We also check that the user has a value for the custom field `first_name`. add_filter( 'bbd_link_text', 'my_variable_link_text', 10, 2 ); function my_variable_link_text( $text, $field ) { # get the current post in the loop global $post; # make sure the post type is `author` if( 'author' != $post->post_type ) return $text; # get the user's first name if it exists if( $first_name = get_post_meta( $post->ID, 'first_name', true ) ) { # add first name to link text return "Visit {$first_name}'s Website"; } # otherwise, return a generic link text return 'Visit Website'; } --- ### ````bbd_pt_description_wrap```` This hook allows the customization of the containers for the post type descriptions that show on each post type archive page. The post type description can be created by using the post content area for any post type. Also, see the actions `bbd_before_pt_description` and `bbd_after_pt_description` which give more general control that may be needed for complex post type descriptions. We assume that the description should have the same HTML structure as a single loop item, in order to integrate best with the theme being used. Since the loop item HTML will be different for each theme, we take the approach of displaying a more-or-less unstyled description above the loop. This hook is then provided to allow the wrapper to be altered to match the theme. #### Parameters (array) $wrap { 'before_tag' => 'div', 'after_tag' => 'div', 'classes' => (array), 'id' => (string), } #### Return (array) You must return the altered $wrap array --- ### ````bbd_term_description_wrap```` This filter is similar to the `bbd_pt_description_wrap`, except it applies to term archive pages instead of post type archive pages. See above for examples, as it works just the same if you substitute `term` for `pt`. Unlike the descriptions for post type archives, term archive descriptions are something that many themes already utilize. For this reason, we do not place term descriptions on term archive pages by default. You must check the `Show term descriptions on term archive pages` checkbox when creating or editing your taxonomy on the backend. --- ### ````bbd_search_widget_query_args```` Alters the arguments for the WP_Query instance used to get the search results when using the Search Widget #### Parameters $query_args (array) The query args as processed by the plugin, based on form input $widget (BBD_Search_Widget) The instance of the search widget which was submitted #### Return (array) You must return the altered $query_args array --- ### ````bbd_search_widget_query```` Alters the query response object for search widget results, after getting posts #### Parameters $query (WP_Query) The WP_Query object for the search results $widget (BBD_Search_Widget) The instance of the search widget which was submitted #### Return (WP_Query) You must return the altered WP_Query object --- ## Actions ### ````bbd_pre_get_posts```` Use this action to alter the global `$wp_query` for BBD views. It's essentially the same as `pre_get_posts`, except BBD defaults are in place. Also, there is no need to check whether we're viewing a page for a BBD object or whether the query is the main query object, as this has been verified before the filter fires. Below are the default query arguments for a BBD view: * `order_by`: post_title * `order`: ASC #### Parameters $query: The same value passed by WP's `pre_get_posts` action, with the BBD defaults in place #### Example Below, we are using the `bbd_pre_get_posts` filter to order BBD posts by a field called `last_name` add_action( 'bbd_pre_get_posts', 'my_pre_get_posts' ); function my_pre_get_posts( $query ) { $query->query_vars['orderby'] = 'meta_value'; $query->query_vars['meta_key'] = 'last_name'; } --- ### ````bbd_wp```` Fires on the `wp` hook, but only for BBD views ### ````bbd_enqueue_scripts```` Fires on the `wp_enqueue_scripts` hook, but only for BBD views --- ### ````bbd_before_fields_wrap```` ### ````bbd_after_fields_wrap```` Use these to insert content before or after the fields wrap container. Note that the hooks fire on both archive pages and single pages. The following example adds content before the fields wrap container and illustrates how the global `$bbd_view` object can be used to differentiate between archive and single views add_action( 'bbd_before_fields_wrap', 'my_before_fields_wrap' ); function my_before_fields_wrap() { global $bbd_view; if( 'archive' == $bbd_view->view_type ) { // stuff to do on archive listings } elseif( 'single' == $bbd_view->view_type ) { // stuff to do on single listings } } --- ### ````bbd_pre_render_field_{$field_name}```` ### ````bbd_post_render_field_{$field_name}```` These actions allow users to insert their own HTML before (*pre*) or after (*post*) a field is rendered. Use your own field name (meta key) in place of `{$field_name}`. Note that the filter fires whether or not the field has a value, as long as the field is selected for this view. ### Parameters ````$field```` (BBD_Field) The field object being displayed ### Example Below is an example to wrap a field called `email` in a div. Note the example doesn't use the `$field` object, although it is available inside the function. add_action('bbd_pre_render_field_email', 'my_pre_email'); add_action('bbd_post_render_field_email', 'my_post_email'); function my_pre_email( $field ){ ?>
Located in: ' . implode( ', ', $term_links ) . '
'; } } --- ### ````bbd_field_type_details```` This action fires after the field type radio buttons for each field filter within the search widget. Use it to insert additional field types, and then use `bbd_search_widget_query_args` to edit the WP_Query as needed for the search results page #### Parameters $widget (BBD_Search_Wiget) An instance of the search widget object $field (BBD_Field) The field object that we are adding a type for --- ### ````bbd_after_search_widget_form```` Perform an action (like executing an inline JS function) after the search widget form is rendered. This helps with initializing parts of the widget after saving without doing a hard screen refresh --- ### CMB2 Actions Use these actions to alter the respective CMB2 meta box objects on the post type edit screen. ### ````bbd_cmb2_post_type_settings```` ### ````bbd_cmb2_advanced_post_type_settings```` ### ````bbd_cmb2_post_type_fields_select```` ### ````bbd_cmb2_post_type_advanced_fields_setup```` ### ````bbd_cmb2_taxonomy_settings```` ### ````bbd_cmb2_advanced_taxonomy_settings```` If adding a new field called `my_field` to a meta box, apply the `$prefix` parameter to the field's `id` value, and then access the field value via `$post_type->my_field`, where `$post_type` is a `new BBD_PT( $post_id )`. If the prefix is not applied, then `my_field` would be stored as a single post meta field for the post type being edited. You could then access this as usual via `get_post_meta( $post_id, 'my_field', true )`. #### Parameters (CMB2 object) $meta_box The CMB2 meta box object (depending on which of the above hooks is in use) (string) $prefix The prefix currently used by the meta box fields (most likely `_bbd_meta_`) #### Example In the example below, we're adding a field called `my_field` to the "Advanced Post Type Settings" meta box add_action( 'bbd_cmb2_advanced_post_type_settings', 'my_cmb2_advanced_post_type_settings', 10, 2 ); function my_cmb2_advanced_post_type_settings( $meta_box, $prefix ) { $meta_box->add_field( array( 'name' => 'My post type field', 'id' => $prefix . 'my_field', 'type' => 'select', 'options' => array( 'one' => 'One', 'two' => 'Two', 'three' => 'Three', ), 'default' => 'one', )); } --- ## Functions Here are some helper functions that you can call within your child theme ### ````is_bbd_view()```` Returns `true` if we are viewing a BBD object (single post, post archive, or term archive) and `false` otherwise. --- ### ````bbd_get_field_value( mixed, mixed )```` Returns an end-usable field value, applying the plugin's filters and handlers for ACF field types. The function inputs can be either a single string if we're currently in the loop (similar to [`get_field`](http://www.advancedcustomfields.com/resources/get_field)), or a post ID and string (similar to [`get_post_meta`](https://developer.wordpress.org/reference/functions/get_post_meta)). --- ### ````bbd_field( $post_id, $field_key )```` Renders HTML for a single field for the given post ID. Any custom hooks registered for the field wrap, label, or value will be executed. --- ### ````bbd_get_field_html( $post_id, $field_key )```` Returns an HTML string for a single field for the given post ID. Any custom hooks registered for the field wrap, label, or value will fire.