Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
68.18%
30 / 44
57.14%
4 / 7
 CRAP
0.00%
0 / 1
Logo
68.18%
30 / 44
57.14%
4 / 7
 40.04
0.00%
0 / 1
 render
100.00%
1 / 1
100.00%
1 / 1
 1
 get_jp_emblem
0.00%
0 / 6
0.00%
0 / 1
 12
 get_jp_emblem_larger
0.00%
0 / 6
0.00%
0 / 1
 12
 get_jp_logo_parts
100.00%
5 / 5
100.00%
1 / 1
 1
 get_base64_logo
100.00%
7 / 7
100.00%
1 / 1
 1
 get_base64_admin_menu_logo
86.67%
13 / 15
0.00%
0 / 1
 10.24
 set_admin_menu_logo
100.00%
4 / 4
100.00%
1 / 1
 4
1<?php
2/**
3 * A logo for Jetpack.
4 *
5 * @package automattic/jetpack-logo
6 */
7
8namespace Automattic\Jetpack\Assets;
9
10/**
11 * Jetpack logo as SVG shapes.
12 *
13 * Initializes the logo property with a string describing the Jetpack logo.
14 * The Jetpack logo SVG string includes CSS classes to stylize it:
15 * - jetpack-logo: the wrapper <svg> tag.
16 * - jetpack-logo__icon-circle: the circle of the Jetpack mark.
17 * - jetpack-logo__icon-triangle: two shapes that correspond to each triangle in the Jetpack mark.
18 * - jetpack-logo__icon-text: the Jetpack lettering.
19 *
20 * @var string
21 */
22const JETPACK_LOGO_SVG = '
23<svg xmlns="http://www.w3.org/2000/svg" height="32" class="jetpack-logo" viewBox="0 0 118 32">
24    <path class="jetpack-logo__icon-circle" d="M16,0C7.2,0,0,7.2,0,16s7.2,16,16,16s16-7.2,16-16S24.8,0,16,0z" fill="#069e08" />
25    <polygon class="jetpack-logo__icon-triangle" points="15,19 7,19 15,3" fill="#fff" />
26    <polygon class="jetpack-logo__icon-triangle" points="17,29 17,13 25,13" fill="#fff" />
27    <path class="jetpack-logo__text" d="M41.3 26.6c-.5-.7-.9-1.4-1.3-2.1 2.3-1.4 3-2.5 3-4.6V8h-3V6h6v13.4C46 22.8 45 24.8 41.3 26.6zM58.5 21.3c-1.5.5-2.7.6-4.2.6-3.6 0-5.8-1.8-5.8-6 0-3.1 1.9-5.9 5.5-5.9s4.9 2.5 4.9 4.9c0 .8 0 1.5-.1 2h-7.3c.1 2.5 1.5 2.8 3.6 2.8 1.1 0 2.2-.3 3.4-.7C58.5 19 58.5 21.3 58.5 21.3zM56 15c0-1.4-.5-2.9-2-2.9-1.4 0-2.3 1.3-2.4 2.9C51.6 15 56 15 56 15zM65 18.4c0 1.1.8 1.3 1.4 1.3.5 0 2-.2 2.6-.4v2.1c-.9.3-2.5.5-3.7.5-1.5 0-3.2-.5-3.2-3.1V12H60v-2h2.1V7.1H65V10h4v2h-4V18.4zM71 10h3v1.3c1.1-.8 1.9-1.3 3.3-1.3 2.5 0 4.5 1.8 4.5 5.6s-2.2 6.3-5.8 6.3c-.9 0-1.3-.1-2-.3V28h-3V10zM76.5 12.3c-.8 0-1.6.4-2.5 1.2v5.9c.6.1.9.2 1.8.2 2 0 3.2-1.3 3.2-3.9C79 13.4 78.1 12.3 76.5 12.3zM93 22h-3v-1.5c-.9.7-1.9 1.5-3.5 1.5-1.5 0-3.1-1.1-3.1-3.2 0-2.9 2.5-3.4 4.2-3.7l2.4-.3v-.3c0-1.5-.5-2.3-2-2.3-.7 0-2.3.5-3.7 1.1L84 11c1.2-.4 3-1 4.4-1 2.7 0 4.6 1.4 4.6 4.7L93 22zM90 16.4l-2.2.4c-.7.1-1.4.5-1.4 1.6 0 .9.5 1.4 1.3 1.4s1.5-.5 2.3-1V16.4zM104.5 21.3c-1.1.4-2.2.6-3.5.6-4.2 0-5.9-2.4-5.9-5.9 0-3.7 2.3-6 6.1-6 1.4 0 2.3.2 3.2.5V13c-.8-.3-2-.6-3.2-.6-1.7 0-3.2.9-3.2 3.6 0 2.9 1.5 3.8 3.3 3.8.9 0 1.9-.2 3.2-.7V21.3zM110 15.2c.2-.3.2-.8 3.8-5.2h3.7l-4.6 5.7 5 6.3h-3.7l-4.2-5.8V22h-3V6h3V15.2z" />
28</svg>
29';
30
31/**
32 * Create and render a Jetpack logo.
33 */
34class Logo {
35
36    /**
37     * Return the Jetpack logo.
38     *
39     * @return string The Jetpack logo.
40     */
41    public function render() {
42        return JETPACK_LOGO_SVG;
43    }
44
45    /**
46     * Return string containing the Jetpack logo.
47     *
48     * @since 1.1.4
49     * @since-jetpack 7.5.0
50     *
51     * @param bool $logotype Should we use the full logotype (logo + text). Default to false.
52     *
53     * @return string
54     */
55    public function get_jp_emblem( $logotype = false ) {
56        $logo_text = $this->get_jp_logo_parts();
57        return sprintf(
58            '<svg id="jetpack-logo__icon" xmlns="http://www.w3.org/2000/svg" x="0px" y="0px" viewBox="0 0 %1$s 32">%2$s</svg>',
59            ( true === $logotype ? '118' : '32' ),
60            ( true === $logotype ? $logo_text['logo'] . $logo_text['text'] : $logo_text['logo'] )
61        );
62    }
63
64    /**
65     * Return string containing the Jetpack logo in a slightly larger format than get_jp_emblem().
66     *
67     * @since 1.1.4
68     * @param bool $logotype Should we use the full logotype (logo + text). Default to false.
69     * @return string
70     */
71    public function get_jp_emblem_larger( $logotype = false ) {
72        $logo_text = $this->get_jp_logo_parts();
73        return sprintf(
74            '<svg class="jitm-jp-logo" xmlns="http://www.w3.org/2000/svg" x="0px" y="0px" height="32" viewBox="0 0 %1$s 32">%2$s</svg>',
75            ( true === $logotype ? '118' : '32' ),
76            ( true === $logotype ? $logo_text['logo'] . $logo_text['text'] : $logo_text['logo'] )
77        );
78    }
79
80    /**
81     * Return array containing the Jetpack logo and text
82     *
83     * @since 1.6.0 - Added $color parameter.
84     *
85     * @param string $color The color of the logo.
86     *
87     * @return array
88     */
89    private function get_jp_logo_parts( $color = '#069e08' ) {
90        return array(
91            'logo' => '<path fill="' . $color . '" d="M16,0C7.2,0,0,7.2,0,16s7.2,16,16,16c8.8,0,16-7.2,16-16S24.8,0,16,0z M15.2,18.7h-8l8-15.5V18.7z M16.8,28.8 V13.3h8L16.8,28.8z"/>',
92            'text' => '<path d="M41.3,26.6c-0.5-0.7-0.9-1.4-1.3-2.1c2.3-1.4,3-2.5,3-4.6V8h-3V6h6v13.4C46,22.8,45,24.8,41.3,26.6z" />
93            <path d="M65,18.4c0,1.1,0.8,1.3,1.4,1.3c0.5,0,2-0.2,2.6-0.4v2.1c-0.9,0.3-2.5,0.5-3.7,0.5c-1.5,0-3.2-0.5-3.2-3.1V12H60v-2h2.1V7.1 H65V10h4v2h-4V18.4z" />
94            <path d="M71,10h3v1.3c1.1-0.8,1.9-1.3,3.3-1.3c2.5,0,4.5,1.8,4.5,5.6s-2.2,6.3-5.8,6.3c-0.9,0-1.3-0.1-2-0.3V28h-3V10z M76.5,12.3 c-0.8,0-1.6,0.4-2.5,1.2v5.9c0.6,0.1,0.9,0.2,1.8,0.2c2,0,3.2-1.3,3.2-3.9C79,13.4,78.1,12.3,76.5,12.3z" />
95            <path d="M93,22h-3v-1.5c-0.9,0.7-1.9,1.5-3.5,1.5c-1.5,0-3.1-1.1-3.1-3.2c0-2.9,2.5-3.4,4.2-3.7l2.4-0.3v-0.3c0-1.5-0.5-2.3-2-2.3 c-0.7,0-2.3,0.5-3.7,1.1L84,11c1.2-0.4,3-1,4.4-1c2.7,0,4.6,1.4,4.6,4.7L93,22z M90,16.4l-2.2,0.4c-0.7,0.1-1.4,0.5-1.4,1.6 c0,0.9,0.5,1.4,1.3,1.4s1.5-0.5,2.3-1V16.4z" />
96            <path d="M104.5,21.3c-1.1,0.4-2.2,0.6-3.5,0.6c-4.2,0-5.9-2.4-5.9-5.9c0-3.7,2.3-6,6.1-6c1.4,0,2.3,0.2,3.2,0.5V13 c-0.8-0.3-2-0.6-3.2-0.6c-1.7,0-3.2,0.9-3.2,3.6c0,2.9,1.5,3.8,3.3,3.8c0.9,0,1.9-0.2,3.2-0.7V21.3z" />
97            <path d="M110,15.2c0.2-0.3,0.2-0.8,3.8-5.2h3.7l-4.6,5.7l5,6.3h-3.7l-4.2-5.8V22h-3V6h3V15.2z" />
98            <path d="M58.5,21.3c-1.5,0.5-2.7,0.6-4.2,0.6c-3.6,0-5.8-1.8-5.8-6c0-3.1,1.9-5.9,5.5-5.9s4.9,2.5,4.9,4.9c0,0.8,0,1.5-0.1,2h-7.3 c0.1,2.5,1.5,2.8,3.6,2.8c1.1,0,2.2-0.3,3.4-0.7C58.5,19,58.5,21.3,58.5,21.3z M56,15c0-1.4-0.5-2.9-2-2.9c-1.4,0-2.3,1.3-2.4,2.9 C51.6,15,56,15,56,15z" />',
99        );
100    }
101
102    /**
103     * Return a base64 encoded SVG of the Jetpack logo.
104     * Can be used as a data URI to use the logo inline in CSS.
105     *
106     * @since 1.6.0
107     *
108     * @param string $color The color of the logo.
109     *
110     * @return string
111     */
112    public function get_base64_logo( $color = '#ffffff' ) {
113        $logo_text    = $this->get_jp_logo_parts( $color );
114        $base_logo    = sprintf(
115            '<svg xmlns="http://www.w3.org/2000/svg" x="20px" y="20px" viewBox="-4 -5 41 41">%1$s</svg>',
116            $logo_text['logo']
117        );
118        $encoded_logo = base64_encode( $base_logo ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode -- The encoded version is used as data URI to use the logo in CSS.
119
120        return 'data:image/svg+xml;base64,' . $encoded_logo;
121    }
122
123    /**
124     * Return a base64 encoded SVG of the Jetpack logo using the current admin menu color.
125     *
126     * This mirrors the fallback order in WordPress's wp_color_scheme_settings(), whose
127     * JavaScript output recolors data URI SVG icons after the page loads.
128     *
129     * @since 4.0.1
130     *
131     * @param string|null $color_scheme Admin color scheme to use. Defaults to the
132     *                                  current user's scheme.
133     *
134     * @return string
135     */
136    public function get_base64_admin_menu_logo( $color_scheme = null ) {
137        global $_wp_admin_css_colors;
138
139        /*
140         * WordPress builds the admin menu before admin_init, when its color schemes
141         * are registered. Refresh the stored menu icon afterward, before output.
142         */
143        if (
144            null === $color_scheme
145            && function_exists( 'add_action' )
146            && function_exists( 'did_action' )
147            && ! did_action( 'admin_init' )
148        ) {
149            add_action( 'admin_init', array( __CLASS__, 'set_admin_menu_logo' ), PHP_INT_MAX );
150        }
151
152        if ( null === $color_scheme ) {
153            $color_scheme = function_exists( 'get_user_option' ) ? get_user_option( 'admin_color' ) : '';
154        }
155
156        // It's possible to have a color scheme set that is no longer registered.
157        if ( empty( $_wp_admin_css_colors[ $color_scheme ] ) ) {
158            $color_scheme = 'modern';
159        }
160
161        if ( ! empty( $_wp_admin_css_colors[ $color_scheme ]->icon_colors['base'] ) ) {
162            $color = $_wp_admin_css_colors[ $color_scheme ]->icon_colors['base'];
163        } elseif ( ! empty( $_wp_admin_css_colors['modern']->icon_colors['base'] ) ) {
164            $color = $_wp_admin_css_colors['modern']->icon_colors['base'];
165        } else {
166            $color = '#a7aaad';
167        }
168
169        return $this->get_base64_logo( $color );
170    }
171
172    /**
173     * Update the stored Jetpack admin menu item after admin color schemes are registered.
174     *
175     * @since 4.0.1
176     *
177     * @return void
178     */
179    public static function set_admin_menu_logo() {
180        global $menu;
181
182        foreach ( (array) $menu as $index => $item ) {
183            if ( isset( $item[2] ) && 'jetpack' === $item[2] ) {
184                // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited -- WordPress stores menu icons in this global array.
185                $menu[ $index ][6] = ( new static() )->get_base64_admin_menu_logo();
186                break;
187            }
188        }
189    }
190}