| 1 |
<?php |
| 2 |
namespace WPDeveloper\BetterDocs\Shortcodes; |
| 3 |
|
| 4 |
if ( ! defined( 'ABSPATH' ) ) { |
| 5 |
exit; |
| 6 |
} |
| 7 |
|
| 8 |
|
| 9 |
use WPDeveloper\BetterDocs\Core\Shortcode; |
| 10 |
use WPDeveloper\BetterDocs\Utils\Helper; |
| 11 |
|
| 12 |
class FaqList extends Shortcode { |
| 13 |
protected $layout = 'modern'; |
| 14 |
protected $icon_hook = 'betterdocs_faq_post_after'; |
| 15 |
|
| 16 |
public $icon_position = 'after'; |
| 17 |
|
| 18 |
public function get_name() { |
| 19 |
return 'betterdocs_faq_list_modern'; |
| 20 |
} |
| 21 |
|
| 22 |
public function get_style_depends() { |
| 23 |
return [ 'betterdocs-faq' ]; |
| 24 |
} |
| 25 |
|
| 26 |
public function get_script_depends() { |
| 27 |
return [ 'betterdocs-faq' ]; |
| 28 |
} |
| 29 |
|
| 30 |
protected $map_view_vars = [ |
| 31 |
'class' => 'faq_heading_class' |
| 32 |
]; |
| 33 |
|
| 34 |
/** |
| 35 |
* Summary of default_attributes |
| 36 |
* @return array |
| 37 |
*/ |
| 38 |
public function default_attributes() { |
| 39 |
return [ |
| 40 |
'groups' => '', |
| 41 |
'class' => '', |
| 42 |
'group_exclude' => '', |
| 43 |
'faq_heading' => __( 'Frequently Asked Questions', 'betterdocs' ), |
| 44 |
'faq_section_title_tag' => 'h2', |
| 45 |
'faq_group_title_tag' => 'h3', |
| 46 |
'faq_schema' => false, |
| 47 |
'faq_layout' => 'layout-1', |
| 48 |
'faq_section_title_color' => null, |
| 49 |
'include_faq_group' => '', |
| 50 |
'exclude_faq_group' => '', |
| 51 |
'faq_group_title_color' => null, |
| 52 |
'faq_group_title_hover_color' => null, |
| 53 |
'faq_list_color' => null, |
| 54 |
'faq_content_color' => null, |
| 55 |
'faq_icon_color' => null, |
| 56 |
'faq_group_title_typography' => null, |
| 57 |
'faq_per_page' => 9, |
| 58 |
'show_button_icon' => true, |
| 59 |
'button_icon_position' => 'after', |
| 60 |
'button_color' => '#528ffe', |
| 61 |
'is_gutenberg' => false, |
| 62 |
'faq_taxonomy' => 'betterdocs_faq_category', |
| 63 |
// Per-placement order override. Empty = use the global FAQ Builder |
| 64 |
// order (`betterdocs_faq_order` option). One of: default, |
| 65 |
// most_recent, least_recent, a_to_z, z_to_a, most_questions. |
| 66 |
'order' => '' |
| 67 |
]; |
| 68 |
} |
| 69 |
|
| 70 |
/** |
| 71 |
* Allowed per-placement order keys, mirroring the FAQ Builder header dropdown. |
| 72 |
* |
| 73 |
* @var string[] |
| 74 |
*/ |
| 75 |
protected $allowed_order_keys = [ 'default', 'most_recent', 'least_recent', 'a_to_z', 'z_to_a', 'most_questions' ]; |
| 76 |
|
| 77 |
public function icons( $faq_toggle ) { |
| 78 |
$faq_markup = '<svg class="betterdocs-faq-iconminus" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"' .($faq_toggle ? " style='display:inline;'" : ""). 'stroke-width="2"><g fill="none" stroke="' . esc_attr( $this->attributes['button_color'] ) . '" stroke-linecap="round" stroke-miterlimit="10" stroke-linejoin="round"><path d="M17 12H7"></path><circle cx="12" cy="12" r="11"></circle></g></svg>'; |
| 79 |
$faq_markup .= '<svg class="betterdocs-faq-iconplus" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"'.($faq_toggle ? " style='display:none;'" : "").'><g stroke-width="2" fill="none" stroke="' . esc_attr( $this->attributes['button_color'] ) . '" stroke-linecap="square" stroke-miterlimit="10"><path d="M12 7v10M17 12H7"></path><circle cx="12" cy="12" r="11"></circle></g></svg>'; |
| 80 |
|
| 81 |
echo $faq_markup; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped |
| 82 |
} |
| 83 |
|
| 84 |
public function render( $atts, $content = null ) { |
| 85 |
|
| 86 |
$this->icon_position = isset( $this->atts['button_icon_position'] ) ? $this->atts['button_icon_position'] : ''; |
| 87 |
|
| 88 |
if ( $this->attributes['is_gutenberg'] && $this->attributes['button_icon_position'] == 'before' && $this->attributes['show_button_icon'] ) { |
| 89 |
add_action( 'betterdocs_faq_post_before', [ $this, 'icons' ] ); |
| 90 |
} elseif ( $this->attributes['is_gutenberg'] && $this->attributes['button_icon_position'] == 'after' && $this->attributes['show_button_icon'] ) { |
| 91 |
add_action( 'betterdocs_faq_post_after', [ $this, 'icons' ] ); |
| 92 |
} else { |
| 93 |
add_action( $this->icon_hook, [ $this, 'icons' ] ); |
| 94 |
} |
| 95 |
|
| 96 |
// When this placement sets a valid `order`, scope it to this render only |
| 97 |
// (via the existing `betterdocs_faq_order_key` filter) so it overrides |
| 98 |
// the global FAQ Builder order without affecting other placements. |
| 99 |
$order_override = is_string( $this->attributes['order'] ) ? trim( $this->attributes['order'] ) : ''; |
| 100 |
$order_filter = null; |
| 101 |
if ( $order_override && in_array( $order_override, $this->allowed_order_keys, true ) ) { |
| 102 |
$order_filter = function () use ( $order_override ) { |
| 103 |
return $order_override; |
| 104 |
}; |
| 105 |
add_filter( 'betterdocs_faq_order_key', $order_filter, 20 ); |
| 106 |
} |
| 107 |
|
| 108 |
$this->views( 'shortcodes/faq' ); |
| 109 |
|
| 110 |
if ( $order_filter ) { |
| 111 |
remove_filter( 'betterdocs_faq_order_key', $order_filter, 20 ); |
| 112 |
} |
| 113 |
|
| 114 |
remove_action( $this->icon_hook, [ $this, 'icons' ] ); |
| 115 |
} |
| 116 |
|
| 117 |
public function view_params() { |
| 118 |
$taxonomy = sanitize_key( $this->attributes['faq_taxonomy'] ); |
| 119 |
$terms_query = $this->query->faq_terms_query_args( $this->attributes['groups'], $this->attributes['group_exclude'], [], $taxonomy ); |
| 120 |
|
| 121 |
$wrapper_attr = [ |
| 122 |
'class' => [ |
| 123 |
'betterdocs-faq-wrapper', |
| 124 |
'layout-' . $this->layout, |
| 125 |
'icon-' . $this->attributes['button_icon_position'], |
| 126 |
$this->attributes['class'] |
| 127 |
] |
| 128 |
]; |
| 129 |
|
| 130 |
return wp_parse_args( |
| 131 |
[ |
| 132 |
'wrapper_attr' => $wrapper_attr, |
| 133 |
'widget' => $this, |
| 134 |
'layout' => 'list', |
| 135 |
'terms_query_args' => $terms_query, |
| 136 |
'faq_schema' => $this->attributes['faq_schema'] && ! Helper::seo_plugin_outputs_faq_schema() |
| 137 |
] |
| 138 |
); |
| 139 |
} |
| 140 |
} |
| 141 |
|
