Speculative Loading

Descrição

This plugin adds support for the Speculation Rules API, which allows defining rules by which certain URLs are dynamically prefetched or prerendered based on user interaction.

See the Speculation Rules WICG specification draft.

By default, the plugin is configured to prerender WordPress frontend URLs when the user hovers over a relevant link. This can be customized via the “Speculative Loading” section under Settings > Reading.

A filter can be used to exclude certain URL paths from being eligible for prefetching and prerendering (see FAQ section). Alternatively, you can add the ‘no-prerender’ CSS class to any link (<a> tag) that should not be prerendered. See FAQ for more information.

Browser support

The Speculation Rules API is a new web API, and the functionality used by the plugin is supported in Chromium-based browsers such as Chrome, Edge, or Opera using version 121 or above. Other browsers such as Safari and Firefox will ignore the functionality with no ill effects but will not benefit from the speculative loading. Note that extensions may disable preloading by default (for example, uBlock Origin does this).

Other browsers will not see any adverse effects, however the feature will not work for those clients.

Este plugin era anteriormente conhecido como Speculation Rules.

Instalação

Installation from within WordPress

  1. Visit Plugins > Add New.
  2. Search for Speculative Loading.
  3. Install and activate the Speculative Loading plugin.

Manual installation

  1. Upload the entire speculation-rules folder to the /wp-content/plugins/ directory.
  2. Visit Plugins.
  3. Activate the Speculative Loading plugin.

Perguntas frequentes

How can I prevent certain URLs from being prefetched and prerendered?

