wordpress-seo

Yoast SEO for WordPress

1,834

912

1,834

1,075

View on GitHub

Top Related Projects

meta-box

1,210

The best plugin for WordPress custom fields and custom meta boxes

Quick Overview

Yoast SEO is a popular WordPress plugin that helps optimize websites for search engines. It provides a comprehensive set of tools for improving on-page SEO, including content analysis, XML sitemaps, and metadata management. Yoast SEO is designed to make SEO accessible to both beginners and advanced users.

Pros

User-friendly interface with clear guidance for SEO optimization
Comprehensive feature set covering various aspects of on-page SEO
Regular updates and active development to keep up with SEO trends
Large user base and extensive documentation

Cons

Can be resource-intensive on larger websites
Some advanced features are only available in the premium version
May conflict with other SEO plugins or themes
Learning curve for utilizing all features effectively

Code Examples

// Add custom meta description
add_filter( 'wpseo_metadesc', 'custom_meta_description' );
function custom_meta_description( $metadesc ) {
    if ( is_single() ) {
        $metadesc = 'Custom meta description for single posts';
    }
    return $metadesc;
}

This example demonstrates how to add a custom meta description for single posts using Yoast SEO's filter.

// Modify Yoast SEO breadcrumbs
add_filter( 'wpseo_breadcrumb_links', 'custom_breadcrumbs' );
function custom_breadcrumbs( $links ) {
    $links[] = array(
        'url' => home_url( '/custom-page/' ),
        'text' => 'Custom Page',
    );
    return $links;
}

This code snippet shows how to modify the Yoast SEO breadcrumbs by adding a custom link.

// Programmatically set Yoast SEO meta title
add_filter( 'wpseo_title', 'custom_title' );
function custom_title( $title ) {
    if ( is_category() ) {
        $title = 'Custom Category Title | ' . get_bloginfo( 'name' );
    }
    return $title;
}

This example illustrates how to programmatically set a custom meta title for category pages using Yoast SEO's filter.

Getting Started

Install the Yoast SEO plugin from the WordPress plugin repository.
Activate the plugin in your WordPress admin panel.
Navigate to SEO > General to configure basic settings.
Use the content analysis tool in the post editor to optimize individual pages and posts.
Configure XML sitemaps and other advanced features in the plugin settings.

For more detailed instructions and advanced usage, refer to the official Yoast SEO documentation.

Competitor Comparisons

meta-box

1,210

The best plugin for WordPress custom fields and custom meta boxes

Pros of Meta Box

More flexible and customizable for creating custom fields and metaboxes
Lighter weight and potentially better performance for specific use cases
Offers a wider range of field types and options for advanced customization

Cons of Meta Box

Less comprehensive SEO optimization features out-of-the-box
Smaller user base and community support compared to WordPress SEO
Requires more technical knowledge to set up and configure effectively

Code Comparison

WordPress SEO (Yoast) example:

add_filter( 'wpseo_title', 'custom_title' );
function custom_title( $title ) {
    // Modify title
    return $title;
}

Meta Box example:

add_filter( 'rwmb_meta_boxes', 'custom_meta_box' );
function custom_meta_box( $meta_boxes ) {
    $meta_boxes[] = [
        'title' => 'Custom Fields',
        'fields' => [
            ['name' => 'Field Name', 'id' => 'field_id', 'type' => 'text'],
        ],
    ];
    return $meta_boxes;
}

The code examples demonstrate the different approaches: WordPress SEO focuses on SEO-specific modifications, while Meta Box provides a framework for creating custom metaboxes and fields.

Convert designs to code with AI

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot

README

Yoast SEO

Welcome to the Yoast SEO GitHub repository

While the documentation for the Yoast SEO plugin can be found on Yoast.com, here you can browse the source of the project, find and discuss open issues and even contribute yourself.

Installation

Here's a guide on how to install Yoast SEO in your WordPress site.

Want to contribute to Yoast SEO?

Prerequisites

At Yoast, we make use a specific toolset to develop our code. Please ensure you have the following tools installed before contributing.

Getting started

After installing the aforementioned tools, you can use the steps below to acquire a development version of Yoast SEO. Please note that this will download the latest development version of Yoast SEO. While this version is usually stable, it is not recommended for use in a production environment.

Within your WordPress installation, navigate to wp-content/plugins and run the following commands:

git clone https://github.com/Yoast/wordpress-seo.git
cd wordpress-seo

To install all the necessary dependencies, run the following commands:

composer install
yarn
grunt build

During development, you could run grunt build:dev instead of grunt build, to save yourself downloading some dependencies that are only needed for a production environment.

Please note that if you change anything in the JavaScript or CSS, you'll have to run grunt build:js or grunt build:css, respectively.

For active development, you could run grunt watch to keep the build up-to-date and run checks right away.

For JavaScript only, a webpack development server is available. To enable the dev-server, you'll have to add this to your WordPress install's config.php:

define( 'YOAST_SEO_DEV_SERVER', true );

and you can start it by running yarn start in the wordpress-seo folder.

Another JavaScript alternative is grunt webpack:watch, this command will keep the JS files up-to-date. You'll have to refresh the page yourself since this does not run a development server.

This repository uses the Yoast grunt tasks plugin.

Testing packages

To run tests for js packages, run the following command from packages/js folder:

yarn test

Support

This is a developer's portal for Yoast SEO and should not be used for support. Please visit the support forums.

Reporting bugs

If you find an issue, let us know here! Please follow these guidelines on how to write a good bug report.

It may help us a lot if you can provide a backtrace of the error encountered. You can use code in this gist to enable the backtrace in your website's configuration.

Contributions

Anyone is welcome to contribute to Yoast SEO. Please read the guidelines for contributing to this repository.

There are various ways you can contribute:

Raise an issue on GitHub.
Send us a Pull Request with your bug fixes and/or new features.
Translate Yoast SEO into different languages.
Provide feedback and suggestions on enhancements.

Top Related Projects

meta-box

1,210

The best plugin for WordPress custom fields and custom meta boxes

Convert designs to code with AI

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot