WordPress.org

Ready to get started?Download WordPress

Forums

[Plugin: Breadcrumb NavXT] Unnecessary comments in the output code (5 posts)

  1. Callum Macdonald
    Member
    Posted 5 years ago #

    The plugin adds this by default:
    <!--
    Breadcrumb, generated by Breadcrumb NavXT 2.1.4 - http://mtekk.weblogs.us/code
    -->

    In my opinion it's over the top. While it's a comment, it is spurious code. It marginally increases the size of the page and doesn't serve any useful purpose.

    I have disabled this by commenting out line 665 in the breadcrumb_navxt_class.php file (plugin version 2.1.4).

    As a plugin author myself, I think this type of credit is over the top.

    Cheers - Callum.

  2. Callum Macdonald
    Member
    Posted 5 years ago #

    Apologies, commenting out line 665 is not sufficient, instead comment out line 665 and 666 and add this line:
    echo $bcn_output;

    That should do the trick. :)

    Cheers - Callum.

  3. John Havlik
    Member
    Posted 5 years ago #

    As far as I remember it has been in there since it was Breadcrumb Navigation XT. So many other plugins have similar comments, Bad Behavior still does, though that really isn't an excuse. The link can be removed as it doesn't need to be there, the version numbering helps me help users with problems (as I can quickly figure out their version since most fail to initially provide me with that information).

    A different option to modifying the code would be to pass display the boolean true, and then echo the returned string, which does not contain the HTML comment. This assumes that you are directly accessing the class (the fastest, execution time wise, way of doing things). The administrative interface has problems which are being addressed in the next release (most of them have been addressed in the SVN trunk already).

  4. Callum Macdonald
    Member
    Posted 5 years ago #

    I like the return echo code, that sounds cleaner. I'll look into that. Thanks.

    I agree, the version no is useful. It's also advertising security holes if there are any (just like WordPress does!).

    Maybe a comment like <!--breadcrumbs navxt 2.1.4--> would be less of an issue. Because the current comment has two new lines in it, it messes with the beauty of my HTML! :)

  5. John Havlik
    Member
    Posted 5 years ago #

    Yeah Tom wanted to break it to do the line breaks within the comment as for some reason having the line break after the html comment caused problems with a sidebar widget that he made for it. In the trunk I've changed it to <!--Breadcrumb NavXT [version #]--> (where [version #] is the version number of Breadcrumb NavXT).

Topic Closed

This topic has been closed to new replies.

About this Topic