Not every URL can be reasonably prerendered. Prerendering static content is typically reliable, however prerendering interactive content, such as a logout URL, can lead to issues. For this reason, certain WordPress core URLs such as /wp-login.php and /wp-admin/* are excluded from prefetching and prerendering. Additionally, any URL generated with wp_nonce_url() (or which contain the _wpnonce query var) is also ignored. You can exclude additional URL patterns by using the plsr_speculation_rules_href_exclude_paths filter.

Este exemplo garantiria que URL como https://example.com/cart/ ou https://example.com/cart/foo seriam excluídos da pré-obtenção e da pré-renderização.

<?php

add_filter(
    'plsr_speculation_rules_href_exclude_paths',
    function ( array $exclude_paths ): array {
        $exclude_paths[] = '/cart/*';
        return $exclude_paths;
    }
);

Lembre-se de que, às vezes, pode ser útil excluir um URL da pré-renderização e, ao mesmo tempo, permitir que ele seja pré-obtido. Por exemplo, uma página com JavaScript do lado do cliente para actualizar o estado do utilizador provavelmente não deve ser pré-renderizada, mas seria razoável fazer a pré-obtenção.

Para este efeito, o filtro plsr_speculation_rules_href_exclude_paths recebe o modo actual (ou “prefetch” ou “prerender”) para fornecer exclusões condicionais.

O exemplo a seguir garantiria que URL como https://example.com/products/... não podem ser pré-renderizados, enquanto ainda permite que eles sejam pré-obtidos.

<?php

add_filter(
    'plsr_speculation_rules_href_exclude_paths',
    function ( array $exclude_paths, string $mode ): array {
        if ( 'prerender' === $mode ) {
            $exclude_paths[] = '/products/*';
        }
        return $exclude_paths;
    },
    10,
    2
);

As mentioned above, adding the no-prerender CSS class to a link will prevent it from being prerendered (but not prefetched). Additionally, links with rel=nofollow will neither be prefetched nor prerendered because some plugins add this to non-idempotent links (e.g. add to cart); such links ideally should rather be buttons which trigger a POST request or at least they should use wp_nonce_url().

How will this impact analytics and personalization?

Prerendering can affect analytics and personalization.

For client-side JavaScript, is recommended to delay these until the page clicks and some solutions (like Google Analytics) already do this automatically for prerender. See Impact on Analytics. Additionally, cross-origin iframes are not loaded until activation which can further avoid issues here.

Speculating on hover (moderate) increases the chance the page will be loaded, over preloading without this signal, and thus reduces the risk here. Alternatively, the plugin offers to only speculate on mouse/pointer down (conservative) which further reduces the risk here and is an option for sites which are concerned about this, at the cost of having less of a lead time and so less of a performance gain.

A prerendered page is linked to the page that prerenders it, so personalisation may already be known by this point and changes (e.g. browsing other products, or logging in/out) may require a new page load, and hence a new prerender anyway, which will take these into account. But it definitely is something to be aware of and test!

Onde posso submeter os meus comentários sobre o plugin?

Os comentários são incentivados e muito apreciados, especialmente porque este plugin pode conter futuros recursos principais do WordPress. Se tiver sugestões ou pedidos de novas funcionalidades, pode submetê-las como um problema no repositório GitHub da equipa de Performance do WordPress. Se precisar de ajuda com a solução de problemas ou tiver uma pergunta sobre o plugin, crie um novo tópico no nosso fórum de suporte.

Onde posso comunicar erros de segurança?

A equipa de Performance e a comunidade WordPress levam os bugs de segurança a sério. Apreciamos os seus esforços para divulgar de forma responsável as suas descobertas e faremos todos os esforços para reconhecer as suas contribuições.

Para comunicar um problema de segurança, visite o programa WordPress HackerOne.

Como posso contribuir para o desenvolvimento do plugin?

As contribuições são sempre bem-vindas! Saiba mais sobre como participar no manual da equipa de Core Performance.

Avaliações

19 Julho, 2024 1 reply
I was using another plugin which does a similar job but Speculative Loading appears to be substantially quicker. Using on about 10 sites and no issues. Thank you
27 Maio, 2024
Es verkürzt die Ladzeit für einen Benutzer sichtbar, auch wenn im Hintergrund die Seite gleichschnell geladen wird, so fühlt es sich für einen Benutzer extrem schnell an.
8 Maio, 2024 1 reply
I’ve currently activated this plugin on five sites, some on one server, and then others on another. The plugin has yet to present any plugin conflicts or other issues. The time to load pages is drastically improved based on user intent, and based on this alone, I cannot recommend this plugin enough. I haven’t tested the sites with Lighthouse, but honestly, I don’t feel the need to do that, because it’s about the user experience first, and that is such an improvement with this plugin. Thank you!
Ler todas as 15 avaliações

Contribuidores e programadores

“Speculative Loading” é software de código aberto. As seguintes pessoas contribuíram para este plugin:

Contribuidores

“Speculative Loading” foi traduzido para 8 locales. Obrigado aos tradutores pelas suas contribuições.

Traduza o “Speculative Loading” para o seu idioma.

Interessado no desenvolvimento?

Consulte o código, consulte o repositório SVN, ou subscreva o registo de alterações por RSS.

Registo de alterações

1.3.1

Bug Fixes

  • Check if rel contains nofollow instead of being just nofollow when excluding speculative loading. (1232)

1.3.0

Enhancements

  • Prevent speculatively loading links to the uploads, content, plugins, template, or stylesheet directories. (1167)
  • Facilitate embedding Speculative Loading in other plugins/themes. (1159)
  • Improve overall code quality with stricter static analysis checks. (775)
  • Bump minimum PHP requirement to 7.2. (1130)

1.2.2

Bug Fixes

  • Fix composition of href exclude paths to account for JSON encoding and differing site/home URLs. (1164)

Documentation

  • Update readme with browser support and FAQ section about analytics and personalization. (1155)

1.2.1

Enhancements

  • Add settings link to Speculative Loading plugin action links. (1145)
  • Bump minimum PHP version to 7.2. (1130)

Bug Fixes

  • Exclude _wpnonce URLs in speculation rules. (1143)
  • Exclude rel=nofollow links from prefetch/prerender. (1142)

1.2.0

  • Add missing uninstall.php to remove plugin’s database option. (1128)

1.1.0

  • Allow excluding URL patterns from prerendering or prefetching specifically. (1025)
  • Rename plugin to “Speculative Loading”. (1101)
  • Add Speculative Loading generator tag. (1102)
  • Bump minimum required WP version to 6.4. (1062)
  • Update tested WordPress version to 6.5. (1027)

1.0.1

  • Escape path prefix and restrict it to be a pathname in Speculation Rules. (951)
  • Force HTML5 script theme support when printing JSON script. (952)
  • Add icon and banner assets for plugin directory. (987)

1.0.0

  • Initial release of the Speculative Loading plugin as a standalone plugin. (733)