string, 'answer' => string ) rows, in display order. */ if ( ! defined( 'ABSPATH' ) ) { exit; } define( 'BW_FAQ_META_KEY', '_bw_post_faq' ); define( 'BW_FAQ_HEADING_META_KEY', '_bw_post_faq_heading' ); define( 'BW_FAQ_ACCORDION_META_KEY', '_bw_post_faq_accordion' ); define( 'BW_FAQ_SETTINGS_OPTION', 'bw_post_faq_settings' ); /** * Built-in default FAQ heading. Filterable so it stays translatable. * * @return string */ function bw_post_faq_default_heading() { return __( 'Frequently Asked Questions', 'wpex' ); } /** * Global FAQ settings (site-wide defaults), merged over the built-in defaults. * * @return array{heading:string,accordion:bool} */ function bw_post_faq_get_settings() { $option = get_option( BW_FAQ_SETTINGS_OPTION, array() ); if ( ! is_array( $option ) ) { $option = array(); } $heading = isset( $option['heading'] ) ? trim( (string) $option['heading'] ) : ''; return array( 'heading' => '' !== $heading ? $heading : bw_post_faq_default_heading(), // Accordion defaults ON when no global value has been saved yet. 'accordion' => isset( $option['accordion'] ) ? (bool) $option['accordion'] : true, ); } /** * Resolve the heading for a post: per-post override, else global default. */ function bw_post_faq_resolve_heading( $post_id ) { $per_post = get_post_meta( $post_id, BW_FAQ_HEADING_META_KEY, true ); if ( is_string( $per_post ) && '' !== trim( $per_post ) ) { return $per_post; } return bw_post_faq_get_settings()['heading']; } /** * Resolve the accordion mode for a post: per-post override ('on'/'off'), else * the global default. */ function bw_post_faq_resolve_accordion( $post_id ) { $per_post = get_post_meta( $post_id, BW_FAQ_ACCORDION_META_KEY, true ); if ( 'on' === $per_post ) { return true; } if ( 'off' === $per_post ) { return false; } return bw_post_faq_get_settings()['accordion']; } /* ------------------------------------------------------------------------- * Admin: global settings page (Settings > FAQ) * ---------------------------------------------------------------------- */ add_action( 'admin_menu', function() { add_options_page( __( 'FAQ Settings', 'wpex' ), __( 'FAQ', 'wpex' ), 'manage_options', 'bw-post-faq', 'bw_post_faq_settings_page' ); } ); add_action( 'admin_init', function() { register_setting( 'bw_post_faq', BW_FAQ_SETTINGS_OPTION, array( 'type' => 'array', 'sanitize_callback' => 'bw_post_faq_sanitize_settings', 'default' => array(), ) ); add_settings_section( 'bw_post_faq_main', '', '__return_false', 'bw-post-faq' ); add_settings_field( 'bw_post_faq_heading', __( 'Default FAQ heading', 'wpex' ), function() { $settings = bw_post_faq_get_settings(); printf( '', esc_attr( BW_FAQ_SETTINGS_OPTION ), esc_attr( $settings['heading'] ), esc_attr( bw_post_faq_default_heading() ) ); echo '

' . esc_html__( 'Shown above the questions on every post, unless overridden on an individual post.', 'wpex' ) . '

'; }, 'bw-post-faq', 'bw_post_faq_main' ); add_settings_field( 'bw_post_faq_accordion', __( 'Accordion style', 'wpex' ), function() { $settings = bw_post_faq_get_settings(); printf( '', esc_attr( BW_FAQ_SETTINGS_OPTION ), checked( $settings['accordion'], true, false ), esc_html__( 'Show answers in an accordion (click a question to open it; one answer open at a time).', 'wpex' ) ); echo '

' . esc_html__( 'When off, all answers are shown expanded. Can be overridden per post.', 'wpex' ) . '

'; }, 'bw-post-faq', 'bw_post_faq_main' ); } ); /** * Sanitize the global settings before save. */ function bw_post_faq_sanitize_settings( $input ) { $input = is_array( $input ) ? $input : array(); return array( 'heading' => isset( $input['heading'] ) ? sanitize_text_field( $input['heading'] ) : '', 'accordion' => ! empty( $input['accordion'] ) ? 1 : 0, ); } function bw_post_faq_settings_page() { ?>

*/ function bw_get_post_faq( $post_id ) { $items = get_post_meta( $post_id, BW_FAQ_META_KEY, true ); if ( ! is_array( $items ) ) { return array(); } $out = array(); foreach ( $items as $item ) { $question = isset( $item['question'] ) ? trim( $item['question'] ) : ''; $answer = isset( $item['answer'] ) ? trim( $item['answer'] ) : ''; if ( '' === $question || '' === wp_strip_all_tags( $answer ) ) { continue; } $out[] = array( 'question' => $question, 'answer' => $answer, ); } return $out; } /* ------------------------------------------------------------------------- * Admin: metabox * ---------------------------------------------------------------------- */ add_action( 'add_meta_boxes', function() { add_meta_box( 'bw_post_faq', __( 'FAQ', 'wpex' ), 'bw_post_faq_metabox', 'post', 'normal', 'default' ); } ); /** * Output a single editor row. Used both for saved rows and the JS template. */ function bw_post_faq_render_row( $question = '', $answer = '' ) { ?>
ID ); $global = bw_post_faq_get_settings(); $heading_meta = get_post_meta( $post->ID, BW_FAQ_HEADING_META_KEY, true ); $accordion_meta = get_post_meta( $post->ID, BW_FAQ_ACCORDION_META_KEY, true ); $accordion_label = $global['accordion'] ? __( 'On', 'wpex' ) : __( 'Off', 'wpex' ); ?>

post_type ) { return; } wp_enqueue_script( 'jquery-ui-sortable' ); $js = <<<'JS' jQuery(function($){ var $wrap = $('.bw-faq-wrap'); if ( ! $wrap.length ) { return; } var $rows = $wrap.find('.bw-faq-rows'); $rows.sortable({ handle: '.bw-faq-handle', placeholder: 'bw-faq-placeholder', forcePlaceholderSize: true, axis: 'y' }); $wrap.on('click', '.bw-faq-add', function(){ var tmpl = $('#tmpl-bw-faq-row').html(); $rows.append(tmpl); }); $wrap.on('click', '.bw-faq-remove', function(){ $(this).closest('.bw-faq-row').remove(); }); }); JS; wp_add_inline_script( 'jquery-ui-sortable', $js ); } ); /** * Persist the FAQ rows. Parallel question/answer arrays arrive in DOM order, so * dragging rows in the metabox is what determines the saved order. */ add_action( 'save_post_post', function( $post_id ) { if ( ! isset( $_POST['bw_post_faq_nonce'] ) || ! wp_verify_nonce( $_POST['bw_post_faq_nonce'], 'bw_post_faq_save' ) ) { return; } if ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) { return; } if ( ! current_user_can( 'edit_post', $post_id ) ) { return; } $questions = array(); $answers = array(); if ( isset( $_POST['bw_faq']['question'] ) && is_array( $_POST['bw_faq']['question'] ) ) { $questions = (array) $_POST['bw_faq']['question']; } if ( isset( $_POST['bw_faq']['answer'] ) && is_array( $_POST['bw_faq']['answer'] ) ) { $answers = (array) $_POST['bw_faq']['answer']; } $items = array(); foreach ( $questions as $i => $question ) { $question = sanitize_text_field( wp_unslash( $question ) ); $answer = isset( $answers[ $i ] ) ? wp_kses_post( wp_unslash( $answers[ $i ] ) ) : ''; if ( '' === trim( $question ) && '' === trim( wp_strip_all_tags( $answer ) ) ) { continue; } $items[] = array( 'question' => $question, 'answer' => $answer, ); } if ( $items ) { update_post_meta( $post_id, BW_FAQ_META_KEY, $items ); } else { delete_post_meta( $post_id, BW_FAQ_META_KEY ); } // Per-post heading override. $heading = isset( $_POST['bw_faq_heading'] ) ? sanitize_text_field( wp_unslash( $_POST['bw_faq_heading'] ) ) : ''; if ( '' !== $heading ) { update_post_meta( $post_id, BW_FAQ_HEADING_META_KEY, $heading ); } else { delete_post_meta( $post_id, BW_FAQ_HEADING_META_KEY ); } // Per-post accordion override ('on' / 'off' / inherit). $accordion = isset( $_POST['bw_faq_accordion'] ) ? wp_unslash( $_POST['bw_faq_accordion'] ) : ''; if ( in_array( $accordion, array( 'on', 'off' ), true ) ) { update_post_meta( $post_id, BW_FAQ_ACCORDION_META_KEY, $accordion ); } else { delete_post_meta( $post_id, BW_FAQ_ACCORDION_META_KEY ); } } ); /* ------------------------------------------------------------------------- * Front-end: render below the author box + FAQPage schema * ---------------------------------------------------------------------- */ /** * Insert the FAQ render callback immediately after the author box block in the * Total theme's single-post layout. Any block name that is a callable function * is invoked by the layout loop, so we register our function name as a block. */ add_filter( 'wpex_blog_single_layout_blocks', function( $blocks ) { if ( ! is_array( $blocks ) ) { return $blocks; } $rebuilt = array(); foreach ( $blocks as $key => $value ) { $rebuilt[ $key ] = $value; if ( 'author_bio' === $key ) { $rebuilt['bw_render_post_faq'] = 'bw_render_post_faq'; } } // Fallback: if there is no author box block, place the FAQ before related // posts, otherwise append it to the end. if ( ! isset( $rebuilt['bw_render_post_faq'] ) ) { $with_faq = array(); foreach ( $rebuilt as $key => $value ) { if ( 'related_posts' === $key ) { $with_faq['bw_render_post_faq'] = 'bw_render_post_faq'; } $with_faq[ $key ] = $value; } if ( ! isset( $with_faq['bw_render_post_faq'] ) ) { $with_faq['bw_render_post_faq'] = 'bw_render_post_faq'; } $rebuilt = $with_faq; } return $rebuilt; }, 20 ); /** * This site renders single posts through a WPBakery custom template * (`post_singular_template_content` theme mod) whose `[vcex_post_content]` * shortcode outputs the post body followed by the author box. That bypasses the * block layout above, so we also append the FAQ to that shortcode's output — * placing it directly after the author box, before the related-posts grid. */ add_filter( 'do_shortcode_tag', function( $output, $tag ) { if ( 'vcex_post_content' !== $tag ) { return $output; } return $output . bw_get_post_faq_html(); }, 10, 2 ); /** * Echo the FAQ markup. Used by the block-layout fallback. */ function bw_render_post_faq() { echo bw_get_post_faq_html(); } /** * Build the FAQ section markup and its FAQPage JSON-LD. Returns an empty string * when not on a single post or when the post has no FAQ rows. * * @return string */ function bw_get_post_faq_html() { if ( ! is_singular( 'post' ) ) { return ''; } $post_id = get_the_ID(); $items = bw_get_post_faq( $post_id ); if ( empty( $items ) ) { return ''; } $heading = bw_post_faq_resolve_heading( $post_id ); $accordion = bw_post_faq_resolve_accordion( $post_id ); $schema = array( '@context' => 'https://schema.org', '@type' => 'FAQPage', 'mainEntity' => array(), ); $section_class = 'bw-post-faq' . ( $accordion ? ' bw-post-faq--accordion' : '' ); $html = '
'; $html .= bw_post_faq_styles(); // Match the theme's "Related Posts" / share headings (vcex_heading, h3). $html .= '

' . esc_html( $heading ) . '

'; $html .= '
'; $i = 0; foreach ( $items as $item ) { $answer_html = wpautop( wp_kses_post( $item['answer'] ) ); $html .= '
'; if ( $accordion ) { $panel_id = 'bw-faq-a-' . $post_id . '-' . $i; $html .= '

'; $html .= '

'; $html .= ''; } else { $html .= '

' . esc_html( $item['question'] ) . '

'; $html .= '
' . $answer_html . '
'; } $html .= '
'; $schema['mainEntity'][] = array( '@type' => 'Question', 'name' => wp_strip_all_tags( $item['question'] ), 'acceptedAnswer' => array( '@type' => 'Answer', 'text' => trim( wp_kses_post( $item['answer'] ) ), ), ); $i++; } $html .= '
'; $html .= ''; if ( $accordion ) { $html .= bw_post_faq_accordion_script(); } $html .= '
'; return $html; } /** * Front-end FAQ styles (printed inline with the section). */ function bw_post_faq_styles() { return ''; } /** * Accordion behaviour: open one answer at a time. Vanilla JS, no dependency. */ function bw_post_faq_accordion_script() { $js = <<<'JS' (function(){ var sections = document.querySelectorAll('.bw-post-faq--accordion'); Array.prototype.forEach.call(sections, function(section){ if (section.dataset.bwFaqReady) { return; } section.dataset.bwFaqReady = '1'; var toggles = section.querySelectorAll('.bw-faq-toggle'); Array.prototype.forEach.call(toggles, function(btn){ btn.addEventListener('click', function(){ var isOpen = btn.getAttribute('aria-expanded') === 'true'; Array.prototype.forEach.call(toggles, function(other){ other.setAttribute('aria-expanded', 'false'); var p = document.getElementById(other.getAttribute('aria-controls')); if (p) { p.hidden = true; } }); if (!isOpen) { btn.setAttribute('aria-expanded', 'true'); var panel = document.getElementById(btn.getAttribute('aria-controls')); if (panel) { panel.hidden = false; } } }); }); }); })(); JS; return ''; }