Merge branch 'enhancements/45'

# Conflicts:
#	README.md

Author: MaximeCulea

README.md

@@ -6,16 +6,32 @@ Manage members on WordPress as post type. Implement: post type, authentification
 
 ## Important to know ##
 
+### 0.7.2
+Compatibility : 4.6
+
+If you have implemented custom views before 0.7.2, you might update them. Find an exemple [here](https://github.com/BeAPI/members-post-type/commit/2562b7e79feebf09967a2f964f3144e8f6d10930#diff-fac5c1b7350b8f3af605e75406b9c751).
+
+### 0.7.0
 Compatibility : 4.4
 
-Migration from 0.6.0 to 1.0.0
 If you use the roles and capabilities you have to migrate all data from meta for taxonomies to WordPress native functions.
 To do so, download the meta for taxonomies plugin and let the plugin migrate the data for you.
 
 ## Changelog ##
 
-### 0.7.2
+### 1.0.0
+* 28 Nov 2016
+* Add for email notifications the available replacements values which are automatically replaced before email send.
+* Update the .pot and French po/mo.
 
+### 0.7.2
 * 5 Oct 2016
-* `mpt_nonce_field()` method for nounce generating has been intagrated to decorrelate members and WordPress users on one hand, and to not share the same cookie for all connected members, as before, in other hand.
-* /!\ Please note that if you have implemented custom views before 0.7.2, you might update them. Find an exemple [here](https://github.com/BeAPI/members-post-type/commit/2562b7e79feebf09967a2f964f3144e8f6d10930#diff-fac5c1b7350b8f3af605e75406b9c751). /!\
+* `mpt_nonce_field()` method for nounce generating has been integrated to decorrelate members and WordPress users on one hand, and to not share the same cookie for all connected members, as before, in other hand.
+
+### 0.7.1
+* 10 Mar 2016
+* Fix missing `mpt_verify_nonce`.
+
+### 0.7.0
+* 10 Fev 2016
+* Update the way roles and capabilities works with members.

classes/admin/class-settings-main.php

@@ -17,6 +17,8 @@ public function __construct( ) {
 		add_action( 'admin_init', array( __CLASS__, 'admin_init' ) );
 
 		add_action( 'admin_enqueue_scripts', array( __CLASS__, 'admin_enqueue_scripts' ), 10, 1 );
+
+		add_filter( 'mpt_admin\setting\replacement_values', array( $this, 'add_default_available_replacements_values' ), 20, 2 );
 	}
 
 	/**
@@ -77,7 +79,7 @@ public static function admin_init( ) {
 		//initialize settings
 		self::$settings_api->admin_init( );
 	}
-	
+
 	/**
 	 * TODO: Keep logic
 	 *
@@ -114,4 +116,63 @@ public static function validate_input( $input ) {
 		return apply_filters( 'mpt_settings_validate_input', $output, $input, self::$id );
 	}
 
+	/**
+	 * Add default replacement values and their description.
+	 * As context is the second argument, only wanted data will be returned.
+	 *
+	 * @since 1.0.0
+	 * @author Maxime CULEA
+	 *
+	 * @param array $available_values, By default it is empty
+	 * @param string $context, Where it has been called from.
+	 *
+	 * @return array, key / value corresponding to replacement value and description.
+	 */
+	public function add_default_available_replacements_values( $available_values, $context ) {
+		switch ( $context ) {
+
+			case 'lost_password_admin' :
+				$available_values = array(
+					'blog_name' => __( "Blog's name", 'mpt' ),
+					'user_name' => __( "User's name", 'mpt' ),
+				);
+				break;
+
+			case 'lost_password_member' :
+				$available_values = array(
+					'blog_name'      => __( "Blog's name", 'mpt' ),
+					'user_name'      => __( "User's name", 'mpt' ),
+					'reset_pwd_link' => __( "The password reset link", 'mpt' ),
+					'site_url'       => __( "Current site's url", 'mpt' ),
+				);
+				break;
+
+			case 'register_member' :
+				$available_values = array(
+					'blog_name' => __( "Blog's name", 'mpt' ),
+					'user_name' => __( "User's name", 'mpt' ),
+					'password'  => __( "User's password", 'mpt' ),
+					'login_url' => __( "The site's login url", 'mpt' ),
+				);
+				break;
+
+			case 'register_member_admin' :
+				$available_values = array(
+					'blog_name'  => __( "Blog's name", 'mpt' ),
+					'user_name'  => __( "User's name", 'mpt' ),
+					'user_email' => __( "User's email", 'mpt' )
+				);
+				break;
+
+			case 'register_member_validation' :
+				$available_values = array(
+					'blog_name'             => __( "Blog's name", 'mpt' ),
+					'site_url'              => __( "Current site's url", 'mpt' ),
+					'confirm_register_link' => __( "The register confirmation link", 'mpt' ),
+				);
+				break;
+		}
+
+		return $available_values;
+	}
 }

classes/helpers/class-options.php

@@ -76,4 +76,112 @@ public static function get_default_value_from_default_options( $option_name, $ke
 
 		return $field_data['default'];
 	}
+
+	/**
+	 * Find out if to display the setting's description or not.
+	 *
+	 * @since 1.0.0
+	 * @author Maxime CULEA
+	 *
+	 * @param $context, where it has been called from.
+	 *
+	 * @return bool, whatever to display the setting description or not.
+	 */
+	public static function can_display_setting_description( $context ) {
+
+		/**
+		 * Allow to hide or display th current admin's setting description.
+		 *
+		 * The dynamic portion of the hook name, `$context`, refers to
+		 * Where it has been called from.
+		 *
+		 * @since 1.0.0
+		 *
+		 * @param string $context Where it has been called from.
+		 *
+		 * @param bool $can_display, True or False for choosing whatever to display this setting description.
+		 */
+		$can_display = apply_filters( 'mpt_admin\setting\display_description_' . $context, true );
+
+		/**
+		 * Allow to hide or display multiple admin's settings descriptions.
+		 *
+		 * @since 1.0.0
+		 *
+		 * @param bool $can_display, True or False for choosing whatever to display this setting description.
+		 * @param string $context Where it has been called from.
+		 */
+		$can_display = apply_filters( 'mpt_admin\setting\display_descriptions', $can_display, $context );
+
+		/**
+		 * Allow to hide or display all admin's settings descriptions.
+		 *
+		 * @since 1.0.0
+		 *
+		 * @param bool $can_display, True or False for choosing whatever to display all settings descriptions.
+		 */
+		$can_display = apply_filters( 'mpt_admin\setting\display_all_descriptions', $can_display );
+
+		return $can_display;
+	}
+
+	/**
+	 * Handle the admin's setting description name.
+	 *
+	 * @since 1.0.0
+	 * @author Maxime CULEA
+	 *
+	 * @param string $context : Where the method has been called from.
+	 *
+	 * @return string : If empty, setting description will not show up.
+	 */
+	public static function description_setting_name( $context ) {
+		return self::can_display_setting_description( $context ) ? sprintf( '%s_description', $context ) : '';
+	}
+
+	/**
+	 * Handle the admin's setting description desc.
+	 *
+	 * @since 1.0.0
+	 * @author Maxime CULEA
+	 *
+	 * @param string $context : Where the method has been called from.
+	 *
+	 * @return string $html
+	 */
+	public static function description_setting_desc( $context ) {
+		// Default value
+		$html = '';
+
+		if ( ! self::can_display_setting_description( $context ) ) {
+			return $html;
+		}
+
+		/**
+		 * Get the available replacement_values for the current context.
+		 *
+		 * The dynamic portion of the hook name, `$context`, refers to
+		 * Where it has been called from.
+		 *
+		 * @since 1.0.0
+		 *
+		 * @param array $replacement_values, All the available replacements values and their descriptions.
+		 * @param string $context Where it has been called from.
+		 */
+		$replacement_values = apply_filters( 'mpt_admin\setting\replacement_values', array(), $context );
+
+		if ( empty( $replacement_values ) ) {
+			return $html;
+		}
+
+		$html  = '<h4>' . esc_html__( 'The available values are :', 'mpt' ) . '</h4>';
+		$html .= '<p class="description">' . esc_html__( 'Values between "%% %%" will be dynamically replaced before email send.', 'mpt' ). '</p>';
+		$html .= '<table><tbody>';
+		foreach ( $replacement_values as $replacement_value => $replacement_label ) {
+			$html .= sprintf( '<tr><td>%2$s : </td><td>%1$s</td></tr>', sprintf( '%%%%%s%%%%', esc_html( $replacement_value ) ), esc_html( $replacement_label ) );
+		}
+		$html .= '</tbody></table>';
+
+		return $html;
+	}
 }

