Skip to content

Internalize global_terms_enabled() #5684

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
schlessera merged 3 commits into from
Oct 12, 2022
Merged

Internalize global_terms_enabled() #5684

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8ce46a8
Internalize global_terms_enabled()
schlessera Oct 12, 2022
f222821
Move site_categories table test into separate conditional scenario
schlessera Oct 12, 2022
27175c7
Add missing enable_sitecategories.php file to tests
schlessera Oct 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 43 additions & 1 deletion features/utils-wp.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -748,13 +748,55 @@ Feature: Utilities that depend on WordPress code
wp_posts
"""

Given an enable_sitecategories.php file:
@less-than-wp-6.1
Scenario: Get WP table names for multisite install (site_categories only)
Given a WP multisite install
And I run `wp db query "CREATE TABLE xx_wp_posts ( id int );"`
And I run `wp db query "CREATE TABLE xx_wp_2_posts ( id int );"`
And I run `wp db query "CREATE TABLE wp_xx_posts ( id int );"`
And I run `wp db query "CREATE TABLE wp_2_xx_posts ( id int );"`
And I run `wp db query "CREATE TABLE wp_posts_xx ( id int );"`
And I run `wp db query "CREATE TABLE wp_2_posts_xx ( id int );"`
And I run `wp db query "CREATE TABLE wp_categories ( id int );"`
And I run `wp db query "CREATE TABLE wp_sitecategories ( id int );"`
And a table_names.php file:
"""
<?php
/**
* Test WP get table names.
*
* ## OPTIONS
*
* [<table>...]
* : List tables based on wildcard search, e.g. 'wp_*_options' or 'wp_post?'.
*
* [--scope=<scope>]
* : Can be all, global, ms_global, blog, or old tables. Defaults to all.
*
* [--network]
* : List all the tables in a multisite installation. Overrides --scope=<scope>.
*
* [--all-tables-with-prefix]
* : List all tables that match the table prefix even if not registered on $wpdb. Overrides --network.
*
* [--all-tables]
* : List all tables in the database, regardless of the prefix, and even if not registered on $wpdb. Overrides --all-tables-with-prefix.
*/
function test_wp_get_table_names( $args, $assoc_args ) {
if ( $tables = WP_CLI\Utils\wp_get_table_names( $args, $assoc_args ) ) {
echo implode( PHP_EOL, $tables ) . PHP_EOL;
}
}
WP_CLI::add_command( 'get_table_names', 'test_wp_get_table_names' );
"""
And an enable_sitecategories.php file:
"""
<?php
WP_CLI::add_hook( 'after_wp_load', function () {
add_filter( 'global_terms_enabled', '__return_true' );
} );
"""

When I run `wp --require=table_names.php --require=enable_sitecategories.php get_table_names`
# Leave out wp_blog_versions as it was never used and is removed with WP 5.3+.
# Leave out wp_blogmeta for old WP compat.
Expand Down
36 changes: 36 additions & 0 deletions php/utils-wp.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -480,3 +480,39 @@ function strip_tags( $string ) {

return trim( $string );
}

/**
* Internalized version of global_terms_enabled() to get around a bug in WordPress Core.
*
* WP Core inadvertently removed the function instead of deprecating it during th 6.1 cycle.
*
* @see https://core.trac.wordpress.org/ticket/21734#comment:34
*/
function global_terms_enabled() {
if ( ! is_multisite() ) {
return false;
}

static $global_terms = null;
if ( is_null( $global_terms ) ) {

/**
* Filters whether global terms are enabled.
*
* Returning a non-null value from the filter will effectively short-circuit the function
* and return the value of the 'global_terms_enabled' site option instead.
*
* @since 3.0.0
*
* @param null $enabled Whether global terms are enabled.
*/
$filter = apply_filters( 'global_terms_enabled', null ); // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound
if ( ! is_null( $filter ) ) {
$global_terms = (bool) $filter;
} else {
$global_terms = (bool) get_site_option( 'global_terms_enabled', false );
}
}

return $global_terms;
}