antispambot( string $email_address, int $hex_encoding ): string

User Contributed Notes

1. Skip to note 3 content

   Codex 9 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 7You must log in to vote on the helpfulness of this note

   Example

   /**
    * Hide email from Spam Bots using a shortcode.
    *
    * @param array  $atts    Shortcode attributes. Not used.
    * @param string $content The shortcode content. Should be an email address.
    * @return string The obfuscated email address. 
    */
   function wpdocs_hide_email_shortcode( $atts , $content = null ) {
   	if ( ! is_email( $content ) ) {
   		return;
   	}
   	return '<a href="' . esc_url('mailto:' . antispambot( $content ) ) . '">' . esc_html( antispambot( $content ) ) . '</a>';
   }
   add_shortcode( 'email', 'wpdocs_hide_email_shortcode' );

   To use this in your WordPress Content area all you have to do it wrap it in a short code.

   [email]john.doe@mysite.com[/email]

   You can also use this in a plain text widget if you add this filter to your function file as well.

   add_filter( 'widget_text', 'shortcode_unautop' );
   add_filter( 'widget_text', 'do_shortcode' );

   Edited with a contribution from @johnrafferty

   • Escaping URL in href attribute will add http:// before email address. In lack of better option, it’s more appropriate to use esc_attr() instead.

     Milana Cap 6 years ago
   • Filtering widget_text is no longer necessary as shortcodes are allowed in text widgets by default.

     Milana Cap 6 years ago
2. Skip to note 4 content

   Nazrinn 4 months ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

   I really feel like this function should be updated. We’re in 2024 and HTML entities can be easily decoded by spam bots. At this point, this technique does not block spam at all.

   If you can, try to use Xor on your WordPress site; avoid using this function.