classes/helpers/default-sections.php

@@ -1,27 +1,27 @@
 <?php
 return array(
 	array(
-		'id' => 'mpt-main',
+		'id'        => 'mpt-main',
 		'tab_label' => __( 'General', 'mpt' ),
-		'title' => __( 'Features available', 'mpt' ),
-		'desc' => false,
+		'title'     => __( 'Features available', 'mpt' ),
+		'desc'      => false,
 	),
 	array(
-		'id' => 'mpt-pages',
-		'tab_label' => __( 'Feature Pages', 'mpt' ),
-		'title' => __( 'Feature Pages', 'mpt' ),
-		'desc' => __( 'You must define here the pages containing the WordPress shortcodes for different features (login, registration, etc).', 'mpt' ),
+		'id'        => 'mpt-pages',
+		'tab_label' => __( 'Feature pages', 'mpt' ),
+		'title'     => __( 'Feature pages', 'mpt' ),
+		'desc'      => __( 'Define here the pages containing WordPress\'s shortcodes for the different features as login, registration, etc.', 'mpt' ),
 	),
 	array(
-		'id' => 'mpt-security',
+		'id'        => 'mpt-security',
 		'tab_label' => __( 'Security', 'mpt' ),
-		'title' => __( 'Password strength', 'mpt' ),
-		'desc' => __( 'Enforce a specific password strength for your members.', 'mpt' ),
+		'title'     => __( 'Security policy', 'mpt' ),
+		'desc'      => __( 'Define your custom password policy by changing default behaviour about password strength, length, must-use characters and so on.', 'mpt' ),
 	),
 	array(
-		'id' => 'mpt-emails',
+		'id'        => 'mpt-emails',
 		'tab_label' => __( 'Mails', 'mpt' ),
-		'title' => __( 'Admin mail for Member registration', 'mpt' ),
-		'desc' => __( 'Management of mail notification to the site administrator when a new member joins the site.', 'mpt' ),
+		'title'     => __( 'Manage admin and member email\'s templates', 'mpt' ),
+		'desc'      => __( 'Change however you want the admin\'s and member\'s email notifications. Please note that only described dynamic values will work for each notification.', 'mpt' ),
 	)
 );