Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve docblock comments in WC_Email_Customer_Reset_Password class 

* Added better comments to properties.
* Added comments to `get_content_plain` and `get_content_html`
* Added missing param tag to `trigger`
This commit is contained in:
Fredrik Forsmo 2016-01-05 19:36:44 +01:00
parent ade2b04ab3
commit c60f327e5f
1 changed files with 20 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
includes/emails/class-wc-email-customer-reset-password.php
View File

@ -19,13 +19,25 @@ if ( ! class_exists( 'WC_Email_Customer_Reset_Password' ) ) :
*/
class WC_Email_Customer_Reset_Password extends WC_Email {
/** @var string */
/**
* User login name.
*
* @var string
*/
public $user_login;
/** @var string */
/**
* User email.
*
* @var string
*/
public $user_email;
/** @var string */
/**
* Reset key.
*
* @var string
*/
public $reset_key;
/**
@ -53,6 +65,9 @@ class WC_Email_Customer_Reset_Password extends WC_Email {
/**
* Trigger.
*
* @param string $user_login
* @param string $reset_key
*/
function trigger( $user_login = '', $reset_key = '' ) {
if ( $user_login && $reset_key ) {
@ -73,7 +88,7 @@ class WC_Email_Customer_Reset_Password extends WC_Email {
}
/**
* get_content_html function.
* Get content html.
*
* @access public
* @return string
@ -91,7 +106,7 @@ class WC_Email_Customer_Reset_Password extends WC_Email {
}
/**
* get_content_plain function.
* Get content plain.
*
* @access public
* @return string