WordPress multisite Used to describe a WordPress installation with a network of multiple blogs, grouped by sites. This installation type has shared users tables, and creates separate database tables for each blog (wp_posts becomes wp_0_posts). See also network, blog, site introduces a new database table to store metadata associated with sites. This allows for the storage of arbitrary site data relevant in a multisite / network (versus site, blog) context.
Site metadata provides an alternative to using options and can be retrieved from multiple sites in a more performant way—without calling
switch_to_blog(). Sites can now also be queried by their meta Meta is a term that refers to the inside workings of a group. For us, this is the team that works on internal WordPress sites like WordCamp Central and Make WordPress. with parameters supported by
wp_blogmeta table is a global table in WordPress and developers should be cautious not to overuse it. There is a trade-off between using site options and site metadata, so it is recommended to think about every piece of extra data associated with a site and how it should be stored.
- Use options when the data concerns only the site itself. Using an option should continue to be the default approach for site data.
- Use site metadata when the data also needs to be heavily used in the network context, especially when sites need to be queried by it.
A network update is required to install the new database table. The site meta API An API or Application Programming Interface is a software intermediary that allows programs to interact with each other and share data in limited, clearly defined ways. includes a function
is_site_meta_supported() to ensure no unexpected errors occur when that process has not run yet. As of WordPress 5.1, there is only a single use-case for the site meta in core Core is the set of software required to run WordPress. The Core Development Team builds WordPress. which regards the fatal error protection mechanism (see #44458).
This is how the API can be used:
get_site_meta( $id, $meta_key, $single )
update_site_meta( $id, $meta_key, $meta_value, $prev_value )
add_site_meta( $id, $meta_key, $meta_value, $unique )
delete_site_meta( $id, $meta_key, $meta_value )
All of these functions are only available in multisite, however they work similarly to other metadata wrapper functions, such as for posts, terms, comments and users. In addition to these functions, it is now possible to use the common meta query arguments when querying sites with
WP_Site_Query or its wrapper
Note that the database table for site metadata is called
wp_blogmeta. This is because
wp_sitemeta is already used for another database table, and furthermore the new name works consistently alongside the related
wp_blogs table that stores the most essential site data. The API exposed and described here uses the correct term “site”.
For background information on these changes, see #37923 and #40229.
An additional under-the-hood change related to this is that the metadata API is now loaded earlier in the WordPress bootstrap process so that it is available as early as the multisite bootstrap code. See #40948 for more information.
Props @jeremyfelt for review.