• Главная
• WC_Email

PHP Класс WC_Email

WooCommerce Emails Class which handles the sending on transactional emails and email templates Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
$description	string	Description for the email.
$enabled		'yes' if the method is enabled.
$find	array	Strings to find in subjects/headings.
$heading	string	Heading for the email content.
$id	String	Email method ID.
$mime_boundary	string	Mime boundary (for multipart emails).
$mime_boundary_header	string	Mime boundary header (for multipart emails).
$object	object | boolean	Object this email is for, for example a customer, product, or email.
$plain_replace	array	@var array $plain_replace
$plain_search	array	https://raw.github.com/ushahidi/wp-silcc/master/class.html2text.inc
$recipient	string	Recipients for the email.
$replace	array	Strings to replace in subjects/headings.
$sending	boolean	True when email is being sent.
$subject	string	Subject for the email.
$template_base	string	Template path.
$template_html	string	HTML template path.
$template_plain	string	Plain text template path.
$title	string	Email method title.

Защищенные свойства (Protected)

Свойство	Тип	Описание
$customer_email	boolean	True when the email notification is sent to customers.
$manual	boolean	True when the email notification is sent manually only.

Открытые методы

Метод	Описание
__construct ( )	Constructor.
admin_options ( )	Admin Options.
format_string ( mixed $string ) : string	Format email string.
get_attachments ( ) : string	Get email attachments.
get_blogname ( ) : string	Get WordPress blog name.
get_content ( ) : string	Get email content.
get_content_html ( ) : string	Get the email content in HTML format.
get_content_plain ( ) : string	Get the email content in plain text format.
get_content_type ( ) : string	Get email content type.
get_description ( ) : string	Return the email's description
get_email_type ( ) : string	get_type function.
get_email_type_options ( ) : array	Email type options.
get_from_address ( ) : string	Get the from address for outgoing emails.
get_from_name ( ) : string	Get the from name for outgoing emails.
get_headers ( ) : string	Get email headers.
get_heading ( ) : string	Get email heading.
get_option ( string $key, mixed $empty_value = null ) : string	Proxy to parent's get_option and attempt to localize the result using gettext.
get_recipient ( ) : string	Get valid recipients.
get_subject ( ) : string	Get email subject.
get_template ( string $type ) : string	Get template.
get_theme_template_file ( string $template ) : string	Get the template file in the current theme.
get_title ( ) : string	Return the email's title
handle_multipart ( PHPMailer $mailer ) : PHPMailer	Handle multipart mail.
init_form_fields ( )	Initialise Settings Form Fields - these are generic email options most will use.
is_customer_email ( ) : boolean	Checks if this email is customer focussed.
is_enabled ( ) : boolean	Checks if this email is enabled and will be sent.
is_manual ( ) : boolean	Checks if this email is manually sent
process_admin_options ( )	Admin Panel Options Processing.
send ( string $to, string $subject, string $message, string $headers, string $attachments ) : boolean	Send an email.
style_inline ( string | null $content ) : string	Apply inline styles to dynamic content.

Защищенные методы

Метод	Описание
admin_actions ( )	Admin actions.
delete_template_action ( string $template_type )	Delete template action.
move_template_action ( string $template_type )	Move template action.
save_template ( string $template_code, string $template_path )	Save the email templates.

Описание методов

Описание свойств