README

The WordPress Carbon Calculator, drawing inspiration from the acclaimed Website Carbon Calculator algorithm 2.0 and leveraging The Green Web Foundation's co2.js, is a powerful plugin tailored to empower website owners in their quest to assess and minimize their carbon footprint.

This user-friendly tool allows you to effortlessly calculate the CO2 impact of any page on your website directly from your WordPress admin panel. Unlike other solutions, this plugin does not rely on the Website Carbon API, allowing real-time calculations without delays, instantly reflecting changes made in the back office.

Whether you're a sustainability-conscious blogger, a corporate website manager, or anyone committed to environmental responsibility, the WordPress Carbon Calculator is your essential solution for environmental impact assessment.

Key Features

• Precision Carbon Calculations: Built upon the foundation of the Website Carbon Calculator algorithm 2.0 and powered by The Green Web Foundation's co2.js, our plugin delivers highly accurate CO2 impact calculations by incorporating the latest environmental data.

• Intuitive Interface: The WordPress Carbon Calculator offers an intuitive and user-friendly interface within your WordPress admin area, simplifying the process of accessing and analyzing environmental data.

• Front-End Presentation: Showcase the computed CO2 impact prominently on your website's front end, allowing you to engage and educate your website visitors.

• Data from Google Page Speed: The plugin gathers loaded data efficiently using Google Page Speed, ensuring you have access to comprehensive performance metrics to make informed decisions.

Installation

Via Composer

$ composer require wpackagist-plugin/website-carbon-calculator

Via GitHub

1. Download the plugin as a ZIP file from the GitHub repository.
2. Upload the ZIP file to your WordPress site by navigating to the Plugins section in your WordPress admin panel and clicking on "Add New."

Getting Started

1. Activate the Website Carbon Calculator plugin.
2. Navigate to "Settings" and select "Carbon Calculator."
3. Enter the necessary information to configure the plugin.

Note: The carbon calculator functionality is not available in a local development environment.

Interface

Minimal Impact – This page has mostly text, resulting in a low CO₂ footprint.

Higher Impact – Adding a YouTube video increases the page’s CO₂ emissions.

Advanced Data – View bytes transferred, boot-up time, and key performance metrics.

Taxonomy Support – Analyze CO₂ impact directly on term pages.

Instant Insights – See a page’s CO₂ impact with green, orange, or red flags.

Dashboard Widget – View average CO₂ impact and performance scores at a glance.

Advanced Tools – Compute emissions for special pages with dedicated tools.

Customizable Settings – Fine-tune calculations for accurate CO₂ impact analysis.

How to display it in your templates ?

Integrating the Carbon Calculator into your website's front-end templates is a breeze and allows you to display the calculated carbon emissions directly to your site visitors.

In your front-end template files (such as your theme's template files or custom templates), you can access the carbon calculation method by using get_calculated_carbon(). This method is available on any page of your site.

Here's an example of how you can use the code:

<?php if($calculated_carbon = get_calculated_carbon() ): ?>
This page emits <?=round($calculated_carbon,2)?>g eq. CO₂
<?php endif; ?>

The code snippet will display the calculated carbon emissions on the front-end of your website for your site visitors to see. It provides valuable information about the environmental impact of the current page.

By following these simple steps, you can raise awareness about the carbon footprint of your web content and encourage your audience to make more sustainable choices.

Feel free to customize the code or incorporate it into your templates as needed to fit your website's design and layout.

Remember, this feature adds a powerful environmental dimension to your website, aligning it with eco-conscious principles and contributing to a greener digital landscape.

Roadmap

Here's a glimpse of what's coming:

• translations
• ecoindex.fr algorithm support
• better settings/tools interface

Licence

GPL 3.0 or later