class-email.php
<?php
/**
* Email component.
*
* @package HivePress\Components
*/
namespace HivePress\Components;
use HivePress\Helpers as hp;
// Exit if accessed directly.
defined( 'ABSPATH' ) || exit;
/**
* Handles emails.
*/
final class Email extends Component {
/**
* Class constructor.
*
* @param array $args Component arguments.
*/
public function __construct( $args = [] ) {
// Set email content.
add_filter( 'hivepress/v1/emails/email', [ $this, 'set_email_content' ], 10, 2 );
// Register integrations.
add_action( 'plugins_loaded', [ $this, 'register_integrations' ] );
if ( is_admin() ) {
// Manage admin columns.
add_filter( 'manage_hp_email_posts_columns', [ $this, 'add_admin_columns' ] );
add_action( 'manage_hp_email_posts_custom_column', [ $this, 'render_admin_columns' ], 10, 2 );
// Disable editor settings.
add_filter( 'wp_editor_settings', [ $this, 'disable_editor_settings' ], 10, 2 );
// Render email details.
add_filter( 'hivepress/v1/meta_boxes/email_details', [ $this, 'render_email_details' ] );
// Set email defaults.
add_action( 'post_updated', [ $this, 'set_email_defaults' ], 10, 3 );
}
parent::__construct( $args );
}
/**
* Sets email content.
*
* @param array $args Email arguments.
* @param object $email Email object.
* @return array
*/
public function set_email_content( $args, $email ) {
if ( $email::get_meta( 'label' ) && ! hp\get_array_value( $args, 'default' ) ) {
// Get content.
$content = hp\get_first_array_value(
get_posts(
[
'name' => $email::get_meta( 'name' ),
'post_type' => 'hp_email',
'post_status' => 'publish',
'posts_per_page' => 1,
'suppress_filters' => ! hivepress()->translator->is_multilingual(),
]
)
);
if ( $content ) {
hivepress()->request->set_post( $content );
// Set subject.
if ( $content->post_title ) {
$args['subject'] = $content->post_title;
}
// Set body.
$args['body'] = apply_filters( 'the_content', $content->post_content );
hivepress()->request->reset_post();
}
}
return $args;
}
/**
* Registers integrations.
*/
public function register_integrations() {
if ( hp\is_plugin_active( 'mc4wp' ) ) {
mc4wp( 'integrations' )->register_integration( 'hivepress', '\HivePress\Integrations\Mailchimp', false );
}
}
/**
* Adds admin columns.
*
* @param array $columns Columns.
* @return array
*/
public function add_admin_columns( $columns ) {
unset( $columns['date'] );
return array_merge(
$columns,
[
'title' => esc_html__( 'Subject', 'hivepress' ),
'event' => esc_html__( 'Event', 'hivepress' ),
'recipient' => esc_html__( 'Recipient', 'hivepress' ),
]
);
}
/**
* Renders admin columns.
*
* @param string $column Column name.
* @param int $email_id Email ID.
*/
public function render_admin_columns( $column, $email_id ) {
$output = '';
// Get email.
$email = hp\get_array_value( hivepress()->get_classes( 'emails' ), get_post_field( 'post_name' ) );
if ( ! $email ) {
return;
}
// Render output.
if ( 'event' === $column ) {
$output = $email::get_meta( 'label' );
} elseif ( 'recipient' === $column ) {
$output = $email::get_meta( 'recipient' );
}
if ( $output ) {
echo wp_kses_data( $output );
}
}
/**
* Disables email editor settings.
*
* @param array $settings Settings.
* @param string $editor Editor ID.
* @return array
*/
public function disable_editor_settings( $settings, $editor ) {
if ( 'content' === $editor ) {
$screen = get_current_screen();
if ( $screen && 'hp_email' === $screen->id ) {
$settings['media_buttons'] = false;
$settings['teeny'] = true;
}
}
return $settings;
}
/**
* Renders email details for admins.
*
* @param array $meta_box Meta box arguments.
* @return array
*/
public function render_email_details( $meta_box ) {
// Get email.
$email = hp\get_array_value( hivepress()->get_classes( 'emails' ), get_post_field( 'post_name' ) );
if ( $email && $email::get_meta( 'label' ) ) {
$output = '';
if ( $email::get_meta( 'description' ) ) {
// Add description.
$output .= $email::get_meta( 'description' ) . ' ';
}
// Get tokens.
$tokens = $email::get_meta( 'tokens' );
if ( $tokens ) {
foreach ( $tokens as $index => $token ) {
// Create model.
$model = hp\create_class_instance( '\HivePress\Models\\' . $token );
if ( $model ) {
// @todo remove temporary fix when updated.
$model->set_id( null );
// Remove token.
unset( $tokens[ $index ] );
// Add tokens.
$tokens[] = $token . '.id';
foreach ( $model->_get_fields() as $field ) {
if ( ! $field->get_arg( '_model' ) && ! in_array(
$field::get_meta( 'name' ),
[
// @todo replace with a common check when available.
'id',
'hidden',
'file',
'password',
'checkbox',
'repeater',
'attachment_select',
'attachment_upload',
]
) ) {
$tokens[] = $token . '.' . $field->get_name();
}
}
}
}
// Set wrapper.
$tag = '<code title="' . esc_attr( hivepress()->translator->get_string( 'click_to_copy' ) ) . '" data-component="copy">';
// Add tokens.
$output .= sprintf( hivepress()->translator->get_string( 'these_tokens_are_available' ), $tag . '%' . implode( '%</code>, ' . $tag . '%', $tokens ) . '%</code>' );
/* translators: 1: |, 2: %. */
$output .= ' ' . sprintf( esc_html__( 'You can add fallback values for empty tokens, separated with %1$s from the token name and placed before the ending %2$s.', 'hivepress' ), '<code>|</code>', '<code>%</code>' );
}
if ( $output ) {
// Add block.
$meta_box['blocks']['email_details'] = [
'type' => 'content',
'content' => '<p>' . trim( $output ) . '</p>',
'_order' => 10,
];
}
}
return $meta_box;
}
/**
* Sets email defaults.
*
* @param int $post_id Post ID.
* @param WP_Post $post Post object.
* @param WP_Post $old_post Old post object.
*/
public function set_email_defaults( $post_id, $post, $old_post ) {
// Check post.
if ( 'hp_email' !== $post->post_type || $post->post_title || $post->post_name === $old_post->post_name ) {
return;
}
// Create email.
$email = hp\create_class_instance( '\HivePress\Emails\\' . sanitize_key( $post->post_name ), [ [ 'default' => true ] ] );
if ( ! $email || ! $email->get_body() ) {
return;
}
// Set defaults.
wp_update_post(
[
'ID' => $post_id,
'post_title' => $email->get_subject(),
'post_content' => $email->get_body(),
]
);
}
}
