WordPress

Unpic can transform images with WordPress using the wordpress provider. It can be used with Unpic framework components, or you can use the base unpic libary to generate image URLs directly.

You can import the wordpress provider from the unpic package using a subpath import:

import { transform } from 'unpic/providers/wordpress';

If using an Unpic component, you can optionally pass custom operations and options to the component using an object with a wordpress key. This is lets you use extra features supported by WordPress, or set custom configuration options.

This example uses @unpic/astro, but the same applies to any Unpic component:

---
import { Image } from '@unpic/astro';
---
<Image
  src="image.jpg"
  width={800}
  height={600}
  options={{
      "wordpress": {
      // wordpress options here
      }
  }}
  operations={{
      "wordpress": {
      // wordpress operations here
      }
  }}
/>

In supported frameworks you can also import the base component and pass the transformer to it directly. This lets you create a custom component that doesn’t need to include and other transformer code.

---
import { Image } from '@unpic/astro/base';
import { transform } from 'unpic/providers/wordpress';
---
<Image
  src="image.jpg"
  width={800}
  height={600}
  transformer={transformer}
/>

Types

The wordpress provider supports the following arguments:

Options

The wordpress provider does not support any extra configuration options.

Operations

w

Type: number

h

Type: number

crop

Type: boolean | "1" | "0"

width

Type: string | number

height

Type: string | number

format

Type: ImageFormat | (string & {})

quality

Type: string | number

This page is auto-generated from the wordpress provider types. See anything wrong or missing? Suggest a change on GitHub.