diff --git a/src/bp-core/bp-core-admin.php b/src/bp-core/bp-core-admin.php index 25cc48b..e0601a0 100644 --- a/src/bp-core/bp-core-admin.php +++ b/src/bp-core/bp-core-admin.php @@ -295,7 +295,6 @@ class BP_Admin { 'bp_core_admin_tools' ); - // Fudge the highlighted subnav item when on a BuddyPress admin page. foreach( $hooks as $hook ) { add_action( "admin_head-$hook", 'bp_core_modify_admin_menu_highlight' ); } @@ -767,6 +766,7 @@ class BP_Admin { At.js, bbPress, Caret.js, + Cerberus, jquery.cookie, MediaWiki, WordPress. @@ -876,6 +876,23 @@ class BP_Admin { } /** + * Add Emails menu item to custom menus array. + * + * Several BuddyPress components have top-level menu items in the Dashboard, + * which all appear together in the middle of the Dashboard menu. This function + * adds the Emails screen to the array of these menu items. + * + * @since 2.4.0 + * + * @param array $custom_menus The list of top-level BP menu items. + * @return array $custom_menus List of top-level BP menu items, with Emails added. + */ + public function emails_admin_menu_order( $custom_menus = array() ) { + array_push( $custom_menus, 'edit.php?post_type=' . bp_get_email_post_type() ); + return $custom_menus; + } + + /** * Register styles commonly used by BuddyPress wp-admin screens. * * @since 2.5.0 diff --git a/src/bp-core/bp-core-filters.php b/src/bp-core/bp-core-filters.php index 0d4b342..c9f8d9f 100644 --- a/src/bp-core/bp-core-filters.php +++ b/src/bp-core/bp-core-filters.php @@ -1038,3 +1038,59 @@ function _bp_core_inject_bp_widget_css_class( $params ) { return $params; } add_filter( 'dynamic_sidebar_params', '_bp_core_inject_bp_widget_css_class' ); + +/** + * Find and render the template for Email posts (the Customizer and admin previews). + * + * Misuses the `template_include` filter which expects a string, but as we need to replace + * the `{{{content}}}` token with the post's content, we use object buffering to load the + * template, replace the token, and render it. + * + * The function returns an empty string to prevent WordPress rendering another template. + * + * @since 2.5.0 + * + * @param string $template Path to template (probably single.php). + * @return string + */ +function bp_core_render_email_template( $template ) { + if ( get_post_type() !== bp_get_email_post_type() || ! is_single() ) { + return $template; + } + + /** + * Filter template used to display Email posts. + * + * @since 2.5.0 + * + * @param string $template Path to current template (probably single.php). + */ + $email_template = apply_filters( 'bp_core_render_email_template', + bp_locate_template( bp_email_get_template( get_queried_object() ), false ), + $template + ); + + if ( ! $email_template ) { + return $template; + } + + ob_start(); + include( $email_template ); + $template = ob_get_contents(); + ob_end_clean(); + + echo str_replace( '{{{content}}}', nl2br( get_post()->post_content ), $template ); + + /* + * Link colours are applied directly in the email template before sending, so we + * need to add an extra style here to set the colour for the Customizer or preview. + */ + $settings = bp_email_get_appearance_settings(); + printf( + '', + esc_attr( $settings['highlight_color'] ) + ); + + return ''; +} +add_action( 'bp_template_include', 'bp_core_render_email_template', 12 ); diff --git a/src/bp-core/bp-core-functions.php b/src/bp-core/bp-core-functions.php index 69a914e..489c31c 100644 --- a/src/bp-core/bp-core-functions.php +++ b/src/bp-core/bp-core-functions.php @@ -2591,3 +2591,182 @@ function bp_upload_dir() { return $bp->upload_dir; } + + +/** Post Types *****************************************************************/ + +/** + * Output the name of the email post type. + * + * @since 2.5.0 + */ +function bp_email_post_type() { + echo bp_get_email_post_type(); +} + /** + * Returns the name of the email post type. + * + * @since 2.5.0 + * + * @return string The name of the email post type. + */ + function bp_get_email_post_type() { + + /** + * Filters the name of the email post type. + * + * @since 2.5.0 + * + * @param string $post_type Email post type name. + */ + return apply_filters( 'bp_get_email_post_type', buddypress()->email_post_type ); + } + +/** + * Return labels used by the email post type. + * + * @since 2.5.0 + * + * @return array + */ +function bp_get_email_post_type_labels() { + + /** + * Filters email post type labels. + * + * @since 2.5.0 + * + * @param string[] $labels Associative array (name => label). + */ + return apply_filters( 'bp_get_email_post_type_labels', array( + 'add_new' => _x( 'Add New', 'email post type label', 'buddypress' ), + 'add_new_item' => _x( 'Add a New Email', 'email post type label', 'buddypress' ), + 'all_items' => _x( 'All Emails', 'email post type label', 'buddypress' ), + 'edit_item' => _x( 'Edit Email', 'email post type label', 'buddypress' ), + 'filter_items_list' => _x( 'Filter email list', 'email post type label', 'buddypress' ), + 'items_list' => _x( 'Email list', 'email post type label', 'buddypress' ), + 'items_list_navigation' => _x( 'Email list navigation', 'email post type label', 'buddypress' ), + 'name' => _x( 'Emails', 'email post type name', 'buddypress' ), + 'new_item' => _x( 'New Email', 'email post type label', 'buddypress' ), + 'not_found' => _x( 'No emails found', 'email post type label', 'buddypress' ), + 'not_found_in_trash' => _x( 'No emails found in Trash', 'email post type label', 'buddypress' ), + 'search_items' => _x( 'Search Emails', 'email post type label', 'buddypress' ), + 'singular_name' => _x( 'Email', 'email post type singular name', 'buddypress' ), + 'uploaded_to_this_item' => _x( 'Uploaded to this email', 'email post type label', 'buddypress' ), + 'view_item' => _x( 'View Email', 'email post type label', 'buddypress' ), + ) ); +} + +/** + * Return array of features that the email post type supports. + * + * @since 2.5.0 + * + * @return array + */ +function bp_get_email_post_type_supports() { + + /** + * Filters the features that the email post type supports. + * + * @since 2.5.0 + * + * @param string[] $features Supported features. + */ + return apply_filters( 'bp_get_email_post_type_supports', array( + 'editor', + 'excerpt', + 'revisions', + 'title', + ) ); +} + + +/** Taxonomies *****************************************************************/ + +/** + * Output the name of the email type taxonomy. + * + * @since 2.5.0 + */ +function bp_email_tax_type() { + echo bp_get_email_tax_type(); +} + /** + * Return the name of the email type taxonomy. + * + * @since 2.5.0 + * + * @return string The unique email taxonomy type ID. + */ + function bp_get_email_tax_type() { + + /** + * Filters the name of the email type taxonomy. + * + * @since 2.5.0 + * + * @param string $taxonomy Email type taxonomy name. + */ + return apply_filters( 'bp_get_email_tax_type', buddypress()->email_taxonomy_type ); + } + +/** + * Return labels used by the email type taxonomy. + * + * @since 2.5.0 + * + * @return string[] + */ +function bp_get_email_tax_type_labels() { + + /** + * Filters email type taxonomy labels. + * + * @since 2.5.0 + * + * @param string[] $labels Associative array (name => label). + */ + return apply_filters( 'bp_get_email_tax_type_labels', array( + 'add_new_item' => _x( 'New Email Type', 'email type taxonomy label', 'buddypress' ), + 'all_items' => _x( 'All Email Types', 'email type taxonomy label', 'buddypress' ), + 'edit_item' => _x( 'Edit Email Types', 'email type taxonomy label', 'buddypress' ), + 'items_list' => _x( 'Email list', 'email type taxonomy label', 'buddypress' ), + 'items_list_navigation' => _x( 'Email list navigation', 'email type taxonomy label', 'buddypress' ), + 'menu_name' => _x( 'Types', 'email type taxonomy label', 'buddypress' ), + 'name' => _x( 'Email Types', 'email type taxonomy name', 'buddypress' ), + 'new_item_name' => _x( 'New Email Type Name', 'email type taxonomy label', 'buddypress' ), + 'not_found' => _x( 'No email types found.', 'email type taxonomy label', 'buddypress' ), + 'no_terms' => _x( 'No email types', 'email type taxonomy label', 'buddypress' ), + 'popular_items' => _x( 'Popular Email Types', 'email type taxonomy label', 'buddypress' ), + 'search_items' => _x( 'Search Emails', 'email type taxonomy label', 'buddypress' ), + 'singular_name' => _x( 'Email', 'email type taxonomy singular name', 'buddypress' ), + 'update_item' => _x( 'Update Email Type', 'email type taxonomy label', 'buddypress' ), + 'view_item' => _x( 'View Email Type', 'email type taxonomy label', 'buddypress' ), + ) ); +} + +/** + * Get the paths to possible templates for the specified email object. + * + * @since 2.5.0 + * + * @param WP_Post $object Post to get email template for. + * @return string[] + */ +function bp_email_get_template( WP_Post $object ) { + $single = "single-{$object->post_type}"; + + /** + * Filter the possible template paths for the specified email object. + * + * @since 2.5.0 + * + * @param string[] $templates + */ + return apply_filters( 'bp_email_get_template', array( + "{$single}-{$object->post_name}.php", + "{$single}.php", + "assets/emails/{$single}.php", + ), $object ); +} diff --git a/src/bp-core/bp-core-loader.php b/src/bp-core/bp-core-loader.php index 80cd4f6..1f1cb9a 100644 --- a/src/bp-core/bp-core-loader.php +++ b/src/bp-core/bp-core-loader.php @@ -285,6 +285,34 @@ class BP_Core extends BP_Component { parent::setup_cache_groups(); } + + /** + * Set up post types. + * + * @since BuddyPress (2.4.0) + */ + public function register_post_types() { + + // Emails + register_post_type( + bp_get_email_post_type(), + apply_filters( 'bp_register_email_post_type', array( + //'capability_type' => array( 'bpemail', 'bpemails' ), TODO + 'description' => _x( 'BuddyPress emails', 'email post type description', 'buddypress' ), + 'labels' => bp_get_email_post_type_labels(), + 'menu_icon' => 'dashicons-email', + 'public' => false, + 'publicly_queryable' => bp_current_user_can( 'bp_moderate' ), + 'query_var' => false, + 'rewrite' => false, + 'show_in_admin_bar' => false, + 'show_ui' => bp_current_user_can( 'bp_moderate' ), // TODO + 'supports' => bp_get_email_post_type_supports(), + ) ) + ); + + parent::register_post_types(); + } } /** diff --git a/src/bp-core/bp-core-taxonomy.php b/src/bp-core/bp-core-taxonomy.php index 7a9c4e6..0cbbc4f 100644 --- a/src/bp-core/bp-core-taxonomy.php +++ b/src/bp-core/bp-core-taxonomy.php @@ -24,6 +24,22 @@ function bp_register_default_taxonomies() { register_taxonomy( 'bp_member_type', 'user', array( 'public' => false, ) ); + + // Email type. + register_taxonomy( + bp_get_email_tax_type(), + bp_get_email_post_type(), + apply_filters( 'bp_register_email_tax_type', array( + 'description' => _x( 'BuddyPress email types', 'email type taxonomy description', 'buddypress' ), + 'labels' => bp_get_email_tax_type_labels(), + 'public' => false, + 'query_var' => false, + 'rewrite' => false, + 'show_admin_column' => true, + 'show_tagcloud' => false, + 'show_ui' => bp_current_user_can( 'bp_moderate' ), // TODO + ) ) + ); } add_action( 'bp_register_taxonomies', 'bp_register_default_taxonomies' ); diff --git a/src/bp-core/bp-core-update.php b/src/bp-core/bp-core-update.php index a85c41e..3251fc4 100644 --- a/src/bp-core/bp-core-update.php +++ b/src/bp-core/bp-core-update.php @@ -213,6 +213,7 @@ function bp_version_updater() { bp_core_install( $default_components ); bp_update_option( 'bp-active-components', $default_components ); bp_core_add_page_mappings( $default_components, 'delete' ); + bp_core_install_emails(); // Upgrades } else { @@ -260,6 +261,11 @@ function bp_version_updater() { if ( $raw_db_version < 9615 ) { bp_update_to_2_3(); } + + // 2.5.0 + if ( $raw_db_version < 10440 ) { + bp_update_to_2_5(); + } } /** All done! *************************************************************/ @@ -484,6 +490,17 @@ function bp_update_to_2_3() { } /** + * 2.5.0 update routine. + * + * - Add emails. + * + * @since 2.5.0 + */ +function bp_update_to_2_5() { + bp_core_install_emails(); +} + +/** * Updates the component field for new_members type. * * @since 2.2.0 diff --git a/src/bp-loader.php b/src/bp-loader.php index 77d5408..7ee55b1 100644 --- a/src/bp-loader.php +++ b/src/bp-loader.php @@ -328,7 +328,7 @@ class BuddyPress { /** Versions **********************************************************/ $this->version = '2.5.0-alpha'; - $this->db_version = 10071; + $this->db_version = 10440; /** Loading ***********************************************************/ @@ -422,6 +422,10 @@ class BuddyPress { $this->current_user = new stdClass(); $this->displayed_user = new stdClass(); + + /** Post types and taxonomies *****************************************/ + $this->email_post_type = apply_filters( 'bp_email_post_type', 'bp-email' ); + $this->email_taxonomy_type = apply_filters( 'bp_email_tax_type', 'bp-email-type' ); } /** diff --git a/src/bp-templates/bp-legacy/buddypress/assets/emails/single-bp-email.php b/src/bp-templates/bp-legacy/buddypress/assets/emails/single-bp-email.php new file mode 100644 index 0000000..3674f24 --- /dev/null +++ b/src/bp-templates/bp-legacy/buddypress/assets/emails/single-bp-email.php @@ -0,0 +1,190 @@ + + + + + + + + + + + + + +
+
+ + +
+ (Optional) This text will appear in the inbox preview, but not the email body. +
+ + +
+ + + + + + + +
+ +
+ + + + + + + + + + + +
+ + + + +
+ Hi Paul Gibbs, +

+ {{{content}}} +
+
+ + + +
+ + + + +
+ +

+ +
+ + + +
+
+
+ + +