WordPress/wp-includes/customize
Sergey Biryukov c03305852e Code Modernization: Add `AllowDynamicProperties` attribute to all (parent) classes.
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
2022-09-12 15:47:14 +00:00
..
class-wp-customize-background-image-control.php Docs: Add missing documentation for some Customize class properties: 2022-05-18 15:24:14 +00:00
class-wp-customize-background-image-setting.php Docs: Add missing documentation for some Customize class properties: 2022-05-18 15:24:14 +00:00
class-wp-customize-background-position-control.php Customize: Hide native control on background position field. 2021-08-19 02:07:56 +00:00
class-wp-customize-code-editor-control.php Docs: Consistently include an empty line between `@since` tag and `@see`, `@link`, or `@global`, per the documentation standards. 2020-06-16 21:07:14 +00:00
class-wp-customize-color-control.php Docs: Add a `@see` reference to `WP_Customize_Control::__construct()` in child class constructors. 2020-02-26 13:30:08 +00:00
class-wp-customize-cropped-image-control.php
class-wp-customize-custom-css-setting.php Code Modernization: Fix parameter name mismatch with parent in `WP_Customize_Custom_CSS_Setting::validate()`. 2021-09-09 15:18:55 +00:00
class-wp-customize-date-time-control.php Docs: Update some `@var` tags per the documentation standards. 2021-12-11 19:50:59 +00:00
class-wp-customize-filter-setting.php
class-wp-customize-header-image-control.php Docs: Add missing documentation for some Customize class properties: 2022-05-18 15:24:14 +00:00
class-wp-customize-header-image-setting.php Docs: Add missing documentation for some Customize class properties: 2022-05-18 15:24:14 +00:00
class-wp-customize-image-control.php Docs: Add documentation for the `$type` and `$mime_type` properties in `WP_Customize_Image_Control`. 2020-11-22 15:53:03 +00:00
class-wp-customize-media-control.php Images: enable WebP support. 2021-05-04 14:44:58 +00:00
class-wp-customize-nav-menu-auto-add-control.php
class-wp-customize-nav-menu-control.php Administration: Replace contracted verb forms for better consistency. 2022-03-22 16:25:03 +00:00
class-wp-customize-nav-menu-item-control.php Administration: Replace "Current theme" with "Active theme" in user facing strings. 2022-01-15 08:44:03 +00:00
class-wp-customize-nav-menu-item-setting.php General: Replace all `esc_url_raw()` calls in core with `sanitize_url()`. 2022-06-01 18:14:10 +00:00
class-wp-customize-nav-menu-location-control.php
class-wp-customize-nav-menu-locations-control.php Administration: Replace contracted verb forms for better consistency. 2022-03-22 16:25:03 +00:00
class-wp-customize-nav-menu-name-control.php
class-wp-customize-nav-menu-section.php General: Replace older-style PHP type conversion functions with type casts. 2020-10-08 21:15:13 +00:00
class-wp-customize-nav-menu-setting.php Docs: Fix typos in some DocBlocks. 2022-01-18 20:29:06 +00:00
class-wp-customize-nav-menus-panel.php Customizer: Remove Menus panel when a theme does not support menus 2022-01-24 05:34:04 +00:00
class-wp-customize-new-menu-control.php Docs: Add a `@see` reference to `WP_Customize_Control::__construct()` in child class constructors. 2020-02-26 13:30:08 +00:00
class-wp-customize-new-menu-section.php Docs: Use a consistent description for the `$manager` parameter in various Customizer class constructions. 2020-02-26 15:33:05 +00:00
class-wp-customize-partial.php Code Modernization: Add `AllowDynamicProperties` attribute to all (parent) classes. 2022-09-12 15:47:14 +00:00
class-wp-customize-selective-refresh.php Code Modernization: Add `AllowDynamicProperties` attribute to all (parent) classes. 2022-09-12 15:47:14 +00:00
class-wp-customize-sidebar-section.php
class-wp-customize-site-icon-control.php Coding Standards: Add a space before `/` character in some self-closing HTML tags. 2021-03-20 18:30:08 +00:00
class-wp-customize-theme-control.php Administration: Replace contracted verb forms for better consistency. 2022-03-22 16:25:03 +00:00
class-wp-customize-themes-panel.php Docs: Replace "Current theme" with "Active theme" in various DocBlocks. 2022-01-20 23:53:05 +00:00
class-wp-customize-themes-section.php Text Changes: Unify various "Back to..." vs. "Return to..." vs. "Go to..." strings. 2020-11-09 10:53:10 +00:00
class-wp-customize-upload-control.php Docs: Add documentation for the `$type`, `$mime_type`, and `$button_labels` properties in `WP_Customize_Upload_Control`. 2020-11-22 15:51:03 +00:00
class-wp-sidebar-block-editor-control.php Adds the widgets block editor to widgets.php and customize.php 2021-05-25 08:52:58 +00:00
class-wp-widget-area-customize-control.php Docs: Correct `@since` tag for the `class-wp-widget-area-customize-control.php` file. 2020-11-22 15:12:03 +00:00
class-wp-widget-form-customize-control.php