Added option to change Howdy in admin bar

Author: dmhendricks

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 - Fixed: Firing sequence of `common_toolkit_loaded` hook
 - Added: `ctk_environment` filter
+- Added: Ability to change or remove Howdy from admin bar
 - Added: Ability to change login errors
 - Added: Ability to cache JSON config file
 - Added: Ability to disable WordPress core, plugin and/or theme updates

README.md

@@ -40,6 +40,7 @@ All variables are optional.
 | `feed_links`              | Include RSS feed links in page head                                                                                      | bool              | true          |
 | `heartbeat`               | Modify or disable the WordPress heartbeat. Set to integer to change, `false` to disable                                  | bool/int          | null          |
 | `hide_login_errors`       | Replaces login errors with generic "Login failed" text rather than specific reason                                       | bool/string       | null          |
+| `howdy_message`           | Change (string) or remove (false/null) Howdy message in WP admin bar                                                     | bool/string/null  | true          |
 | `meta_generator`          | Enable or change meta generator tags in page head and RSS feeds                                                          | bool/string       | false         |
 | `script_attributes`       | Enable support for [additional attributes](#add-attributes-to-enqueued-scripts) to script tags via wp_enqueue_script()   | bool              | flase         |
 | `shortcodes`              | Enable custom [shortcodes](#shortcodes) created by this class                                                            | bool              | false         |

common-toolkit.php

@@ -50,6 +50,7 @@ final public static function init() {
                 'feed_links' => true,
                 'heartbeat' => null,
                 'hide_login_errors' => false,
+                'howdy_message' => true,
                 'meta_generator' => true,
                 'script_attributes' => false,
                 'shortcodes' => false,
@@ -144,6 +145,11 @@ final public static function init() {
                 add_filter( 'login_errors', array( self::$instance, 'hide_login_errors' ) );
             }
 
+            // Change or remove Howdy message in admin bar
+            if( self::get_config( 'common_toolkit/howdy_message' ) !== true ) {
+                add_filter( 'admin_bar_menu', array( self::$instance, 'admin_bar_howdy' ), 25 );
+            }
+
             // Add filter to retrieve configuration values
             add_filter( 'ctk_config', array( self::$instance, 'ctk_config_filter' ) );
 
@@ -167,7 +173,7 @@ final public static function init() {
      * 
      * @param string $key Configuration variable path to retrieve
      * @param mixed $default The default value to return if $key is not found
-     * @since 0.7.0
+     * @since 0.8.0
      * @see https://github.com/dmhendricks/wordpress-toolkit/blob/master/core/ConfigRegistry.php
      */
     public static function get_config( $key = null, $default = null ) {
@@ -214,7 +220,7 @@ public static function ctk_config_filter( $key = null ) {
      *    Usage: echo apply_filters( 'ctk_environment', null ); // Echos current environment string
      *           var_dump( apply_filters( 'ctk_environment', 'is_production' ) ); // Returns true if in production mode
      *
-     * @since 0.8.0
+     * @since 0.9.0
      */
     public static function ctk_environment_filter( $key = null ) {
 
@@ -232,7 +238,7 @@ public static function ctk_environment_filter( $key = null ) {
      * Remove Emoji code in page header.
      *    Usage: define( 'CTK_CONFIG', [ 'disable_emojis' => true ] );
      * 
-     * @since 0.7.0
+     * @since 0.8.0
      */
     public function disable_emojis() {
 
@@ -254,7 +260,7 @@ public function disable_emojis() {
      * Remove WordPress core, plugin and/or theme update notices
      *    Usage: define( 'CTK_CONFIG', [ 'disable_updates' => [ 'core', 'plugin', 'theme' ] ] );
      * 
-     * @since 0.8.0
+     * @since 0.9.0
      */
     public function disable_updates() {
 
@@ -266,7 +272,7 @@ public function disable_updates() {
     /**
      * Disables WordPress site search and return 404
      * 
-     * @since 0.8.0
+     * @since 0.9.0
      */
     public function disable_search( $query, $error = true ) {
 
@@ -286,7 +292,7 @@ public function disable_search( $query, $error = true ) {
      * Set a different admin bar color color. Useful for differentiating among environnments.
      *    Usage: define( 'CTK_CONFIG', [ 'admin_bar_color' => '#336699' ] );
      * 
-     * @since 0.7.0
+     * @since 0.8.0
      */
     public function change_admin_bar_color() {
 
@@ -300,7 +306,7 @@ public function change_admin_bar_color() {
      *           wp_enqueue_script( 'script-handle-defer-example', get_template_directory_uri() . '/assets/js/script.js#defer' );
      *           wp_enqueue_script( 'script-custom-attributes', get_template_directory_uri() . '/assets/js/script.js?custom_attribute[]=custom-element|amp-ad' );
      * 
-     * @since 0.7.0
+     * @since 0.8.0
      * @see http://php.net/manual/en/domdocument.loadhtml.php
      * @see http://php.net/manual/en/domelement.setattribute.php
      */
@@ -355,7 +361,7 @@ public function defer_async_scripts( $tag, $handle, $src ) {
      *    Usage: $parse_uri = parse_url( 'https://example.com/?hello=world#hash );
      *           $uri = \MU_Plugins\CommonToolkit::build_url( $parse_uri );
      * 
-     * @since 0.7.0
+     * @since 0.8.0
      * @see https://stackoverflow.com/a/35207936
      */
     public static function build_url( array $parts ) {
@@ -388,7 +394,7 @@ public static function build_url( array $parts ) {
      * @param array  $pairs     Entire list of supported attributes and their defaults.
      * @param array  $atts      User defined attributes in shortcode tag.
      * @return array Combined and filtered attribute list.
-     * @since 0.7.0
+     * @since 0.8.0
      */
     public static function set_default_atts( $pairs, $atts ) {
 
@@ -410,7 +416,7 @@ public static function set_default_atts( $pairs, $atts ) {
     /**
      * Modify the WordPress heartbeat
      *
-     * @since 0.8.0
+     * @since 0.9.0
      * @see https://codex.wordpress.org/Function_Reference/wp_heartbeat_settings
      */
     public function modify_heartbeat( $settings ) {
@@ -426,14 +432,16 @@ public function modify_heartbeat( $settings ) {
     /**
      * Hide login errors to mitigate brute force attacks
      *
-     * @since 0.8.0
+     * @since 0.9.0
      * @see https://codex.wordpress.org/Plugin_API/Filter_Reference/login_errors#Example
      */
     public function hide_login_errors( $error ) {
 
         global $errors;
         $err_codes = $errors->get_error_codes();
         $hide_login_errors = self::get_config( 'common_toolkit/hide_login_errors' );
+        if( is_string( $hide_login_errors ) && empty( $hide_login_errors ) ) return null;
+
         $custom_message = is_string( $hide_login_errors ) ? $hide_login_errors : '<strong>ERROR</strong>: Login failed. <a href="%s">Lost your password</a>?';
 
         // Invalid username
@@ -450,10 +458,26 @@ public function hide_login_errors( $error ) {
 
     }
 
+    /**
+     * Change or remove Howdy message in admin bar
+     *
+     * @since 0.9.0
+     */
+    public function admin_bar_howdy( $wp_admin_bar ) {
+
+        $message = trim( self::get_config( 'common_toolkit/howdy_message' ) ) ?: '';
+        $my_account = $wp_admin_bar->get_node( 'my-account' );
+        $wp_admin_bar->add_node([
+            'id' => 'my-account',
+            'title' => str_replace( 'Howdy,', $message, $my_account->title )
+        ]);
+
+    }
+
     /**
      * Remove or modify meta generator tag.
      *
-     * @since 0.7.0
+     * @since 0.8.0
      */
     public function modify_meta_generator_tags( $current, $type ) {
 
@@ -479,7 +503,7 @@ public function modify_meta_generator_tags( $current, $type ) {
      *     Usage: Current date/time: [get_datetime]
      *            Copyright &copy;[get_datetime format="Y"] Your Company
      *
-     * @since 0.7.0
+     * @since 0.8.0
      * @see https://php.net/date
      */
     public function shortcode_get_datetime( $atts ) {
@@ -494,7 +518,7 @@ public function shortcode_get_datetime( $atts ) {
     /**
      * Remove extra HTML tags added by DomDocument
      *
-     * @since 0.7.0
+     * @since 0.8.0
      */
     private function strip_extra_dom_elements( $element ) {
 
@@ -510,7 +534,7 @@ private function strip_extra_dom_elements( $element ) {
      * @param string $key The name of the cache key to set/retrieve
      * @param function $callback The callback function that return the uncached value
      * @return mixed
-     * @since 0.8.0
+     * @since 0.9.0
      */
     public function get_cache_object( $key, $callback, $force = false ) {
 
@@ -550,7 +574,7 @@ public function delete_config_cache() {
     /**
      * Magic method to return config as JSON string.
      *
-     * @since 0.7.0
+     * @since 0.8.0
      */
     public function __toString() {
         return json_encode( self::get_config() );