Changeset 13868 for trunk/src/bp-core/deprecated/14.0.php

Timestamp:

05/19/2024 11:00:37 AM (12 months ago)

Author:

imath

Message:

Add Help tabs to inform about BP Emails management & BP Email tokens

• Improve bp_core_add_contextual_help() to avoid code duplication.
• Add an help tab linking to the user documentation page explaining how to manage BP Emails.
• Add an help tab linking to the user documentation page explaining BP Email tokens usage.
• Deprecate bp_admin_email_add_codex_notice().

Fixes #9159
Closes ​https://github.com/buddypress/buddypress/pull/291

File:

• trunk/src/bp-core/deprecated/14.0.php (modified) (1 diff)

trunk/src/bp-core/deprecated/14.0.php

@@ -64 +64 @@
     return apply_filters_deprecated( 'bp_use_wp_admin_bar', array( $use_admin_bar ), '14.0.0' );
 }
+
+/**
+ * In emails editor, add notice linking to token documentation on Codex.
+ *
+ * @since 2.5.0
+ * @deprecated 14.0.0
+ */
+function bp_admin_email_add_codex_notice() {
+    _deprecated_function( __FUNCTION__, '14.0.0' );
+
+    if ( get_current_screen()->post_type !== bp_get_email_post_type() ) {
+        return;
+    }
+
+    bp_core_add_admin_notice(
+        sprintf(
+            // Translators: %s is the url to the BuddyPress codex page about BP Email tokens.
+            __( 'Phrases wrapped in braces <code>{{ }}</code> are email tokens. <a href="%s">Learn about tokens on the BuddyPress Codex</a>.', 'buddypress' ),
+            esc_url( 'https://codex.buddypress.org/emails/email-tokens/' )
+        ),
+        'error'
+    );
+}