mirror of
https://github.com/WordPress/WordPress.git
synced 2024-08-23 22:34:27 +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
176 lines
4.5 KiB
PHP
176 lines
4.5 KiB
PHP
<?php
|
|
/**
|
|
* Administration API: WP_Internal_Pointers class
|
|
*
|
|
* @package WordPress
|
|
* @subpackage Administration
|
|
* @since 4.4.0
|
|
*/
|
|
|
|
/**
|
|
* Core class used to implement an internal admin pointers API.
|
|
*
|
|
* @since 3.3.0
|
|
*/
|
|
#[AllowDynamicProperties]
|
|
final class WP_Internal_Pointers {
|
|
/**
|
|
* Initializes the new feature pointers.
|
|
*
|
|
* @since 3.3.0
|
|
*
|
|
* All pointers can be disabled using the following:
|
|
* remove_action( 'admin_enqueue_scripts', array( 'WP_Internal_Pointers', 'enqueue_scripts' ) );
|
|
*
|
|
* Individual pointers (e.g. wp390_widgets) can be disabled using the following:
|
|
*
|
|
* function yourprefix_remove_pointers() {
|
|
* remove_action(
|
|
* 'admin_print_footer_scripts',
|
|
* array( 'WP_Internal_Pointers', 'pointer_wp390_widgets' )
|
|
* );
|
|
* }
|
|
* add_action( 'admin_enqueue_scripts', 'yourprefix_remove_pointers', 11 );
|
|
*
|
|
* @param string $hook_suffix The current admin page.
|
|
*/
|
|
public static function enqueue_scripts( $hook_suffix ) {
|
|
/*
|
|
* Register feature pointers
|
|
*
|
|
* Format:
|
|
* array(
|
|
* hook_suffix => pointer callback
|
|
* )
|
|
*
|
|
* Example:
|
|
* array(
|
|
* 'themes.php' => 'wp390_widgets'
|
|
* )
|
|
*/
|
|
$registered_pointers = array(
|
|
// None currently.
|
|
);
|
|
|
|
// Check if screen related pointer is registered.
|
|
if ( empty( $registered_pointers[ $hook_suffix ] ) ) {
|
|
return;
|
|
}
|
|
|
|
$pointers = (array) $registered_pointers[ $hook_suffix ];
|
|
|
|
/*
|
|
* Specify required capabilities for feature pointers
|
|
*
|
|
* Format:
|
|
* array(
|
|
* pointer callback => Array of required capabilities
|
|
* )
|
|
*
|
|
* Example:
|
|
* array(
|
|
* 'wp390_widgets' => array( 'edit_theme_options' )
|
|
* )
|
|
*/
|
|
$caps_required = array(
|
|
// None currently.
|
|
);
|
|
|
|
// Get dismissed pointers.
|
|
$dismissed = explode( ',', (string) get_user_meta( get_current_user_id(), 'dismissed_wp_pointers', true ) );
|
|
|
|
$got_pointers = false;
|
|
foreach ( array_diff( $pointers, $dismissed ) as $pointer ) {
|
|
if ( isset( $caps_required[ $pointer ] ) ) {
|
|
foreach ( $caps_required[ $pointer ] as $cap ) {
|
|
if ( ! current_user_can( $cap ) ) {
|
|
continue 2;
|
|
}
|
|
}
|
|
}
|
|
|
|
// Bind pointer print function.
|
|
add_action( 'admin_print_footer_scripts', array( 'WP_Internal_Pointers', 'pointer_' . $pointer ) );
|
|
$got_pointers = true;
|
|
}
|
|
|
|
if ( ! $got_pointers ) {
|
|
return;
|
|
}
|
|
|
|
// Add pointers script and style to queue.
|
|
wp_enqueue_style( 'wp-pointer' );
|
|
wp_enqueue_script( 'wp-pointer' );
|
|
}
|
|
|
|
/**
|
|
* Print the pointer JavaScript data.
|
|
*
|
|
* @since 3.3.0
|
|
*
|
|
* @param string $pointer_id The pointer ID.
|
|
* @param string $selector The HTML elements, on which the pointer should be attached.
|
|
* @param array $args Arguments to be passed to the pointer JS (see wp-pointer.js).
|
|
*/
|
|
private static function print_js( $pointer_id, $selector, $args ) {
|
|
if ( empty( $pointer_id ) || empty( $selector ) || empty( $args ) || empty( $args['content'] ) ) {
|
|
return;
|
|
}
|
|
|
|
?>
|
|
<script type="text/javascript">
|
|
(function($){
|
|
var options = <?php echo wp_json_encode( $args ); ?>, setup;
|
|
|
|
if ( ! options )
|
|
return;
|
|
|
|
options = $.extend( options, {
|
|
close: function() {
|
|
$.post( ajaxurl, {
|
|
pointer: '<?php echo $pointer_id; ?>',
|
|
action: 'dismiss-wp-pointer'
|
|
});
|
|
}
|
|
});
|
|
|
|
setup = function() {
|
|
$('<?php echo $selector; ?>').first().pointer( options ).pointer('open');
|
|
};
|
|
|
|
if ( options.position && options.position.defer_loading )
|
|
$(window).bind( 'load.wp-pointers', setup );
|
|
else
|
|
$( function() {
|
|
setup();
|
|
} );
|
|
|
|
})( jQuery );
|
|
</script>
|
|
<?php
|
|
}
|
|
|
|
public static function pointer_wp330_toolbar() {}
|
|
public static function pointer_wp330_media_uploader() {}
|
|
public static function pointer_wp330_saving_widgets() {}
|
|
public static function pointer_wp340_customize_current_theme_link() {}
|
|
public static function pointer_wp340_choose_image_from_library() {}
|
|
public static function pointer_wp350_media() {}
|
|
public static function pointer_wp360_revisions() {}
|
|
public static function pointer_wp360_locks() {}
|
|
public static function pointer_wp390_widgets() {}
|
|
public static function pointer_wp410_dfw() {}
|
|
public static function pointer_wp496_privacy() {}
|
|
|
|
/**
|
|
* Prevents new users from seeing existing 'new feature' pointers.
|
|
*
|
|
* @since 3.3.0
|
|
*
|
|
* @param int $user_id User ID.
|
|
*/
|
|
public static function dismiss_pointers_for_new_users( $user_id ) {
|
|
add_user_meta( $user_id, 'dismissed_wp_pointers', '' );
|
|
}
|
|
}
|