Yoast Developer

https://github.com/yoast/developer
Admin
The Yoast Developer portal provides comprehensive, Docusaurus-powered documentation for developers,...
Tokens:341,096
Snippets:3,695
Trust Score:9.4
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Start Docker containers for wordpress-develop

Source: https://github.com/yoast/developer/blob/main/docs/development/environment/setup-plugin-integration-tests.md

Run these commands in the wordpress-develop directory to install dependencies, build, start the environment, and install WordPress.

```shell script
npm install
npm run build:dev
npm run env:start
npm run env:install

```

--------------------------------

### Install Git

Source: https://github.com/yoast/developer/blob/main/docs/development/environment/tools.md

Installs Git for version control. After installation, configure your local Git setup and add your SSH key to GitHub.

```shell script
brew install git
```

--------------------------------

### Install project dependencies

Source: https://github.com/yoast/developer/blob/main/README.md

Installs the project dependencies after cloning the repository.

```bash
$ yarn

```

--------------------------------

### Install Composer dependencies

Source: https://github.com/yoast/developer/blob/main/docs/development/environment/tools.md

Runs composer install in plugin directories containing a composer.json file to install all necessary dependencies.

```shell script
composer install
```

--------------------------------

### Install Homebrew

Source: https://github.com/yoast/developer/blob/main/docs/development/environment/tools.md

Installs Homebrew, the OSX package manager, from the command line. Run this in the terminal (Applications/Utilities/Terminal).

```shell script
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```

--------------------------------

### Install OpenSSL with brew

Source: https://github.com/yoast/developer/blob/main/docs/development/environment/running-unit-tests-code-style-checks-and-linters.md

Installs OpenSSL via Homebrew to resolve SSL permission errors when installing XDebug.

```bash
brew install openssl
```

--------------------------------

### cURL Requests for Get Schema

Source: https://github.com/yoast/developer/blob/main/docs/features/schema/schema-aggregator/api-reference.md

Example cURL commands to retrieve the first page of posts and the second page.

```bash
# Get first page of posts
curl https://example.com/wp-json/yoast/v1/schema-aggregator/get-schema/post

# Get second page
curl https://example.com/wp-json/yoast/v1/schema-aggregator/get-schema/post/2
```

--------------------------------

### Install XDebug with pecl

Source: https://github.com/yoast/developer/blob/main/docs/development/environment/running-unit-tests-code-style-checks-and-linters.md

Installs XDebug via PECL, required to run PHP unit tests with code coverage in PhpStorm.

```bash
pecl install xdebug
```

--------------------------------

### Start local development server

Source: https://github.com/yoast/developer/blob/main/README.md

Starts a local development server and opens a browser window. Most changes are reflected live without restarting the server.

```shell
yarn start

```

--------------------------------

### cURL Request for Get XML

Source: https://github.com/yoast/developer/blob/main/docs/features/schema/schema-aggregator/api-reference.md

Example cURL command to retrieve the XML schemamap.

```bash
curl https://example.com/wp-json/yoast/v1/schema-aggregator/get-xml
```

--------------------------------

### llms.txt output with custom link descriptions

Source: https://github.com/yoast/developer/blob/main/docs/features/llms-txt/functional-specification.md

Example output after applying the wpseo_llmstxt_link_description filter. Pages have no description, and posts get a custom description that includes the post ID.

```markdown
## Pages
- [Page with excerpt](http://example.com/page-with-excerpt/)

## Posts
- [Post with excerpt](http://example.com/post-1): Custom description for post ID 1, this is the custom excerpt.
```

--------------------------------

### Install Rosetta for Local provisioning issues

Source: https://github.com/yoast/developer/blob/main/docs/development/environment/tools.md

Installs Rosetta, which helps if you're on a different chipset than the one Local (or any other software) was developed for, to resolve provisioning issues.

```shell script
softwareupdate --install-rosetta
```

--------------------------------

### Add images to Article Schema with wpseo_schema_article filter

Source: https://github.com/yoast/developer/blob/main/docs/features/schema/pieces/article.md

This example adds an image to the Article schema using the wpseo_schema_article filter. It uses the YoastSEO surface to get the canonical URL and the WPSEO_Schema_Image class. The attachment ID is hardcoded as 12345.

```php
add_filter( 'wpseo_schema_article', 'example_change_article' );

/**
 * Adds images to Article Schema data.
 *
 * @param array $data Schema.org Article data array.
 *
 * @return array Schema.org Article data array.
 */
function example_change_article( $data ) {
    // This is the attachment ID for our image.
    $attachment_id = 12345;

    // We're going to create a graph piece for our image. Every graph piece always needs a Schema ID, so it can
    // be referenced by other graph pieces, best practice is to base that on the canonical adding an ID that's
    // always going to be unique.
    $schema_id     = YoastSEO()->meta->for_current_page()->canonical . '#/schema/image/' . $attachment_id;                 
    $data['image'] = new WPSEO_Schema_Image( $schema_id );

    return $data;
}
```

--------------------------------

### Production and development build

Source: https://github.com/yoast/developer/blob/main/README.md

Builds static content into the `build` directory and serves it locally. The build will fail on broken internal links.

```shell
yarn build
# And then to test it locally: 
yarn serve

```

--------------------------------

### Authorize user with authorization code flow

Source: https://github.com/yoast/developer/blob/main/docs/features/wp-cli/auth.md

Two-phase user authorization code flow with PKCE. First generate the authorization URL, visit it in a browser, complete authorization, and copy the code and state query parameters from the callback URL. Then exchange them for tokens. Pass --url-only during phase 1 to print just the URL for scripting.

```shell
wp yoast auth authorize --user=admin --scopes=openid,profile
```

```shell
wp yoast auth authorize --user=admin --code=<CODE> --state=<STATE>
```

--------------------------------

### Install Yarn via Homebrew

Source: https://github.com/yoast/developer/blob/main/docs/development/environment/tools.md

Installs Yarn globally using Homebrew. Note that this method also installs Node, but that version is not used.

```shell script
brew install yarn
```

--------------------------------

### Install iTerm2 and Oh-My-Zsh

Source: https://github.com/yoast/developer/blob/main/docs/development/environment/tools.md

Installs iTerm2 and Oh-My-Zsh. After installing, change your shell from bsh to zsh with `chsh -s /bin/zsh` to see Oh-My-Zsh features.

```shell script
brew install --cask iterm2
sh -c "$(curl -fsSL https://raw.githubusercontent.com/robbyrussell/oh-my-zsh/master/tools/install.sh)"
```

--------------------------------

### Install Xcode command line tools and build tools

Source: https://github.com/yoast/developer/blob/main/docs/development/environment/tools.md

Installs Xcode command line tools, autoconf, automake, and libtool for building code from source on a Mac.

```shell script
xcode-select --install
brew install autoconf automake libtool
```
Tokens:
Raw