mirror of
https://github.com/WordPress/WordPress.git
synced 2024-08-31 10:09:46 +02:00
Dynamic (non-explicitly declared) properties are deprecated as of PHP 8.2 and are expected to become a fatal error in PHP 9.0. There are a number of ways to mitigate this: * If it is an accidental typo for a declared property: fix the typo. * For known properties: declare them on the class. * For unknown properties: add the magic `__get()`, `__set()`, et al. methods to the class or let the class extend `stdClass` which has highly optimized versions of these magic methods built in. * For unknown ''use'' of dynamic properties, the `#[AllowDynamicProperties]` attribute can be added to the class. The attribute will automatically be inherited by child classes. Trac ticket #56034 is open to investigate and handle the third and fourth type of situations, however it has become clear this will need more time and will not be ready in time for WP 6.1. To reduce “noise” in the meantime, both in the error logs of WP users moving onto PHP 8.2, in the test run logs of WP itself, in test runs of plugins and themes, as well as to prevent duplicate tickets from being opened for the same issue, this commit adds the `#[AllowDynamicProperties]` attribute to all “parent” classes in WP. The logic used for this commit is as follows: * If a class already has the attribute: no action needed. * If a class does not `extend`: add the attribute. * If a class does `extend`: - If it extends `stdClass`: no action needed (as `stdClass` supports dynamic properties). - If it extends a PHP native class: add the attribute. - If it extends a class from one of WP's external dependencies: add the attribute. * In all other cases: no action — the attribute should not be needed as child classes inherit from the parent. Whether or not a class contains magic methods has not been taken into account, as a review of the currently existing magic methods has shown that those are generally not sturdy enough and often even set dynamic properties (which they should not). See the [https://www.youtube.com/watch?v=vDZWepDQQVE live stream from August 16, 2022] for more details. This commit only affects classes in the `src` directory of WordPress core. * Tests should not get this attribute, but should be fixed to not use dynamic properties instead. Patches for this are already being committed under ticket #56033. * While a number bundled themes (2014, 2019, 2020, 2021) contain classes, they are not a part of this commit and may be updated separately. Reference: [https://wiki.php.net/rfc/deprecate_dynamic_properties PHP RFC: Deprecate dynamic properties]. Follow-up to [53922]. Props jrf, hellofromTonya, markjaquith, peterwilsoncc, costdev, knutsp, aristath. See #56513, #56034. Built from https://develop.svn.wordpress.org/trunk@54133 git-svn-id: http://core.svn.wordpress.org/trunk@53692 1a063a9b-81f0-0310-95a4-ce76da25c4cd
354 lines
7.3 KiB
PHP
354 lines
7.3 KiB
PHP
<?php
|
|
/**
|
|
* Site API: WP_Site class
|
|
*
|
|
* @package WordPress
|
|
* @subpackage Multisite
|
|
* @since 4.5.0
|
|
*/
|
|
|
|
/**
|
|
* Core class used for interacting with a multisite site.
|
|
*
|
|
* This class is used during load to populate the `$current_blog` global and
|
|
* setup the current site.
|
|
*
|
|
* @since 4.5.0
|
|
*
|
|
* @property int $id
|
|
* @property int $network_id
|
|
* @property string $blogname
|
|
* @property string $siteurl
|
|
* @property int $post_count
|
|
* @property string $home
|
|
*/
|
|
#[AllowDynamicProperties]
|
|
final class WP_Site {
|
|
|
|
/**
|
|
* Site ID.
|
|
*
|
|
* Named "blog" vs. "site" for legacy reasons.
|
|
*
|
|
* A numeric string, for compatibility reasons.
|
|
*
|
|
* @since 4.5.0
|
|
* @var string
|
|
*/
|
|
public $blog_id;
|
|
|
|
/**
|
|
* Domain of the site.
|
|
*
|
|
* @since 4.5.0
|
|
* @var string
|
|
*/
|
|
public $domain = '';
|
|
|
|
/**
|
|
* Path of the site.
|
|
*
|
|
* @since 4.5.0
|
|
* @var string
|
|
*/
|
|
public $path = '';
|
|
|
|
/**
|
|
* The ID of the site's parent network.
|
|
*
|
|
* Named "site" vs. "network" for legacy reasons. An individual site's "site" is
|
|
* its network.
|
|
*
|
|
* A numeric string, for compatibility reasons.
|
|
*
|
|
* @since 4.5.0
|
|
* @var string
|
|
*/
|
|
public $site_id = '0';
|
|
|
|
/**
|
|
* The date and time on which the site was created or registered.
|
|
*
|
|
* @since 4.5.0
|
|
* @var string Date in MySQL's datetime format.
|
|
*/
|
|
public $registered = '0000-00-00 00:00:00';
|
|
|
|
/**
|
|
* The date and time on which site settings were last updated.
|
|
*
|
|
* @since 4.5.0
|
|
* @var string Date in MySQL's datetime format.
|
|
*/
|
|
public $last_updated = '0000-00-00 00:00:00';
|
|
|
|
/**
|
|
* Whether the site should be treated as public.
|
|
*
|
|
* A numeric string, for compatibility reasons.
|
|
*
|
|
* @since 4.5.0
|
|
* @var string
|
|
*/
|
|
public $public = '1';
|
|
|
|
/**
|
|
* Whether the site should be treated as archived.
|
|
*
|
|
* A numeric string, for compatibility reasons.
|
|
*
|
|
* @since 4.5.0
|
|
* @var string
|
|
*/
|
|
public $archived = '0';
|
|
|
|
/**
|
|
* Whether the site should be treated as mature.
|
|
*
|
|
* Handling for this does not exist throughout WordPress core, but custom
|
|
* implementations exist that require the property to be present.
|
|
*
|
|
* A numeric string, for compatibility reasons.
|
|
*
|
|
* @since 4.5.0
|
|
* @var string
|
|
*/
|
|
public $mature = '0';
|
|
|
|
/**
|
|
* Whether the site should be treated as spam.
|
|
*
|
|
* A numeric string, for compatibility reasons.
|
|
*
|
|
* @since 4.5.0
|
|
* @var string
|
|
*/
|
|
public $spam = '0';
|
|
|
|
/**
|
|
* Whether the site should be treated as deleted.
|
|
*
|
|
* A numeric string, for compatibility reasons.
|
|
*
|
|
* @since 4.5.0
|
|
* @var string
|
|
*/
|
|
public $deleted = '0';
|
|
|
|
/**
|
|
* The language pack associated with this site.
|
|
*
|
|
* A numeric string, for compatibility reasons.
|
|
*
|
|
* @since 4.5.0
|
|
* @var string
|
|
*/
|
|
public $lang_id = '0';
|
|
|
|
/**
|
|
* Retrieves a site from the database by its ID.
|
|
*
|
|
* @since 4.5.0
|
|
*
|
|
* @global wpdb $wpdb WordPress database abstraction object.
|
|
*
|
|
* @param int $site_id The ID of the site to retrieve.
|
|
* @return WP_Site|false The site's object if found. False if not.
|
|
*/
|
|
public static function get_instance( $site_id ) {
|
|
global $wpdb;
|
|
|
|
$site_id = (int) $site_id;
|
|
if ( ! $site_id ) {
|
|
return false;
|
|
}
|
|
|
|
$_site = wp_cache_get( $site_id, 'sites' );
|
|
|
|
if ( false === $_site ) {
|
|
$_site = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$wpdb->blogs} WHERE blog_id = %d LIMIT 1", $site_id ) );
|
|
|
|
if ( empty( $_site ) || is_wp_error( $_site ) ) {
|
|
$_site = -1;
|
|
}
|
|
|
|
wp_cache_add( $site_id, $_site, 'sites' );
|
|
}
|
|
|
|
if ( is_numeric( $_site ) ) {
|
|
return false;
|
|
}
|
|
|
|
return new WP_Site( $_site );
|
|
}
|
|
|
|
/**
|
|
* Creates a new WP_Site object.
|
|
*
|
|
* Will populate object properties from the object provided and assign other
|
|
* default properties based on that information.
|
|
*
|
|
* @since 4.5.0
|
|
*
|
|
* @param WP_Site|object $site A site object.
|
|
*/
|
|
public function __construct( $site ) {
|
|
foreach ( get_object_vars( $site ) as $key => $value ) {
|
|
$this->$key = $value;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Converts an object to array.
|
|
*
|
|
* @since 4.6.0
|
|
*
|
|
* @return array Object as array.
|
|
*/
|
|
public function to_array() {
|
|
return get_object_vars( $this );
|
|
}
|
|
|
|
/**
|
|
* Getter.
|
|
*
|
|
* Allows current multisite naming conventions when getting properties.
|
|
* Allows access to extended site properties.
|
|
*
|
|
* @since 4.6.0
|
|
*
|
|
* @param string $key Property to get.
|
|
* @return mixed Value of the property. Null if not available.
|
|
*/
|
|
public function __get( $key ) {
|
|
switch ( $key ) {
|
|
case 'id':
|
|
return (int) $this->blog_id;
|
|
case 'network_id':
|
|
return (int) $this->site_id;
|
|
case 'blogname':
|
|
case 'siteurl':
|
|
case 'post_count':
|
|
case 'home':
|
|
default: // Custom properties added by 'site_details' filter.
|
|
if ( ! did_action( 'ms_loaded' ) ) {
|
|
return null;
|
|
}
|
|
|
|
$details = $this->get_details();
|
|
if ( isset( $details->$key ) ) {
|
|
return $details->$key;
|
|
}
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Isset-er.
|
|
*
|
|
* Allows current multisite naming conventions when checking for properties.
|
|
* Checks for extended site properties.
|
|
*
|
|
* @since 4.6.0
|
|
*
|
|
* @param string $key Property to check if set.
|
|
* @return bool Whether the property is set.
|
|
*/
|
|
public function __isset( $key ) {
|
|
switch ( $key ) {
|
|
case 'id':
|
|
case 'network_id':
|
|
return true;
|
|
case 'blogname':
|
|
case 'siteurl':
|
|
case 'post_count':
|
|
case 'home':
|
|
if ( ! did_action( 'ms_loaded' ) ) {
|
|
return false;
|
|
}
|
|
return true;
|
|
default: // Custom properties added by 'site_details' filter.
|
|
if ( ! did_action( 'ms_loaded' ) ) {
|
|
return false;
|
|
}
|
|
|
|
$details = $this->get_details();
|
|
if ( isset( $details->$key ) ) {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Setter.
|
|
*
|
|
* Allows current multisite naming conventions while setting properties.
|
|
*
|
|
* @since 4.6.0
|
|
*
|
|
* @param string $key Property to set.
|
|
* @param mixed $value Value to assign to the property.
|
|
*/
|
|
public function __set( $key, $value ) {
|
|
switch ( $key ) {
|
|
case 'id':
|
|
$this->blog_id = (string) $value;
|
|
break;
|
|
case 'network_id':
|
|
$this->site_id = (string) $value;
|
|
break;
|
|
default:
|
|
$this->$key = $value;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Retrieves the details for this site.
|
|
*
|
|
* This method is used internally to lazy-load the extended properties of a site.
|
|
*
|
|
* @since 4.6.0
|
|
*
|
|
* @see WP_Site::__get()
|
|
*
|
|
* @return stdClass A raw site object with all details included.
|
|
*/
|
|
private function get_details() {
|
|
$details = wp_cache_get( $this->blog_id, 'site-details' );
|
|
|
|
if ( false === $details ) {
|
|
|
|
switch_to_blog( $this->blog_id );
|
|
// Create a raw copy of the object for backward compatibility with the filter below.
|
|
$details = new stdClass();
|
|
foreach ( get_object_vars( $this ) as $key => $value ) {
|
|
$details->$key = $value;
|
|
}
|
|
$details->blogname = get_option( 'blogname' );
|
|
$details->siteurl = get_option( 'siteurl' );
|
|
$details->post_count = get_option( 'post_count' );
|
|
$details->home = get_option( 'home' );
|
|
restore_current_blog();
|
|
|
|
wp_cache_set( $this->blog_id, $details, 'site-details' );
|
|
}
|
|
|
|
/** This filter is documented in wp-includes/ms-blogs.php */
|
|
$details = apply_filters_deprecated( 'blog_details', array( $details ), '4.7.0', 'site_details' );
|
|
|
|
/**
|
|
* Filters a site's extended properties.
|
|
*
|
|
* @since 4.6.0
|
|
*
|
|
* @param stdClass $details The site details.
|
|
*/
|
|
$details = apply_filters( 'site_details', $details );
|
|
|
|
return $details;
|
|
}
|
|
}
|