'emailoctopus',
'title' => esc_html__('EmailOctopus', 'emailoctopus'),
];
return $categories;
}
/**
* Registers and enqueues Block Editor script.
*/
public function register_form_editor_scripts(): void
{
$block_asset = $this->get_block_asset();
wp_register_style('emailoctopus-form', Utils::get_plugin_url('public/build/block.css'), [], $block_asset['version']);
wp_register_script(
'emailoctopus-form',
Utils::get_plugin_url('public/build/block.js'),
$block_asset['dependencies'],
$block_asset['version'],
true
);
}
/**
* Localizes Block Editor script data when the block editor is loading.
*/
public function localize_form_editor_scripts(): void
{
if (!$this->is_block_editor_screen()) {
return;
}
$api_key = get_option('emailoctopus_api_key', false);
$api_key_valid = Utils::is_valid_api_key($api_key);
$forms = $this::get_forms();
$api_connection_required = wp_sprintf(
/* translators: %1$s - create account button, %2$s - connect account button */
'%s
%s
%s
',
esc_html__('To use this block, create an EmailOctopus account or connect an existing one.', 'emailoctopus'),
wp_sprintf(
'%s',
esc_html__('Create an account for free', 'emailoctopus')
),
wp_sprintf(
'%s',
esc_html__('Connect an existing account', 'emailoctopus')
)
);
$no_forms = wp_sprintf(
/* translators: %s - create form link */
esc_html__('No forms yet. %s.', 'emailoctopus'),
'' . esc_html__('Create one', 'emailoctopus') . '',
);
$block_data = [
'forms' => $forms,
'is_connected' => $api_key_valid,
'labels' => [
'untitled' => esc_html__('Untitled', 'emailoctopus'),
'tab_label' => esc_html__('General', 'emailoctopus'),
'select_label' => esc_html__('Form', 'emailoctopus'),
'api_connection_required' => $api_connection_required,
'add_form' => esc_html__('Select a form using the sidebar.', 'emailoctopus'),
/* translators: %1$s - form name, %2$s - form type */
'preview_form_selection' => esc_html__('%1$s (%2$s)', 'emailoctopus'),
'preview_form_view' => esc_html__('Click preview or publish to view.', 'emailoctopus'),
/* translators: %s - form_id */
'error_form_not_found' => esc_html__('Error: could not load form %s from the API.', 'emailoctopus'),
'no_forms' => $no_forms,
'display_settings' => esc_html__('Display settings', 'emailoctopus'),
'view_on' => esc_html__('View on EmailOctopus', 'emailoctopus'),
],
'form_url_base' => admin_url('admin.php?page=emailoctopus-form'),
];
wp_localize_script('emailoctopus-form', 'emailoctopus_form', $block_data);
}
/**
* Returns generated script asset metadata for the main block script.
*/
private function get_block_asset(): array
{
$asset_file = dirname(__DIR__) . '/public/build/block.asset.php';
if (is_readable($asset_file)) {
$asset = require $asset_file;
if (is_array($asset)) {
return [
'dependencies' => isset($asset['dependencies']) && is_array($asset['dependencies']) ? $asset['dependencies'] : [],
'version' => isset($asset['version']) && is_string($asset['version']) ? $asset['version'] : EMAILOCTOPUS_VERSION,
];
}
}
return [
'dependencies' => ['wp-blocks', 'wp-element'],
'version' => EMAILOCTOPUS_VERSION,
];
}
/**
* Confirms the current admin context is a block editor screen.
*/
private function is_block_editor_screen(): bool
{
if (!function_exists('get_current_screen')) {
return false;
}
$screen = get_current_screen();
if (!$screen || !method_exists($screen, 'is_block_editor') || !$screen->is_block_editor()) {
return false;
}
$supported_screen_ids = [
'site-editor',
'post',
'page',
'widgets',
];
return in_array($screen->id, $supported_screen_ids, true)
|| 'post' === $screen->base
|| 'site-editor' === $screen->base;
}
/**
* Registers Form Block with PHP.
*/
public function register_form_block(): void
{
if (function_exists('register_block_type')) {
register_block_type(
EMAILOCTOPUS_DIR . 'src/json/block.json',
[
'render_callback' => [$this, 'form_render_callback'],
]
);
}
}
/**
* Renders the subscription form on front-end using the corresponding shortcode.
*
* @param array $attributes Block attributes.
*
* @return string HTML.
*/
public function form_render_callback($attributes): string
{
$form_id = '';
if (isset($attributes['form_id'])) {
$form_id = (string) $attributes['form_id'];
}
if ('' !== $form_id && !$this->is_valid_form_id($form_id)) {
return '';
}
return do_shortcode('[emailoctopus form_id="' . esc_attr($form_id) . '"]');
}
/**
* Confirms a form ID is safe for use in a shortcode attribute.
*/
private function is_valid_form_id(string $form_id): bool
{
return 1 === preg_match('/^[A-Za-z0-9-]+$/', $form_id);
}
/**
* Returns an array of forms data.
*
* @return array Array of forms prepared for the block.
*/
public static function get_forms(): array
{
$forms = [];
$forms[] = [
'value' => '',
'label' => esc_html__('None', 'emailoctopus'),
'type' => '',
];
$forms_api = Utils::get_forms();
if (!empty($forms_api)) {
foreach ($forms_api as $form) {
$form_name = $form->name ?? esc_html__('Untitled', 'emailoctopus');
switch ($form->type) {
case 'bar':
$form_type_friendly = esc_html__('hello bar', 'emailoctopus');
break;
case 'inline':
$form_type_friendly = esc_html__('inline', 'emailoctopus');
break;
case 'modal':
$form_type_friendly = esc_html__('pop-up', 'emailoctopus');
break;
case 'slide-in':
$form_type_friendly = esc_html__('slide-in', 'emailoctopus');
break;
default:
$form_type_friendly = esc_html__($form->type, 'emailoctopus');
break;
}
$forms[] = [
'value' => $form->id,
'name' => $form_name,
'label' => sprintf('%s (%s)', $form_name, $form_type_friendly),
'type' => $form->type,
'type_friendly' => $form_type_friendly,
];
}
}
return $forms;
}
/**
* Registers rest route to preview the shortcodes.
*/
public function preview_shortcode_endpoint(): void
{
$route = '/preview-shortcode';
$route_params = [
'methods' => 'GET',
'callback' => [$this, 'preview_shortcode_callback'],
'permission_callback' => function () {
return current_user_can('edit_posts');
},
'args' => [
'shortcode' => [
'required' => true,
'type' => 'string',
'validate_callback' => [$this, 'is_emailoctopus_shortcode'],
],
],
];
register_rest_route($this->rest_api_namespace, $route, $route_params);
}
/**
* Preview the shortcode.
*
* @paramWP_REST_Request $request Request object.
*
* @return array.
*/
public function preview_shortcode_callback(WP_REST_Request $request): array
{
$shortcode = (string) $request->get_param('shortcode');
return [
'js' => $this->is_emailoctopus_shortcode($shortcode) ? do_shortcode($shortcode) : '',
'html' => '',
// Hide reCAPTCHA container
'style' => '',
];
}
/**
* Confirms the preview request contains one EmailOctopus shortcode only.
*/
public function is_emailoctopus_shortcode($shortcode): bool
{
if (!is_string($shortcode)) {
return false;
}
$shortcode = trim($shortcode);
if ('' === $shortcode) {
return false;
}
if (1 !== preg_match('/^' . get_shortcode_regex(['emailoctopus']) . '$/s', $shortcode, $matches)) {
return false;
}
return '' === $matches[1] && '' === $matches[5] && '' === $matches[6];
}
}