| Current File : /var/www/pediatribu/wp-content/plugins/wpforms-lite/src/Forms/Fields/Traits/ContentInput.php |
<?php
namespace WPForms\Forms\Fields\Traits;
use WP_Post;
/**
* Trait ContentInput.
*
* @since 1.9.4
*/
trait ContentInput {
/**
* Translatable strings.
*
* @since 1.9.4
*
* @var null|array Translatable strings.
*/
private static $translatable_strings;
/**
* Constructor overloader to register trait-specific hooks.
*
* @since 1.9.4
*
* @param bool $init Pass false to allow shortcutting the whole initialization, if needed.
*/
public function __construct( $init = true ) {
if ( ! $init ) {
return;
}
$this->content_input_hooks();
parent::__construct( $init );
}
/**
* Register hooks.
*
* @since 1.9.4
*/
private function content_input_hooks(): void {
add_action( 'wpforms_builder_enqueues', [ $this, 'builder_enqueues' ] );
add_action( 'wpforms_builder_print_footer_scripts', [ $this, 'content_editor_tools_template' ] );
add_filter( 'wpforms_builder_field_option_class', [ $this, 'builder_field_option_class' ], 10, 2 );
add_filter( 'wpforms_builder_strings', [ $this, 'content_builder_strings' ], 10, 2 );
add_filter( 'editor_stylesheets', [ $this, 'editor_stylesheets' ] );
add_filter( 'media_view_strings', [ $this, 'edit_media_view_strings' ], 10, 2 );
add_filter( 'teeny_mce_buttons', [ $this, 'teeny_mce_buttons' ], 10, 2 );
}
/**
* Content field option.
*
* @since 1.9.4
*
* @param array $field Field data and settings.
*/
private function field_option_content( array $field ): void {
$value = ( isset( $field['content'] ) && ! wpforms_is_empty_string( $field['content'] ) ) ? wp_kses( $field['content'], $this->get_allowed_html_tags() ) : '';
$output = $this->field_element(
'row',
$field,
[
'slug' => 'content',
'content' => $this->get_content_editor( $value, $field ),
],
false
);
$output .= wpforms_render(
'fields/content/action-buttons',
[
'id' => $field['id'],
'preview' => $this->get_input_string( 'preview' ),
'expand' => $this->get_input_string( 'expand' ),
],
true
);
printf( '<div class="wpforms-expandable-editor">%s</div><div class="wpforms-expandable-editor-clear"></div>', $output ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
/**
* Add class name to the field option top element.
*
* @since 1.9.4
*
* @param string|mixed $css_class CSS classes.
* @param array $field Field data.
*
* @return string
*/
public function builder_field_option_class( $css_class, $field ): string {
$css_class = (string) $css_class;
return $this->type === $field['type'] ? $css_class . ' wpforms-field-has-tinymce' : $css_class;
}
/**
* Localized strings for `content-field` JS script.
*
* @since 1.9.4
*
* @param array|mixed $strings Localized strings.
* @param array $form The form element.
*
* @return array
* @noinspection PhpUnusedParameterInspection
*/
public function content_builder_strings( $strings, $form ): array { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed
$strings = (array) $strings;
$strings['content_field'] = [
'collapse' => wp_strip_all_tags( $this->get_input_string( 'collapse' ) ),
'expand' => wp_strip_all_tags( $this->get_input_string( 'expand' ) ),
'editor_default_value' => wp_kses( $this->get_input_string( 'editor_default_value' ), $this->get_allowed_html_tags() ),
'content_editor_plugins' => $this->content_editor_plugins(),
'content_editor_toolbar' => $this->content_editor_toolbar(),
'content_editor_css_url' => $this->content_css_url(),
'editor_height' => $this->get_editor_height(),
'allowed_html' => array_keys( $this->get_allowed_html_tags() ),
'invalid_elements' => $this->get_invalid_elements(),
'quicktags_buttons' => $this->get_quicktags_buttons(),
'body_class' => $this->get_editor_body_class(),
];
return $this->add_supported_field_type( $strings, $this->type );
}
/**
* Add editor stylesheet.
*
* @since 1.9.4
*
* @param array|mixed $stylesheets Editor stylesheets.
*
* @return array
*/
public function editor_stylesheets( $stylesheets ): array {
$stylesheets = (array) $stylesheets;
if ( wpforms_is_admin_page( 'builder' ) ) {
$stylesheets[] = $this->content_css_url();
}
return $stylesheets;
}
/**
* Edit some media view strings to reference a form instead of a page/post.
*
* @since 1.9.4
*
* @param array|mixed $strings List of media view strings.
* @param WP_Post $post Post object.
*
* @return array Modified media view strings.
* @noinspection SqlResolve
* @noinspection PhpMissingParamTypeInspection
* @noinspection PhpUnusedParameterInspection
*/
public function edit_media_view_strings( $strings, $post ): array { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed
$strings = (array) $strings;
if ( wpforms_is_admin_page( 'builder' ) ) {
$strings['insertIntoPost'] = esc_html__( /** @lang text */ 'Insert into form', 'wpforms-lite' );
$strings['uploadedToThisPost'] = esc_html__( 'Uploaded to this form', 'wpforms-lite' );
}
return $strings;
}
/**
* Remove fullscreen button if this is other tinymce editor instance than content field editor.
*
* @since 1.9.4
*
* @param array|mixed $buttons Array of editor buttons.
* @param string $editor_id Editor textarea ID.
*
* @return array
*/
public function teeny_mce_buttons( $buttons, $editor_id ): array {
$buttons = (array) $buttons;
$is_other_editor = strpos( $editor_id, 'wpforms_panel_' ) === 0 || $editor_id === 'entry_note';
$key = array_search( 'fullscreen', $buttons, true );
if ( $is_other_editor && $key !== false ) {
unset( $buttons[ $key ] );
}
return $buttons;
}
/**
* Get default content editor plugins.
*
* @since 1.9.4
*
* @return array Plugins array.
*/
private function content_editor_plugins(): array {
$plugins = [
'charmap',
'colorpicker',
'hr',
'link',
'image',
'lists',
'paste',
'tabfocus',
'textcolor',
'wordpress',
'wpemoji',
'wptextpattern',
'wpeditimage',
];
/**
* Get content editor plugins filter.
*
* @since 1.7.8
*
* @param array $plugins Plugins array.
*/
return (array) apply_filters( 'wpforms_builder_content_input_get_content_editor_plugins', $plugins );
}
/**
* Get default content editor toolbar.
*
* @since 1.9.4
*
* @return array Toolbar buttons array.
*/
private function content_editor_toolbar(): array {
$toolbar = [
'formatselect',
'bold',
'italic',
'underline',
'strikethrough',
'forecolor',
'link',
'bullist',
'numlist',
'blockquote',
'alignleft',
'aligncenter',
'alignright',
];
/**
* Get content editor toolbar buttons filter.
*
* @since 1.7.8
*
* @param array $toolbar Toolbar buttons array.
*/
return (array) apply_filters( 'wpforms_builder_content_input_get_content_editor_toolbar', $toolbar );
}
/**
* Enqueue wpforms-content-field script.
*
* @since 1.9.4
*
* @param string $view Current view.
*
* @noinspection PhpUnusedParameterInspection
*/
public function builder_enqueues( $view ): void { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.Found
// Enqueue editor styles explicitly. Hack for broken styles when the Content field is deleted and Settings > Confirmation editor get broken.
// phpcs:ignore WordPress.WP.EnqueuedResourceParameters.MissingVersion
wp_enqueue_style(
'wpforms-editor-styles',
includes_url( 'css/editor.css' )
);
}
/**
* Content editor tools template.
*
* @since 1.9.4
*/
public function content_editor_tools_template(): void {
?>
<script type="text/html" id="tmpl-wpforms-content-editor-tools">
<div id="wp-wpforms-field-{{data.optionId}}-content-editor-tools" class="wp-editor-tools hide-if-no-js">
<div id="wp-wpforms-field-{{data.optionId}}-content-media-buttons" class="wp-media-buttons">
<button type="button" id="insert-media-button" class="button insert-media add_media" data-editor="wpforms-field-{{data.optionId}}-content">
<span class="wp-media-buttons-icon"></span>
<?php esc_html_e( 'Add Media', 'wpforms-lite' ); ?>
</button>
</div>
<div class="wp-editor-tabs">
<button type="button" id="wpforms-field-{{data.optionId}}-content-tmce" class="wp-switch-editor switch-tmce" data-wp-editor-id="wpforms-field-{{data.optionId}}-content">
<?php esc_html_e( 'Visual', 'wpforms-lite' ); ?>
</button>
<button type="button" id="wpforms-field-{{data.optionId}}-content-html" class="wp-switch-editor switch-html" data-wp-editor-id="wpforms-field-{{data.optionId}}-content">
<?php esc_html_e( 'Text', 'wpforms-lite' ); ?>
</button>
</div>
</div>
</script>
<?php
}
/**
* Register types in JS localization to use in WPFormsContentField.
*
* @since 1.9.4
*
* @param array $strings Localized strings.
* @param string $type Field type.
*
* @return array
*/
private function add_supported_field_type( $strings, $type ): array {
$other_supported_field_types = $strings['content_input']['supported_field_types'] ?? [];
$strings['content_input'] = [
'supported_field_types' => array_merge( $other_supported_field_types, [ $type ] ),
];
return $strings;
}
/**
* Get translatable string.
*
* @since 1.9.4
*
* @param string $key String key.
*
* @return string
*/
private function get_input_string( $key ): string {
if ( ! self::$translatable_strings ) {
self::$translatable_strings = [
'editor_default_value' => __( '<h4>Add Text and Images to Your Form With Ease</h4> <p>To get started, replace this text with your own.</p>', 'wpforms-lite' ),
'expand' => __( 'Expand Editor', 'wpforms-lite' ),
'collapse' => __( 'Collapse Editor', 'wpforms-lite' ),
'preview' => __( 'Update Preview', 'wpforms-lite' ),
];
}
return self::$translatable_strings[ $key ] ?? '';
}
/**
* Show field preview in the right builder panel.
*
* @since 1.9.4
*
* @param array $field Field data.
*/
private function content_input_preview( $field ): void {
$content = $field['content'] ?? $this->get_input_string( 'editor_default_value' );
?>
<div class="wpforms-field-content-preview">
<?php echo wp_kses( $this->do_caption_shortcode( wpautop( $content ) ), $this->get_allowed_html_tags() ); ?>
<div class="wpforms-field-content-preview-end"></div>
</div>
<?php
}
/**
* Check if shortcode is [caption] and if not, return processed content string.
*
* @since 1.9.4
*
* @param false|string $value Short-circuit return value. Either false or the value to replace the shortcode with.
* @param string $tag Shortcode name.
* @param array|string $attr Shortcode attributes array or empty string.
* @param array $m Regular expression match array.
*
* @return false|string
* @noinspection PhpUnusedParameterInspection
* @noinspection PhpMissingParamTypeInspection
*/
public function short_circuit_shortcodes( $value, $tag, $attr, $m ) {
return $tag !== 'caption' ? $m[0] : false;
}
/**
* Check if shortcode is [caption] and if not, short-circuit processing the shortcode.
*
* @since 1.9.4
*
* @param string $content Editor content.
*
* @return string
*/
protected function do_caption_shortcode( $content ): string {
/**
* Check if user allowed executing all shortcodes on content field value.
*
* @since 1.7.8
*
* @param bool $bool Boolean if shortcodes should be executed.
*/
if ( apply_filters( 'wpforms_content_input_value_do_shortcode', false ) && ! wpforms_is_admin_page( 'builder' ) ) {
return do_shortcode( $content );
}
add_filter( 'pre_do_shortcode_tag', [ $this, 'short_circuit_shortcodes' ], 10, 4 );
$content = do_shortcode( $content );
remove_filter( 'pre_do_shortcode_tag', [ $this, 'short_circuit_shortcodes' ] );
return $content;
}
/**
* Get TinyMCE editor for content field.
*
* @since 1.9.4
*
* @param string $value Field value.
* @param array $field Field data.
*
* @return string
*/
private function get_content_editor( $value, $field ): string {
/*
Heads up, if you are going to edit editor settings, bear in mind editor is instantiated in two places:
- PHP instance in \WPForms\Admin\Builder\Traits\ContentInput::get_content_editor
- JS instance in WPForms.Admin.Builder.ContentField.initTinyMCE
*/
$settings = [
'media_buttons' => true,
'drag_drop_upload' => true,
'textarea_name' => "fields[{$field['id']}][content]",
'editor_height' => $this->get_editor_height(),
'editor_class' => ! empty( $field['required'] ) ? 'wpforms-field-required' : '',
'tinymce' => [
'init_instance_callback' => $this->is_disabled_field ? '' : 'wpformsContentFieldTinyMCECallback',
'plugins' => implode( ',', $this->content_editor_plugins() ),
'toolbar1' => implode( ',', $this->content_editor_toolbar() ),
'invalid_elements' => $this->get_invalid_elements(),
'relative_urls' => false,
'remove_script_host' => false,
'object_resizing' => false,
'body_class' => $this->get_editor_body_class(),
],
'quicktags' => [
'buttons' => $this->get_quicktags_buttons(),
],
];
ob_start();
wp_editor( $value, 'wpforms-field-option-' . $field['id'] . '-content', $settings );
return ob_get_clean();
}
/**
* Get invalid HTML in content editor.
*
* @since 1.9.4
*
* @return string Invalid HTML elements.
*/
private function get_invalid_elements(): string {
return 'form,input,textarea,select,option,script,embed,iframe';
}
/**
* Get the list of the `quicktags` buttons.
*
* @since 1.9.4
*
* @return string Quicktags buttons.
*/
private function get_quicktags_buttons(): string {
$quicktag_buttons = [
'strong',
'em',
'block',
'del',
'ins',
'img',
'ul',
'ol',
'li',
'code',
'link',
'close',
];
/**
* Get the list of the `quicktags` buttons filter.
*
* @since 1.7.8
*
* @param string $quicktags_buttons Comma separated list of quicktags buttons.
*/
return implode( ',', apply_filters( 'wpforms_builder_content_input_get_quicktags_buttons', $quicktag_buttons ) );
}
/**
* Get content CSS url.
*
* @since 1.9.4
*
* @return string
*/
private function content_css_url(): string {
$min = wpforms_get_min_suffix();
return WPFORMS_PLUGIN_URL . "assets/css/builder/content-editor{$min}.css";
}
/**
* Get content editor height.
*
* @since 1.9.4
*
* @retun int Editor textarea height.
*/
private function get_editor_height(): int {
/**
* Get content editor height filter.
*
* @since 1.7.8
*
* @param int $height Editor textarea height.
*/
return (int) apply_filters( 'wpforms_builder_content_input_get_editor_height', 204 );
}
/**
* Get allowed HTML tags for Content Input Field.
*
* @since 1.9.4
*
* @return array
*/
protected function get_allowed_html_tags(): array {
/**
* Filter allowed HTML tags in the content field input.
*
* @since 1.7.8
*
* @param array $allowed_tags Allowed tags.
*/
return (array) apply_filters( 'wpforms_builder_content_input_get_allowed_html_tags', wpforms_get_allowed_html_tags_for_richtext_field() );
}
/**
* Get editor body class.
*
* @since 1.9.4
*
* @return string
*/
private function get_editor_body_class(): string {
return 'wpforms-content-field-editor-body';
}
}