Changeset 2435 for sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/template-tags.php

Timestamp:

01/30/2016 09:37:19 PM (8 years ago)

Author:

drewapicture

Message:

DevHub: Like with private access messages, use callout box styles for the deprecated message container (if available).

If the Handbook plugin is unavailable, fall back to basic theme-support styles.

See #1551.

File:

• sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/template-tags.php (modified) (3 diffs)

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/template-tags.php

@@ -834 +834 @@
         $type           = array_pop( $types );
         $tags           = get_post_meta( $post_id, '_wp-parser_tags', true );
-        $all_deprecated = wp_filter_object_list( $tags, array( 'name' => 'deprecated' ) );
-
-        if ( empty( $all_deprecated ) ) {
+        $deprecated = wp_filter_object_list( $tags, array( 'name' => 'deprecated' ) );
+
+        if ( empty( $deprecated ) ) {
             return '';
         }
 
-        $deprecated  = array_shift( $all_deprecated );
-        // Multi-@deprecated may have been defined, with the second actually having the deprecation text.
-        if ( empty( $deprecated['content'] ) ) {
-            $deprecated  = array_shift( $all_deprecated );
-        }
-        $description = empty( $deprecated['content'] ) ? '' : esc_html( $deprecated['content'] );
-
-        return "<div class='deprecated'>"
-            . wp_kses_post( sprintf( __( 'Warning: This %s has been deprecated. %s', 'wporg' ), $type, $description ) )
-            . '</div>';
+        $referral = array_shift( wp_filter_object_list( $tags, array( 'name' => 'see' ) ) );
+
+        if ( ! empty( $referral['refers'] ) ) {
+            $refers = sanitize_text_field( $referral['refers'] );
+
+            if ( ! empty( $refers ) ) {
+                /* translators: 1: Linked internal element name */
+                $alternative_string = sprintf( __( ' Use %s instead.', 'wporg' ), \DevHub_Formatting::link_internal_element( $refers ) );
+            }
+        } else {
+            $alternative_string = '';
+        }
+
+        /* translators: 1: String for alternative function (if one exists) */
+        $contents = sprintf( __( 'This %1$s has been deprecated.%2$s', 'wporg' ),
+            $type,
+            $alternative_string
+        );
+
+        // Use the 'warning' callout box if it's available. Otherwise, fall back to a theme-supported div class.
+        if ( class_exists( 'WPorg_Handbook_Callout_Boxes' ) ) {
+            $callout = new \WPorg_Handbook_Callout_Boxes();
+            $message = $callout->warning_shortcode( array(), $contents );
+        } else {
+            $message  = '<div class="deprecated">';
+            /** This filter is documented in wp-includes/post-template.php */
+            $message .= apply_filters( 'the_content', $contents );
+            $message .= '</div>';
+        }
+
+        return $message;
     }
 
@@ -1393 +1414 @@
         /* translators: 1: String for alternative function (if one exists) */
         $contents = sprintf( __( 'This function&#8217;s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.%s', 'wporg' ),
-                $alternative_string
+            $alternative_string
         );
 
@@ -1402 +1423 @@
         } else {
             $message  = '<div class="private-access">';
+            /** This filter is documented in wp-includes/post-template.php */
             $message .= apply_filters( 'the_content', $contents );
             $message .= '</div>';