@wordpress/server-side-render Edit

ServerSideRender is a component used for server-side rendering a preview of dynamic blocks to display in the editor. Server-side rendering in a block’s edit function should be limited to blocks that are heavily dependent on existing PHP rendering logic that is heavily intertwined with data, particularly when there are no endpoints available.

ServerSideRender may also be used when a legacy block is provided as a backward compatibility measure, rather than needing to re-write the deprecated code that the block may depend on.

ServerSideRender should be regarded as a fallback or legacy mechanism, it is not appropriate for developing new features against.

New blocks should be built in conjunction with any necessary REST API endpoints, so that JavaScript can be used for rendering client-side in the edit function. This gives the best user experience, instead of relying on using the PHP render_callback. The logic necessary for rendering should be included in the endpoint, so that both the client-side JavaScript and server-side PHP logic should require a minimal amount of differences.

This package is meant to be used only with WordPress core. Feel free to use it in your own project but please keep in mind that it might never get fully documented.

Installation

Install the module

npm install @wordpress/server-side-render --save

This package assumes that your code will run in an ES2015+ environment. If you’re using an environment that has limited or no support for such language features and APIs, you should include the polyfill shipped in @wordpress/babel-preset-default in your code.

Top ↑

Usage

The props accepted by the component are described below.

Top ↑

Props

Top ↑

attributes

An object containing the attributes of the block to be server-side rendered.
E.g: { displayAsDropdown: true }, { showHierarchy: true }, etc…

  • Type: Object
  • Required: No

Top ↑

block

The identifier of the block to be server-side rendered.
Examples: “core/archives”, “core/latest-comments”, “core/rss”, etc…

  • Type: String
  • Required: Yes

Top ↑

className

A class added to the DOM element that wraps the server side rendered block.
Examples: “my-custom-server-side-rendered”.

  • Type: String
  • Required: No

Top ↑

httpMethod

The HTTP request method to use, either ‘GET’ or ‘POST’. It’s ‘GET’ by default. The ‘POST’ value will cause an error on WP earlier than 5.5, unless ‘rest_endpoints’ is filtered in PHP to allow this. If ‘POST’, this sends the attributes in the request body, not in the URL. This can allow a bigger attributes object.

  • Type: String
  • Required: No

Top ↑

Example:

function add_rest_method( $endpoints ) {
    if ( is_wp_version_compatible( '5.5' ) ) {
        return $endpoints;
    }

    foreach ( $endpoints as $route => $handler ) {
        if ( isset( $endpoints[ $route ][0] ) ) {
            $endpoints[ $route ][0]['methods'] = [ WP_REST_Server::READABLE, WP_REST_Server::CREATABLE ];
        }
    }

    return $endpoints;
}
add_filter( 'rest_endpoints', 'add_rest_method');

Top ↑

urlQueryArgs

Query arguments to apply to the request URL.
E.g: { post_id: 12 }.

  • Type: Object
  • Required: No

Top ↑

EmptyResponsePlaceholder

The component is rendered when the API response is empty. The component will receive the value of the API response, and all props passed into ServerSideRenderer.

  • Type: Component
  • Required: No

Top ↑

ErrorResponsePlaceholder

The component is rendered when the API response is an error. The component will receive the value of the API response, and all props passed into ServerSideRenderer.

  • Type: Component
  • Required: No

Top ↑

LoadingResponsePlaceholder

The component is rendered while the API request is being processed (loading state). The component will receive the value of the API response, and all props passed into ServerSideRenderer.

  • Type: Component
  • Required: No

Top ↑

Example usage

const MyServerSideRender = () => (
    <ServerSideRender LoadingResponsePlaceholder={ MyAmazingPlaceholder } />
);

Top ↑

Usage

Render core/archives preview.

import ServerSideRender from '@wordpress/server-side-render';

const MyServerSideRender = () => (
    <ServerSideRender
        block="core/archives"
        attributes={ {
            showPostCounts: true,
            displayAsDropdown: false,
        } }
    />
);

If imported from the wp global, an alias is required to work in JSX.

const { serverSideRender: ServerSideRender } = wp;

const MyServerSideRender = () => (
    <ServerSideRender
        block="core/archives"
        attributes={ {
            showPostCounts: true,
            displayAsDropdown: false,
        } }
    />
);

Top ↑

Output

Output uses the block’s render_callback function, set when defining the block.

Top ↑

API Endpoint

The API endpoint for getting the output for ServerSideRender is /wp/v2/block-renderer/:block. It will use the block’s render_callback method.

If you pass attributes to ServerSideRender, the block must also be registered and have its attributes defined in PHP.

register_block_type(
    'core/archives',
    array(
        'api_version' => 2,
        'attributes'      => array(
            'showPostCounts'    => array(
                'type'      => 'boolean',
                'default'   => false,
            ),
            'displayAsDropdown' => array(
                'type'      => 'boolean',
                'default'   => false,
            ),
        ),
        'render_callback' => 'render_block_core_archives',
    )
);

Top ↑

Contributing to this package

This is an individual package that’s part of the Gutenberg project. The project is organized as a monorepo. It’s made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to npm and used by WordPress as well as other software projects.

To find out more about contributing to this package or Gutenberg as a whole, please read the project’s main contributor guide.