2010-08-11 17:54:51 -04:00
|
|
|
<?php
|
2015-10-17 02:07:24 -04:00
|
|
|
/**
|
|
|
|
* Administration API: WP_List_Table class
|
|
|
|
*
|
|
|
|
* @package WordPress
|
|
|
|
* @subpackage List_Table
|
|
|
|
* @since 3.1.0
|
|
|
|
*/
|
|
|
|
|
2010-08-11 17:54:51 -04:00
|
|
|
/**
|
2010-10-25 00:04:18 -04:00
|
|
|
* Base class for displaying a list of items in an ajaxified HTML table.
|
2010-08-11 17:54:51 -04:00
|
|
|
*
|
|
|
|
* @since 3.1.0
|
|
|
|
*/
|
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 11:47:14 -04:00
|
|
|
#[AllowDynamicProperties]
|
2010-08-11 17:54:51 -04:00
|
|
|
class WP_List_Table {
|
|
|
|
|
|
|
|
/**
|
2015-10-10 23:34:26 -04:00
|
|
|
* The current list of items.
|
2010-08-11 17:54:51 -04:00
|
|
|
*
|
|
|
|
* @since 3.1.0
|
2015-10-10 23:34:26 -04:00
|
|
|
* @var array
|
2010-08-11 17:54:51 -04:00
|
|
|
*/
|
2014-08-06 22:51:16 -04:00
|
|
|
public $items;
|
2010-08-11 17:54:51 -04:00
|
|
|
|
|
|
|
/**
|
2015-10-10 23:34:26 -04:00
|
|
|
* Various information about the current table.
|
2010-08-11 17:54:51 -04:00
|
|
|
*
|
|
|
|
* @since 3.1.0
|
2015-10-10 23:34:26 -04:00
|
|
|
* @var array
|
2010-08-11 17:54:51 -04:00
|
|
|
*/
|
2014-12-20 18:27:25 -05:00
|
|
|
protected $_args;
|
2010-08-11 17:54:51 -04:00
|
|
|
|
|
|
|
/**
|
2015-10-10 23:34:26 -04:00
|
|
|
* Various information needed for displaying the pagination.
|
2010-08-11 17:54:51 -04:00
|
|
|
*
|
|
|
|
* @since 3.1.0
|
|
|
|
* @var array
|
|
|
|
*/
|
2015-01-12 11:26:21 -05:00
|
|
|
protected $_pagination_args = array();
|
2010-08-11 17:54:51 -04:00
|
|
|
|
|
|
|
/**
|
2015-10-10 23:34:26 -04:00
|
|
|
* The current screen.
|
2010-08-11 17:54:51 -04:00
|
|
|
*
|
|
|
|
* @since 3.1.0
|
2020-10-10 15:14:04 -04:00
|
|
|
* @var WP_Screen
|
2010-08-11 17:54:51 -04:00
|
|
|
*/
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
protected $screen;
|
2010-08-11 17:54:51 -04:00
|
|
|
|
|
|
|
/**
|
2015-10-10 23:34:26 -04:00
|
|
|
* Cached bulk actions.
|
2010-08-11 17:54:51 -04:00
|
|
|
*
|
|
|
|
* @since 3.1.0
|
2015-10-10 23:34:26 -04:00
|
|
|
* @var array
|
2010-08-11 17:54:51 -04:00
|
|
|
*/
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
private $_actions;
|
2010-08-11 17:54:51 -04:00
|
|
|
|
|
|
|
/**
|
2015-10-10 23:34:26 -04:00
|
|
|
* Cached pagination output.
|
2010-08-11 17:54:51 -04:00
|
|
|
*
|
|
|
|
* @since 3.1.0
|
2015-10-10 23:34:26 -04:00
|
|
|
* @var string
|
2010-08-11 17:54:51 -04:00
|
|
|
*/
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
private $_pagination;
|
2010-08-11 17:54:51 -04:00
|
|
|
|
2014-11-01 15:56:24 -04:00
|
|
|
/**
|
2014-11-28 06:22:23 -05:00
|
|
|
* The view switcher modes.
|
2014-11-01 15:56:24 -04:00
|
|
|
*
|
|
|
|
* @since 4.1.0
|
2015-10-10 23:34:26 -04:00
|
|
|
* @var array
|
2014-11-01 15:56:24 -04:00
|
|
|
*/
|
|
|
|
protected $modes = array();
|
|
|
|
|
2015-01-10 01:57:22 -05:00
|
|
|
/**
|
2015-10-10 23:34:26 -04:00
|
|
|
* Stores the value returned by ->get_column_info().
|
2015-01-10 01:57:22 -05:00
|
|
|
*
|
2015-10-10 23:34:26 -04:00
|
|
|
* @since 4.1.0
|
2015-01-10 01:57:22 -05:00
|
|
|
* @var array
|
|
|
|
*/
|
|
|
|
protected $_column_headers;
|
|
|
|
|
2015-10-10 23:34:26 -04:00
|
|
|
/**
|
|
|
|
* {@internal Missing Summary}
|
|
|
|
*
|
|
|
|
* @var array
|
|
|
|
*/
|
2015-01-11 17:20:22 -05:00
|
|
|
protected $compat_fields = array( '_args', '_pagination_args', 'screen', '_actions', '_pagination' );
|
|
|
|
|
2015-10-10 23:34:26 -04:00
|
|
|
/**
|
|
|
|
* {@internal Missing Summary}
|
|
|
|
*
|
|
|
|
* @var array
|
|
|
|
*/
|
2017-11-30 18:11:00 -05:00
|
|
|
protected $compat_methods = array(
|
|
|
|
'set_pagination_args',
|
|
|
|
'get_views',
|
|
|
|
'get_bulk_actions',
|
|
|
|
'bulk_actions',
|
|
|
|
'row_actions',
|
|
|
|
'months_dropdown',
|
|
|
|
'view_switcher',
|
|
|
|
'comments_bubble',
|
|
|
|
'get_items_per_page',
|
|
|
|
'pagination',
|
|
|
|
'get_sortable_columns',
|
|
|
|
'get_column_info',
|
|
|
|
'get_table_classes',
|
|
|
|
'display_tablenav',
|
|
|
|
'extra_tablenav',
|
|
|
|
'single_row_columns',
|
|
|
|
);
|
2015-01-11 17:20:22 -05:00
|
|
|
|
2010-08-11 17:54:51 -04:00
|
|
|
/**
|
2014-08-09 22:18:17 -04:00
|
|
|
* Constructor.
|
2010-08-11 17:54:51 -04:00
|
|
|
*
|
2014-08-09 22:18:17 -04:00
|
|
|
* The child class should call this constructor from its own constructor to override
|
|
|
|
* the default $args.
|
|
|
|
*
|
|
|
|
* @since 3.1.0
|
|
|
|
*
|
|
|
|
* @param array|string $args {
|
|
|
|
* Array or string of arguments.
|
|
|
|
*
|
|
|
|
* @type string $plural Plural value used for labels and the objects being listed.
|
|
|
|
* This affects things such as CSS class-names and nonces used
|
|
|
|
* in the list table, e.g. 'posts'. Default empty.
|
|
|
|
* @type string $singular Singular label for an object being listed, e.g. 'post'.
|
|
|
|
* Default empty
|
2016-07-09 20:51:30 -04:00
|
|
|
* @type bool $ajax Whether the list table supports Ajax. This includes loading
|
2014-08-09 22:18:17 -04:00
|
|
|
* and sorting data, for example. If true, the class will call
|
2016-05-02 00:00:28 -04:00
|
|
|
* the _js_vars() method in the footer to provide variables
|
2016-07-09 20:51:30 -04:00
|
|
|
* to any scripts handling Ajax events. Default false.
|
2014-08-09 22:18:17 -04:00
|
|
|
* @type string $screen String containing the hook name used to determine the current
|
|
|
|
* screen. If left null, the current screen will be automatically set.
|
|
|
|
* Default null.
|
|
|
|
* }
|
2014-09-04 11:23:16 -04:00
|
|
|
*/
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
public function __construct( $args = array() ) {
|
2017-11-30 18:11:00 -05:00
|
|
|
$args = wp_parse_args(
|
2018-08-16 21:51:36 -04:00
|
|
|
$args,
|
|
|
|
array(
|
2017-11-30 18:11:00 -05:00
|
|
|
'plural' => '',
|
|
|
|
'singular' => '',
|
|
|
|
'ajax' => false,
|
|
|
|
'screen' => null,
|
|
|
|
)
|
|
|
|
);
|
2010-08-11 17:54:51 -04:00
|
|
|
|
2012-09-19 08:43:31 -04:00
|
|
|
$this->screen = convert_to_screen( $args['screen'] );
|
2010-08-11 17:54:51 -04:00
|
|
|
|
2013-09-05 12:34:09 -04:00
|
|
|
add_filter( "manage_{$this->screen->id}_columns", array( $this, 'get_columns' ), 0 );
|
2010-09-24 09:35:06 -04:00
|
|
|
|
2017-11-30 18:11:00 -05:00
|
|
|
if ( ! $args['plural'] ) {
|
2012-09-19 08:43:31 -04:00
|
|
|
$args['plural'] = $this->screen->base;
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2010-08-11 17:54:51 -04:00
|
|
|
|
2017-11-30 18:11:00 -05:00
|
|
|
$args['plural'] = sanitize_key( $args['plural'] );
|
2011-10-19 19:51:06 -04:00
|
|
|
$args['singular'] = sanitize_key( $args['singular'] );
|
|
|
|
|
2010-08-11 17:54:51 -04:00
|
|
|
$this->_args = $args;
|
|
|
|
|
2011-01-21 16:17:12 -05:00
|
|
|
if ( $args['ajax'] ) {
|
|
|
|
// wp_enqueue_script( 'list-table' );
|
2013-09-05 12:34:09 -04:00
|
|
|
add_action( 'admin_footer', array( $this, '_js_vars' ) );
|
2011-01-21 16:17:12 -05:00
|
|
|
}
|
2014-11-01 15:56:24 -04:00
|
|
|
|
|
|
|
if ( empty( $this->modes ) ) {
|
|
|
|
$this->modes = array(
|
2020-07-12 07:36:04 -04:00
|
|
|
'list' => __( 'Compact view' ),
|
|
|
|
'excerpt' => __( 'Extended view' ),
|
2014-11-01 15:56:24 -04:00
|
|
|
);
|
|
|
|
}
|
2010-08-11 17:54:51 -04:00
|
|
|
}
|
|
|
|
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
/**
|
2023-06-14 02:34:27 -04:00
|
|
|
* Makes private properties readable for backward compatibility.
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
*
|
|
|
|
* @since 4.0.0
|
Code Modernization: Deprecate dynamic properties in WP_List_Table magic methods.
The unknown use of unknown dynamic property within the `WP_List_Table` property magic methods is now deprecated. A descriptive deprecation notice is provided to alert developers to declare the property on the child class extending `WP_List_Table`.
Changes in this commit:
* Adds a deprecation notice to the `__get()`, `__set()`, `__isset()`, `__unset()` magic methods, i.e. to alert and inform developers when attempting to get/set/isset/unset a dynamic property.
* Fixes `__get()` to explicitly returns `null` when attempting to get a dynamic property.
* Removes returning the value when setting a declared property, as (a) unnecessary and (b) `__set()` should return `void` [https://www.php.net/manual/en/language.oop5.overloading.php#object.set per the PHP handbook].
* Adds unit tests for happy and unhappy paths.
For backward compatibility, no changes are made to the internal declared properties listed in `$compat_fields` and accessed through the magic methods.
For example:
A child class uses a property named `$data` that is not declared / defined as a property on the child class. When getting its value, e.g. `$list_table->data`, the `WP_List_Table::__get()` magic method is invoked, the following deprecation notice thrown, and `null` returned:
>The property `data` is not defined. Setting a dynamic (undefined) property is deprecated since version 6.4.0! Instead, define the property on the class.
=== Why not remove the magic methods, remove the `$compat_fields` property, and restore the properties `public`?
tl;dr Backward compatibility.
Several plugins, one of which has over 5M installs, add a property to the `$compat_fields` array. Removing the property would cause an `Undefined property` `Warning` (PHP 8) | `Notice` (PHP 7) to be thrown. Removing the associated code would change the functionality.
=== Why not limit the deprecation for PHP versions >= 8.2?
tl;dr original design intent and inform
The magic methods and `$compat_fields` property were added for one purpose: to continue providing external access to internal properties declared on `WP_List_Table`. They were not intended to be used for dynamic properties.
Deprecating that unintended usage both alerts developers a change is needed in their child class and informs them what to change.
References:
* Dynamic (non-explicitly declared) properties are deprecated as of PHP 8.2 and are expected to become a fatal error in PHP 9.0.
* A [https://www.youtube.com/live/vDZWepDQQVE?feature=share&t=10097 live open public working session] where these changes were discussed and agreed to.
* [https://wiki.php.net/rfc/deprecate_dynamic_properties PHP RFC: Deprecate dynamic properties.]
Related to #14579, #22234, #30891.
Follow-up to [15491], [28493], [28521], [28524], [31146].
Props antonvlasenko, jrf, markjaquith, hellofromTonya, SergeyBiryukov, desrosj, peterwilsoncc, audrasjb, costdev, oglekler, jeffpaul.
Fixes #58896.
See #56034.
Built from https://develop.svn.wordpress.org/trunk@56349
git-svn-id: http://core.svn.wordpress.org/trunk@55861 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-08-02 14:37:21 -04:00
|
|
|
* @since 6.4.0 Getting a dynamic property is deprecated.
|
2014-07-13 19:55:16 -04:00
|
|
|
*
|
|
|
|
* @param string $name Property to get.
|
|
|
|
* @return mixed Property.
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
*/
|
|
|
|
public function __get( $name ) {
|
2020-04-04 23:02:11 -04:00
|
|
|
if ( in_array( $name, $this->compat_fields, true ) ) {
|
2015-01-11 17:20:22 -05:00
|
|
|
return $this->$name;
|
|
|
|
}
|
Code Modernization: Deprecate dynamic properties in WP_List_Table magic methods.
The unknown use of unknown dynamic property within the `WP_List_Table` property magic methods is now deprecated. A descriptive deprecation notice is provided to alert developers to declare the property on the child class extending `WP_List_Table`.
Changes in this commit:
* Adds a deprecation notice to the `__get()`, `__set()`, `__isset()`, `__unset()` magic methods, i.e. to alert and inform developers when attempting to get/set/isset/unset a dynamic property.
* Fixes `__get()` to explicitly returns `null` when attempting to get a dynamic property.
* Removes returning the value when setting a declared property, as (a) unnecessary and (b) `__set()` should return `void` [https://www.php.net/manual/en/language.oop5.overloading.php#object.set per the PHP handbook].
* Adds unit tests for happy and unhappy paths.
For backward compatibility, no changes are made to the internal declared properties listed in `$compat_fields` and accessed through the magic methods.
For example:
A child class uses a property named `$data` that is not declared / defined as a property on the child class. When getting its value, e.g. `$list_table->data`, the `WP_List_Table::__get()` magic method is invoked, the following deprecation notice thrown, and `null` returned:
>The property `data` is not defined. Setting a dynamic (undefined) property is deprecated since version 6.4.0! Instead, define the property on the class.
=== Why not remove the magic methods, remove the `$compat_fields` property, and restore the properties `public`?
tl;dr Backward compatibility.
Several plugins, one of which has over 5M installs, add a property to the `$compat_fields` array. Removing the property would cause an `Undefined property` `Warning` (PHP 8) | `Notice` (PHP 7) to be thrown. Removing the associated code would change the functionality.
=== Why not limit the deprecation for PHP versions >= 8.2?
tl;dr original design intent and inform
The magic methods and `$compat_fields` property were added for one purpose: to continue providing external access to internal properties declared on `WP_List_Table`. They were not intended to be used for dynamic properties.
Deprecating that unintended usage both alerts developers a change is needed in their child class and informs them what to change.
References:
* Dynamic (non-explicitly declared) properties are deprecated as of PHP 8.2 and are expected to become a fatal error in PHP 9.0.
* A [https://www.youtube.com/live/vDZWepDQQVE?feature=share&t=10097 live open public working session] where these changes were discussed and agreed to.
* [https://wiki.php.net/rfc/deprecate_dynamic_properties PHP RFC: Deprecate dynamic properties.]
Related to #14579, #22234, #30891.
Follow-up to [15491], [28493], [28521], [28524], [31146].
Props antonvlasenko, jrf, markjaquith, hellofromTonya, SergeyBiryukov, desrosj, peterwilsoncc, audrasjb, costdev, oglekler, jeffpaul.
Fixes #58896.
See #56034.
Built from https://develop.svn.wordpress.org/trunk@56349
git-svn-id: http://core.svn.wordpress.org/trunk@55861 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-08-02 14:37:21 -04:00
|
|
|
|
2023-09-07 16:41:11 -04:00
|
|
|
wp_trigger_error(
|
|
|
|
__METHOD__,
|
2023-08-03 15:52:22 -04:00
|
|
|
"The property `{$name}` is not declared. Getting a dynamic property is " .
|
|
|
|
'deprecated since version 6.4.0! Instead, declare the property on the class.',
|
Code Modernization: Deprecate dynamic properties in WP_List_Table magic methods.
The unknown use of unknown dynamic property within the `WP_List_Table` property magic methods is now deprecated. A descriptive deprecation notice is provided to alert developers to declare the property on the child class extending `WP_List_Table`.
Changes in this commit:
* Adds a deprecation notice to the `__get()`, `__set()`, `__isset()`, `__unset()` magic methods, i.e. to alert and inform developers when attempting to get/set/isset/unset a dynamic property.
* Fixes `__get()` to explicitly returns `null` when attempting to get a dynamic property.
* Removes returning the value when setting a declared property, as (a) unnecessary and (b) `__set()` should return `void` [https://www.php.net/manual/en/language.oop5.overloading.php#object.set per the PHP handbook].
* Adds unit tests for happy and unhappy paths.
For backward compatibility, no changes are made to the internal declared properties listed in `$compat_fields` and accessed through the magic methods.
For example:
A child class uses a property named `$data` that is not declared / defined as a property on the child class. When getting its value, e.g. `$list_table->data`, the `WP_List_Table::__get()` magic method is invoked, the following deprecation notice thrown, and `null` returned:
>The property `data` is not defined. Setting a dynamic (undefined) property is deprecated since version 6.4.0! Instead, define the property on the class.
=== Why not remove the magic methods, remove the `$compat_fields` property, and restore the properties `public`?
tl;dr Backward compatibility.
Several plugins, one of which has over 5M installs, add a property to the `$compat_fields` array. Removing the property would cause an `Undefined property` `Warning` (PHP 8) | `Notice` (PHP 7) to be thrown. Removing the associated code would change the functionality.
=== Why not limit the deprecation for PHP versions >= 8.2?
tl;dr original design intent and inform
The magic methods and `$compat_fields` property were added for one purpose: to continue providing external access to internal properties declared on `WP_List_Table`. They were not intended to be used for dynamic properties.
Deprecating that unintended usage both alerts developers a change is needed in their child class and informs them what to change.
References:
* Dynamic (non-explicitly declared) properties are deprecated as of PHP 8.2 and are expected to become a fatal error in PHP 9.0.
* A [https://www.youtube.com/live/vDZWepDQQVE?feature=share&t=10097 live open public working session] where these changes were discussed and agreed to.
* [https://wiki.php.net/rfc/deprecate_dynamic_properties PHP RFC: Deprecate dynamic properties.]
Related to #14579, #22234, #30891.
Follow-up to [15491], [28493], [28521], [28524], [31146].
Props antonvlasenko, jrf, markjaquith, hellofromTonya, SergeyBiryukov, desrosj, peterwilsoncc, audrasjb, costdev, oglekler, jeffpaul.
Fixes #58896.
See #56034.
Built from https://develop.svn.wordpress.org/trunk@56349
git-svn-id: http://core.svn.wordpress.org/trunk@55861 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-08-02 14:37:21 -04:00
|
|
|
E_USER_DEPRECATED
|
|
|
|
);
|
|
|
|
return null;
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
}
|
|
|
|
|
2014-05-19 02:31:15 -04:00
|
|
|
/**
|
2023-06-14 02:34:27 -04:00
|
|
|
* Makes private properties settable for backward compatibility.
|
2014-05-19 02:31:15 -04:00
|
|
|
*
|
|
|
|
* @since 4.0.0
|
Code Modernization: Deprecate dynamic properties in WP_List_Table magic methods.
The unknown use of unknown dynamic property within the `WP_List_Table` property magic methods is now deprecated. A descriptive deprecation notice is provided to alert developers to declare the property on the child class extending `WP_List_Table`.
Changes in this commit:
* Adds a deprecation notice to the `__get()`, `__set()`, `__isset()`, `__unset()` magic methods, i.e. to alert and inform developers when attempting to get/set/isset/unset a dynamic property.
* Fixes `__get()` to explicitly returns `null` when attempting to get a dynamic property.
* Removes returning the value when setting a declared property, as (a) unnecessary and (b) `__set()` should return `void` [https://www.php.net/manual/en/language.oop5.overloading.php#object.set per the PHP handbook].
* Adds unit tests for happy and unhappy paths.
For backward compatibility, no changes are made to the internal declared properties listed in `$compat_fields` and accessed through the magic methods.
For example:
A child class uses a property named `$data` that is not declared / defined as a property on the child class. When getting its value, e.g. `$list_table->data`, the `WP_List_Table::__get()` magic method is invoked, the following deprecation notice thrown, and `null` returned:
>The property `data` is not defined. Setting a dynamic (undefined) property is deprecated since version 6.4.0! Instead, define the property on the class.
=== Why not remove the magic methods, remove the `$compat_fields` property, and restore the properties `public`?
tl;dr Backward compatibility.
Several plugins, one of which has over 5M installs, add a property to the `$compat_fields` array. Removing the property would cause an `Undefined property` `Warning` (PHP 8) | `Notice` (PHP 7) to be thrown. Removing the associated code would change the functionality.
=== Why not limit the deprecation for PHP versions >= 8.2?
tl;dr original design intent and inform
The magic methods and `$compat_fields` property were added for one purpose: to continue providing external access to internal properties declared on `WP_List_Table`. They were not intended to be used for dynamic properties.
Deprecating that unintended usage both alerts developers a change is needed in their child class and informs them what to change.
References:
* Dynamic (non-explicitly declared) properties are deprecated as of PHP 8.2 and are expected to become a fatal error in PHP 9.0.
* A [https://www.youtube.com/live/vDZWepDQQVE?feature=share&t=10097 live open public working session] where these changes were discussed and agreed to.
* [https://wiki.php.net/rfc/deprecate_dynamic_properties PHP RFC: Deprecate dynamic properties.]
Related to #14579, #22234, #30891.
Follow-up to [15491], [28493], [28521], [28524], [31146].
Props antonvlasenko, jrf, markjaquith, hellofromTonya, SergeyBiryukov, desrosj, peterwilsoncc, audrasjb, costdev, oglekler, jeffpaul.
Fixes #58896.
See #56034.
Built from https://develop.svn.wordpress.org/trunk@56349
git-svn-id: http://core.svn.wordpress.org/trunk@55861 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-08-02 14:37:21 -04:00
|
|
|
* @since 6.4.0 Setting a dynamic property is deprecated.
|
2014-07-13 19:55:16 -04:00
|
|
|
*
|
2015-01-11 17:20:22 -05:00
|
|
|
* @param string $name Property to check if set.
|
2014-07-13 19:55:16 -04:00
|
|
|
* @param mixed $value Property value.
|
2014-05-19 02:31:15 -04:00
|
|
|
*/
|
|
|
|
public function __set( $name, $value ) {
|
2020-04-04 23:02:11 -04:00
|
|
|
if ( in_array( $name, $this->compat_fields, true ) ) {
|
Code Modernization: Deprecate dynamic properties in WP_List_Table magic methods.
The unknown use of unknown dynamic property within the `WP_List_Table` property magic methods is now deprecated. A descriptive deprecation notice is provided to alert developers to declare the property on the child class extending `WP_List_Table`.
Changes in this commit:
* Adds a deprecation notice to the `__get()`, `__set()`, `__isset()`, `__unset()` magic methods, i.e. to alert and inform developers when attempting to get/set/isset/unset a dynamic property.
* Fixes `__get()` to explicitly returns `null` when attempting to get a dynamic property.
* Removes returning the value when setting a declared property, as (a) unnecessary and (b) `__set()` should return `void` [https://www.php.net/manual/en/language.oop5.overloading.php#object.set per the PHP handbook].
* Adds unit tests for happy and unhappy paths.
For backward compatibility, no changes are made to the internal declared properties listed in `$compat_fields` and accessed through the magic methods.
For example:
A child class uses a property named `$data` that is not declared / defined as a property on the child class. When getting its value, e.g. `$list_table->data`, the `WP_List_Table::__get()` magic method is invoked, the following deprecation notice thrown, and `null` returned:
>The property `data` is not defined. Setting a dynamic (undefined) property is deprecated since version 6.4.0! Instead, define the property on the class.
=== Why not remove the magic methods, remove the `$compat_fields` property, and restore the properties `public`?
tl;dr Backward compatibility.
Several plugins, one of which has over 5M installs, add a property to the `$compat_fields` array. Removing the property would cause an `Undefined property` `Warning` (PHP 8) | `Notice` (PHP 7) to be thrown. Removing the associated code would change the functionality.
=== Why not limit the deprecation for PHP versions >= 8.2?
tl;dr original design intent and inform
The magic methods and `$compat_fields` property were added for one purpose: to continue providing external access to internal properties declared on `WP_List_Table`. They were not intended to be used for dynamic properties.
Deprecating that unintended usage both alerts developers a change is needed in their child class and informs them what to change.
References:
* Dynamic (non-explicitly declared) properties are deprecated as of PHP 8.2 and are expected to become a fatal error in PHP 9.0.
* A [https://www.youtube.com/live/vDZWepDQQVE?feature=share&t=10097 live open public working session] where these changes were discussed and agreed to.
* [https://wiki.php.net/rfc/deprecate_dynamic_properties PHP RFC: Deprecate dynamic properties.]
Related to #14579, #22234, #30891.
Follow-up to [15491], [28493], [28521], [28524], [31146].
Props antonvlasenko, jrf, markjaquith, hellofromTonya, SergeyBiryukov, desrosj, peterwilsoncc, audrasjb, costdev, oglekler, jeffpaul.
Fixes #58896.
See #56034.
Built from https://develop.svn.wordpress.org/trunk@56349
git-svn-id: http://core.svn.wordpress.org/trunk@55861 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-08-02 14:37:21 -04:00
|
|
|
$this->$name = $value;
|
|
|
|
return;
|
2015-01-11 17:20:22 -05:00
|
|
|
}
|
Code Modernization: Deprecate dynamic properties in WP_List_Table magic methods.
The unknown use of unknown dynamic property within the `WP_List_Table` property magic methods is now deprecated. A descriptive deprecation notice is provided to alert developers to declare the property on the child class extending `WP_List_Table`.
Changes in this commit:
* Adds a deprecation notice to the `__get()`, `__set()`, `__isset()`, `__unset()` magic methods, i.e. to alert and inform developers when attempting to get/set/isset/unset a dynamic property.
* Fixes `__get()` to explicitly returns `null` when attempting to get a dynamic property.
* Removes returning the value when setting a declared property, as (a) unnecessary and (b) `__set()` should return `void` [https://www.php.net/manual/en/language.oop5.overloading.php#object.set per the PHP handbook].
* Adds unit tests for happy and unhappy paths.
For backward compatibility, no changes are made to the internal declared properties listed in `$compat_fields` and accessed through the magic methods.
For example:
A child class uses a property named `$data` that is not declared / defined as a property on the child class. When getting its value, e.g. `$list_table->data`, the `WP_List_Table::__get()` magic method is invoked, the following deprecation notice thrown, and `null` returned:
>The property `data` is not defined. Setting a dynamic (undefined) property is deprecated since version 6.4.0! Instead, define the property on the class.
=== Why not remove the magic methods, remove the `$compat_fields` property, and restore the properties `public`?
tl;dr Backward compatibility.
Several plugins, one of which has over 5M installs, add a property to the `$compat_fields` array. Removing the property would cause an `Undefined property` `Warning` (PHP 8) | `Notice` (PHP 7) to be thrown. Removing the associated code would change the functionality.
=== Why not limit the deprecation for PHP versions >= 8.2?
tl;dr original design intent and inform
The magic methods and `$compat_fields` property were added for one purpose: to continue providing external access to internal properties declared on `WP_List_Table`. They were not intended to be used for dynamic properties.
Deprecating that unintended usage both alerts developers a change is needed in their child class and informs them what to change.
References:
* Dynamic (non-explicitly declared) properties are deprecated as of PHP 8.2 and are expected to become a fatal error in PHP 9.0.
* A [https://www.youtube.com/live/vDZWepDQQVE?feature=share&t=10097 live open public working session] where these changes were discussed and agreed to.
* [https://wiki.php.net/rfc/deprecate_dynamic_properties PHP RFC: Deprecate dynamic properties.]
Related to #14579, #22234, #30891.
Follow-up to [15491], [28493], [28521], [28524], [31146].
Props antonvlasenko, jrf, markjaquith, hellofromTonya, SergeyBiryukov, desrosj, peterwilsoncc, audrasjb, costdev, oglekler, jeffpaul.
Fixes #58896.
See #56034.
Built from https://develop.svn.wordpress.org/trunk@56349
git-svn-id: http://core.svn.wordpress.org/trunk@55861 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-08-02 14:37:21 -04:00
|
|
|
|
2023-09-07 16:41:11 -04:00
|
|
|
wp_trigger_error(
|
|
|
|
__METHOD__,
|
2023-08-03 15:52:22 -04:00
|
|
|
"The property `{$name}` is not declared. Setting a dynamic property is " .
|
|
|
|
'deprecated since version 6.4.0! Instead, declare the property on the class.',
|
Code Modernization: Deprecate dynamic properties in WP_List_Table magic methods.
The unknown use of unknown dynamic property within the `WP_List_Table` property magic methods is now deprecated. A descriptive deprecation notice is provided to alert developers to declare the property on the child class extending `WP_List_Table`.
Changes in this commit:
* Adds a deprecation notice to the `__get()`, `__set()`, `__isset()`, `__unset()` magic methods, i.e. to alert and inform developers when attempting to get/set/isset/unset a dynamic property.
* Fixes `__get()` to explicitly returns `null` when attempting to get a dynamic property.
* Removes returning the value when setting a declared property, as (a) unnecessary and (b) `__set()` should return `void` [https://www.php.net/manual/en/language.oop5.overloading.php#object.set per the PHP handbook].
* Adds unit tests for happy and unhappy paths.
For backward compatibility, no changes are made to the internal declared properties listed in `$compat_fields` and accessed through the magic methods.
For example:
A child class uses a property named `$data` that is not declared / defined as a property on the child class. When getting its value, e.g. `$list_table->data`, the `WP_List_Table::__get()` magic method is invoked, the following deprecation notice thrown, and `null` returned:
>The property `data` is not defined. Setting a dynamic (undefined) property is deprecated since version 6.4.0! Instead, define the property on the class.
=== Why not remove the magic methods, remove the `$compat_fields` property, and restore the properties `public`?
tl;dr Backward compatibility.
Several plugins, one of which has over 5M installs, add a property to the `$compat_fields` array. Removing the property would cause an `Undefined property` `Warning` (PHP 8) | `Notice` (PHP 7) to be thrown. Removing the associated code would change the functionality.
=== Why not limit the deprecation for PHP versions >= 8.2?
tl;dr original design intent and inform
The magic methods and `$compat_fields` property were added for one purpose: to continue providing external access to internal properties declared on `WP_List_Table`. They were not intended to be used for dynamic properties.
Deprecating that unintended usage both alerts developers a change is needed in their child class and informs them what to change.
References:
* Dynamic (non-explicitly declared) properties are deprecated as of PHP 8.2 and are expected to become a fatal error in PHP 9.0.
* A [https://www.youtube.com/live/vDZWepDQQVE?feature=share&t=10097 live open public working session] where these changes were discussed and agreed to.
* [https://wiki.php.net/rfc/deprecate_dynamic_properties PHP RFC: Deprecate dynamic properties.]
Related to #14579, #22234, #30891.
Follow-up to [15491], [28493], [28521], [28524], [31146].
Props antonvlasenko, jrf, markjaquith, hellofromTonya, SergeyBiryukov, desrosj, peterwilsoncc, audrasjb, costdev, oglekler, jeffpaul.
Fixes #58896.
See #56034.
Built from https://develop.svn.wordpress.org/trunk@56349
git-svn-id: http://core.svn.wordpress.org/trunk@55861 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-08-02 14:37:21 -04:00
|
|
|
E_USER_DEPRECATED
|
|
|
|
);
|
2014-05-19 02:31:15 -04:00
|
|
|
}
|
|
|
|
|
2014-05-19 02:52:14 -04:00
|
|
|
/**
|
2023-06-14 02:34:27 -04:00
|
|
|
* Makes private properties checkable for backward compatibility.
|
2014-05-19 02:52:14 -04:00
|
|
|
*
|
|
|
|
* @since 4.0.0
|
Code Modernization: Deprecate dynamic properties in WP_List_Table magic methods.
The unknown use of unknown dynamic property within the `WP_List_Table` property magic methods is now deprecated. A descriptive deprecation notice is provided to alert developers to declare the property on the child class extending `WP_List_Table`.
Changes in this commit:
* Adds a deprecation notice to the `__get()`, `__set()`, `__isset()`, `__unset()` magic methods, i.e. to alert and inform developers when attempting to get/set/isset/unset a dynamic property.
* Fixes `__get()` to explicitly returns `null` when attempting to get a dynamic property.
* Removes returning the value when setting a declared property, as (a) unnecessary and (b) `__set()` should return `void` [https://www.php.net/manual/en/language.oop5.overloading.php#object.set per the PHP handbook].
* Adds unit tests for happy and unhappy paths.
For backward compatibility, no changes are made to the internal declared properties listed in `$compat_fields` and accessed through the magic methods.
For example:
A child class uses a property named `$data` that is not declared / defined as a property on the child class. When getting its value, e.g. `$list_table->data`, the `WP_List_Table::__get()` magic method is invoked, the following deprecation notice thrown, and `null` returned:
>The property `data` is not defined. Setting a dynamic (undefined) property is deprecated since version 6.4.0! Instead, define the property on the class.
=== Why not remove the magic methods, remove the `$compat_fields` property, and restore the properties `public`?
tl;dr Backward compatibility.
Several plugins, one of which has over 5M installs, add a property to the `$compat_fields` array. Removing the property would cause an `Undefined property` `Warning` (PHP 8) | `Notice` (PHP 7) to be thrown. Removing the associated code would change the functionality.
=== Why not limit the deprecation for PHP versions >= 8.2?
tl;dr original design intent and inform
The magic methods and `$compat_fields` property were added for one purpose: to continue providing external access to internal properties declared on `WP_List_Table`. They were not intended to be used for dynamic properties.
Deprecating that unintended usage both alerts developers a change is needed in their child class and informs them what to change.
References:
* Dynamic (non-explicitly declared) properties are deprecated as of PHP 8.2 and are expected to become a fatal error in PHP 9.0.
* A [https://www.youtube.com/live/vDZWepDQQVE?feature=share&t=10097 live open public working session] where these changes were discussed and agreed to.
* [https://wiki.php.net/rfc/deprecate_dynamic_properties PHP RFC: Deprecate dynamic properties.]
Related to #14579, #22234, #30891.
Follow-up to [15491], [28493], [28521], [28524], [31146].
Props antonvlasenko, jrf, markjaquith, hellofromTonya, SergeyBiryukov, desrosj, peterwilsoncc, audrasjb, costdev, oglekler, jeffpaul.
Fixes #58896.
See #56034.
Built from https://develop.svn.wordpress.org/trunk@56349
git-svn-id: http://core.svn.wordpress.org/trunk@55861 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-08-02 14:37:21 -04:00
|
|
|
* @since 6.4.0 Checking a dynamic property is deprecated.
|
2014-07-13 19:55:16 -04:00
|
|
|
*
|
|
|
|
* @param string $name Property to check if set.
|
2021-09-22 17:01:00 -04:00
|
|
|
* @return bool Whether the property is a back-compat property and it is set.
|
2014-05-19 02:52:14 -04:00
|
|
|
*/
|
|
|
|
public function __isset( $name ) {
|
2020-04-04 23:02:11 -04:00
|
|
|
if ( in_array( $name, $this->compat_fields, true ) ) {
|
2015-01-11 17:20:22 -05:00
|
|
|
return isset( $this->$name );
|
|
|
|
}
|
2021-09-22 17:01:00 -04:00
|
|
|
|
2023-09-07 16:41:11 -04:00
|
|
|
wp_trigger_error(
|
|
|
|
__METHOD__,
|
2023-08-03 15:52:22 -04:00
|
|
|
"The property `{$name}` is not declared. Checking `isset()` on a dynamic property " .
|
|
|
|
'is deprecated since version 6.4.0! Instead, declare the property on the class.',
|
Code Modernization: Deprecate dynamic properties in WP_List_Table magic methods.
The unknown use of unknown dynamic property within the `WP_List_Table` property magic methods is now deprecated. A descriptive deprecation notice is provided to alert developers to declare the property on the child class extending `WP_List_Table`.
Changes in this commit:
* Adds a deprecation notice to the `__get()`, `__set()`, `__isset()`, `__unset()` magic methods, i.e. to alert and inform developers when attempting to get/set/isset/unset a dynamic property.
* Fixes `__get()` to explicitly returns `null` when attempting to get a dynamic property.
* Removes returning the value when setting a declared property, as (a) unnecessary and (b) `__set()` should return `void` [https://www.php.net/manual/en/language.oop5.overloading.php#object.set per the PHP handbook].
* Adds unit tests for happy and unhappy paths.
For backward compatibility, no changes are made to the internal declared properties listed in `$compat_fields` and accessed through the magic methods.
For example:
A child class uses a property named `$data` that is not declared / defined as a property on the child class. When getting its value, e.g. `$list_table->data`, the `WP_List_Table::__get()` magic method is invoked, the following deprecation notice thrown, and `null` returned:
>The property `data` is not defined. Setting a dynamic (undefined) property is deprecated since version 6.4.0! Instead, define the property on the class.
=== Why not remove the magic methods, remove the `$compat_fields` property, and restore the properties `public`?
tl;dr Backward compatibility.
Several plugins, one of which has over 5M installs, add a property to the `$compat_fields` array. Removing the property would cause an `Undefined property` `Warning` (PHP 8) | `Notice` (PHP 7) to be thrown. Removing the associated code would change the functionality.
=== Why not limit the deprecation for PHP versions >= 8.2?
tl;dr original design intent and inform
The magic methods and `$compat_fields` property were added for one purpose: to continue providing external access to internal properties declared on `WP_List_Table`. They were not intended to be used for dynamic properties.
Deprecating that unintended usage both alerts developers a change is needed in their child class and informs them what to change.
References:
* Dynamic (non-explicitly declared) properties are deprecated as of PHP 8.2 and are expected to become a fatal error in PHP 9.0.
* A [https://www.youtube.com/live/vDZWepDQQVE?feature=share&t=10097 live open public working session] where these changes were discussed and agreed to.
* [https://wiki.php.net/rfc/deprecate_dynamic_properties PHP RFC: Deprecate dynamic properties.]
Related to #14579, #22234, #30891.
Follow-up to [15491], [28493], [28521], [28524], [31146].
Props antonvlasenko, jrf, markjaquith, hellofromTonya, SergeyBiryukov, desrosj, peterwilsoncc, audrasjb, costdev, oglekler, jeffpaul.
Fixes #58896.
See #56034.
Built from https://develop.svn.wordpress.org/trunk@56349
git-svn-id: http://core.svn.wordpress.org/trunk@55861 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-08-02 14:37:21 -04:00
|
|
|
E_USER_DEPRECATED
|
|
|
|
);
|
2021-09-22 17:01:00 -04:00
|
|
|
return false;
|
2014-05-19 02:52:14 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2023-06-14 02:34:27 -04:00
|
|
|
* Makes private properties un-settable for backward compatibility.
|
2014-05-19 02:52:14 -04:00
|
|
|
*
|
|
|
|
* @since 4.0.0
|
Code Modernization: Deprecate dynamic properties in WP_List_Table magic methods.
The unknown use of unknown dynamic property within the `WP_List_Table` property magic methods is now deprecated. A descriptive deprecation notice is provided to alert developers to declare the property on the child class extending `WP_List_Table`.
Changes in this commit:
* Adds a deprecation notice to the `__get()`, `__set()`, `__isset()`, `__unset()` magic methods, i.e. to alert and inform developers when attempting to get/set/isset/unset a dynamic property.
* Fixes `__get()` to explicitly returns `null` when attempting to get a dynamic property.
* Removes returning the value when setting a declared property, as (a) unnecessary and (b) `__set()` should return `void` [https://www.php.net/manual/en/language.oop5.overloading.php#object.set per the PHP handbook].
* Adds unit tests for happy and unhappy paths.
For backward compatibility, no changes are made to the internal declared properties listed in `$compat_fields` and accessed through the magic methods.
For example:
A child class uses a property named `$data` that is not declared / defined as a property on the child class. When getting its value, e.g. `$list_table->data`, the `WP_List_Table::__get()` magic method is invoked, the following deprecation notice thrown, and `null` returned:
>The property `data` is not defined. Setting a dynamic (undefined) property is deprecated since version 6.4.0! Instead, define the property on the class.
=== Why not remove the magic methods, remove the `$compat_fields` property, and restore the properties `public`?
tl;dr Backward compatibility.
Several plugins, one of which has over 5M installs, add a property to the `$compat_fields` array. Removing the property would cause an `Undefined property` `Warning` (PHP 8) | `Notice` (PHP 7) to be thrown. Removing the associated code would change the functionality.
=== Why not limit the deprecation for PHP versions >= 8.2?
tl;dr original design intent and inform
The magic methods and `$compat_fields` property were added for one purpose: to continue providing external access to internal properties declared on `WP_List_Table`. They were not intended to be used for dynamic properties.
Deprecating that unintended usage both alerts developers a change is needed in their child class and informs them what to change.
References:
* Dynamic (non-explicitly declared) properties are deprecated as of PHP 8.2 and are expected to become a fatal error in PHP 9.0.
* A [https://www.youtube.com/live/vDZWepDQQVE?feature=share&t=10097 live open public working session] where these changes were discussed and agreed to.
* [https://wiki.php.net/rfc/deprecate_dynamic_properties PHP RFC: Deprecate dynamic properties.]
Related to #14579, #22234, #30891.
Follow-up to [15491], [28493], [28521], [28524], [31146].
Props antonvlasenko, jrf, markjaquith, hellofromTonya, SergeyBiryukov, desrosj, peterwilsoncc, audrasjb, costdev, oglekler, jeffpaul.
Fixes #58896.
See #56034.
Built from https://develop.svn.wordpress.org/trunk@56349
git-svn-id: http://core.svn.wordpress.org/trunk@55861 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-08-02 14:37:21 -04:00
|
|
|
* @since 6.4.0 Unsetting a dynamic property is deprecated.
|
2014-07-13 19:55:16 -04:00
|
|
|
*
|
|
|
|
* @param string $name Property to unset.
|
2014-05-19 02:52:14 -04:00
|
|
|
*/
|
|
|
|
public function __unset( $name ) {
|
2020-04-04 23:02:11 -04:00
|
|
|
if ( in_array( $name, $this->compat_fields, true ) ) {
|
2015-01-11 17:20:22 -05:00
|
|
|
unset( $this->$name );
|
Code Modernization: Deprecate dynamic properties in WP_List_Table magic methods.
The unknown use of unknown dynamic property within the `WP_List_Table` property magic methods is now deprecated. A descriptive deprecation notice is provided to alert developers to declare the property on the child class extending `WP_List_Table`.
Changes in this commit:
* Adds a deprecation notice to the `__get()`, `__set()`, `__isset()`, `__unset()` magic methods, i.e. to alert and inform developers when attempting to get/set/isset/unset a dynamic property.
* Fixes `__get()` to explicitly returns `null` when attempting to get a dynamic property.
* Removes returning the value when setting a declared property, as (a) unnecessary and (b) `__set()` should return `void` [https://www.php.net/manual/en/language.oop5.overloading.php#object.set per the PHP handbook].
* Adds unit tests for happy and unhappy paths.
For backward compatibility, no changes are made to the internal declared properties listed in `$compat_fields` and accessed through the magic methods.
For example:
A child class uses a property named `$data` that is not declared / defined as a property on the child class. When getting its value, e.g. `$list_table->data`, the `WP_List_Table::__get()` magic method is invoked, the following deprecation notice thrown, and `null` returned:
>The property `data` is not defined. Setting a dynamic (undefined) property is deprecated since version 6.4.0! Instead, define the property on the class.
=== Why not remove the magic methods, remove the `$compat_fields` property, and restore the properties `public`?
tl;dr Backward compatibility.
Several plugins, one of which has over 5M installs, add a property to the `$compat_fields` array. Removing the property would cause an `Undefined property` `Warning` (PHP 8) | `Notice` (PHP 7) to be thrown. Removing the associated code would change the functionality.
=== Why not limit the deprecation for PHP versions >= 8.2?
tl;dr original design intent and inform
The magic methods and `$compat_fields` property were added for one purpose: to continue providing external access to internal properties declared on `WP_List_Table`. They were not intended to be used for dynamic properties.
Deprecating that unintended usage both alerts developers a change is needed in their child class and informs them what to change.
References:
* Dynamic (non-explicitly declared) properties are deprecated as of PHP 8.2 and are expected to become a fatal error in PHP 9.0.
* A [https://www.youtube.com/live/vDZWepDQQVE?feature=share&t=10097 live open public working session] where these changes were discussed and agreed to.
* [https://wiki.php.net/rfc/deprecate_dynamic_properties PHP RFC: Deprecate dynamic properties.]
Related to #14579, #22234, #30891.
Follow-up to [15491], [28493], [28521], [28524], [31146].
Props antonvlasenko, jrf, markjaquith, hellofromTonya, SergeyBiryukov, desrosj, peterwilsoncc, audrasjb, costdev, oglekler, jeffpaul.
Fixes #58896.
See #56034.
Built from https://develop.svn.wordpress.org/trunk@56349
git-svn-id: http://core.svn.wordpress.org/trunk@55861 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-08-02 14:37:21 -04:00
|
|
|
return;
|
2015-01-11 17:20:22 -05:00
|
|
|
}
|
Code Modernization: Deprecate dynamic properties in WP_List_Table magic methods.
The unknown use of unknown dynamic property within the `WP_List_Table` property magic methods is now deprecated. A descriptive deprecation notice is provided to alert developers to declare the property on the child class extending `WP_List_Table`.
Changes in this commit:
* Adds a deprecation notice to the `__get()`, `__set()`, `__isset()`, `__unset()` magic methods, i.e. to alert and inform developers when attempting to get/set/isset/unset a dynamic property.
* Fixes `__get()` to explicitly returns `null` when attempting to get a dynamic property.
* Removes returning the value when setting a declared property, as (a) unnecessary and (b) `__set()` should return `void` [https://www.php.net/manual/en/language.oop5.overloading.php#object.set per the PHP handbook].
* Adds unit tests for happy and unhappy paths.
For backward compatibility, no changes are made to the internal declared properties listed in `$compat_fields` and accessed through the magic methods.
For example:
A child class uses a property named `$data` that is not declared / defined as a property on the child class. When getting its value, e.g. `$list_table->data`, the `WP_List_Table::__get()` magic method is invoked, the following deprecation notice thrown, and `null` returned:
>The property `data` is not defined. Setting a dynamic (undefined) property is deprecated since version 6.4.0! Instead, define the property on the class.
=== Why not remove the magic methods, remove the `$compat_fields` property, and restore the properties `public`?
tl;dr Backward compatibility.
Several plugins, one of which has over 5M installs, add a property to the `$compat_fields` array. Removing the property would cause an `Undefined property` `Warning` (PHP 8) | `Notice` (PHP 7) to be thrown. Removing the associated code would change the functionality.
=== Why not limit the deprecation for PHP versions >= 8.2?
tl;dr original design intent and inform
The magic methods and `$compat_fields` property were added for one purpose: to continue providing external access to internal properties declared on `WP_List_Table`. They were not intended to be used for dynamic properties.
Deprecating that unintended usage both alerts developers a change is needed in their child class and informs them what to change.
References:
* Dynamic (non-explicitly declared) properties are deprecated as of PHP 8.2 and are expected to become a fatal error in PHP 9.0.
* A [https://www.youtube.com/live/vDZWepDQQVE?feature=share&t=10097 live open public working session] where these changes were discussed and agreed to.
* [https://wiki.php.net/rfc/deprecate_dynamic_properties PHP RFC: Deprecate dynamic properties.]
Related to #14579, #22234, #30891.
Follow-up to [15491], [28493], [28521], [28524], [31146].
Props antonvlasenko, jrf, markjaquith, hellofromTonya, SergeyBiryukov, desrosj, peterwilsoncc, audrasjb, costdev, oglekler, jeffpaul.
Fixes #58896.
See #56034.
Built from https://develop.svn.wordpress.org/trunk@56349
git-svn-id: http://core.svn.wordpress.org/trunk@55861 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-08-02 14:37:21 -04:00
|
|
|
|
2023-09-07 16:41:11 -04:00
|
|
|
wp_trigger_error(
|
|
|
|
__METHOD__,
|
2023-08-03 15:52:22 -04:00
|
|
|
"A property `{$name}` is not declared. Unsetting a dynamic property is " .
|
|
|
|
'deprecated since version 6.4.0! Instead, declare the property on the class.',
|
Code Modernization: Deprecate dynamic properties in WP_List_Table magic methods.
The unknown use of unknown dynamic property within the `WP_List_Table` property magic methods is now deprecated. A descriptive deprecation notice is provided to alert developers to declare the property on the child class extending `WP_List_Table`.
Changes in this commit:
* Adds a deprecation notice to the `__get()`, `__set()`, `__isset()`, `__unset()` magic methods, i.e. to alert and inform developers when attempting to get/set/isset/unset a dynamic property.
* Fixes `__get()` to explicitly returns `null` when attempting to get a dynamic property.
* Removes returning the value when setting a declared property, as (a) unnecessary and (b) `__set()` should return `void` [https://www.php.net/manual/en/language.oop5.overloading.php#object.set per the PHP handbook].
* Adds unit tests for happy and unhappy paths.
For backward compatibility, no changes are made to the internal declared properties listed in `$compat_fields` and accessed through the magic methods.
For example:
A child class uses a property named `$data` that is not declared / defined as a property on the child class. When getting its value, e.g. `$list_table->data`, the `WP_List_Table::__get()` magic method is invoked, the following deprecation notice thrown, and `null` returned:
>The property `data` is not defined. Setting a dynamic (undefined) property is deprecated since version 6.4.0! Instead, define the property on the class.
=== Why not remove the magic methods, remove the `$compat_fields` property, and restore the properties `public`?
tl;dr Backward compatibility.
Several plugins, one of which has over 5M installs, add a property to the `$compat_fields` array. Removing the property would cause an `Undefined property` `Warning` (PHP 8) | `Notice` (PHP 7) to be thrown. Removing the associated code would change the functionality.
=== Why not limit the deprecation for PHP versions >= 8.2?
tl;dr original design intent and inform
The magic methods and `$compat_fields` property were added for one purpose: to continue providing external access to internal properties declared on `WP_List_Table`. They were not intended to be used for dynamic properties.
Deprecating that unintended usage both alerts developers a change is needed in their child class and informs them what to change.
References:
* Dynamic (non-explicitly declared) properties are deprecated as of PHP 8.2 and are expected to become a fatal error in PHP 9.0.
* A [https://www.youtube.com/live/vDZWepDQQVE?feature=share&t=10097 live open public working session] where these changes were discussed and agreed to.
* [https://wiki.php.net/rfc/deprecate_dynamic_properties PHP RFC: Deprecate dynamic properties.]
Related to #14579, #22234, #30891.
Follow-up to [15491], [28493], [28521], [28524], [31146].
Props antonvlasenko, jrf, markjaquith, hellofromTonya, SergeyBiryukov, desrosj, peterwilsoncc, audrasjb, costdev, oglekler, jeffpaul.
Fixes #58896.
See #56034.
Built from https://develop.svn.wordpress.org/trunk@56349
git-svn-id: http://core.svn.wordpress.org/trunk@55861 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-08-02 14:37:21 -04:00
|
|
|
E_USER_DEPRECATED
|
|
|
|
);
|
2014-05-19 02:52:14 -04:00
|
|
|
}
|
|
|
|
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
/**
|
2023-06-14 02:34:27 -04:00
|
|
|
* Makes private/protected methods readable for backward compatibility.
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
*
|
|
|
|
* @since 4.0.0
|
2014-07-13 19:55:16 -04:00
|
|
|
*
|
2020-07-23 16:01:04 -04:00
|
|
|
* @param string $name Method to call.
|
|
|
|
* @param array $arguments Arguments to pass when calling.
|
2014-07-13 19:55:16 -04:00
|
|
|
* @return mixed|bool Return value of the callback, false otherwise.
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
*/
|
|
|
|
public function __call( $name, $arguments ) {
|
2020-04-04 23:02:11 -04:00
|
|
|
if ( in_array( $name, $this->compat_methods, true ) ) {
|
2019-09-15 07:53:56 -04:00
|
|
|
return $this->$name( ...$arguments );
|
2015-01-11 17:20:22 -05:00
|
|
|
}
|
|
|
|
return false;
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
}
|
|
|
|
|
2010-08-12 19:21:05 -04:00
|
|
|
/**
|
|
|
|
* Checks the current user's permissions
|
|
|
|
*
|
|
|
|
* @since 3.1.0
|
2011-01-12 03:05:23 -05:00
|
|
|
* @abstract
|
2010-08-12 19:21:05 -04:00
|
|
|
*/
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
public function ajax_user_can() {
|
2019-11-17 02:43:01 -05:00
|
|
|
die( 'function WP_List_Table::ajax_user_can() must be overridden in a subclass.' );
|
2010-08-12 19:21:05 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Prepares the list of items for displaying.
|
2017-11-30 18:11:00 -05:00
|
|
|
*
|
2010-08-12 19:21:05 -04:00
|
|
|
* @uses WP_List_Table::set_pagination_args()
|
|
|
|
*
|
|
|
|
* @since 3.1.0
|
2011-01-12 03:05:23 -05:00
|
|
|
* @abstract
|
2010-08-12 19:21:05 -04:00
|
|
|
*/
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
public function prepare_items() {
|
2019-11-17 02:43:01 -05:00
|
|
|
die( 'function WP_List_Table::prepare_items() must be overridden in a subclass.' );
|
2010-08-12 19:21:05 -04:00
|
|
|
}
|
|
|
|
|
2010-08-11 17:54:51 -04:00
|
|
|
/**
|
2023-06-14 02:34:27 -04:00
|
|
|
* Sets all the necessary pagination arguments.
|
2010-08-11 17:54:51 -04:00
|
|
|
*
|
2015-11-02 16:03:24 -05:00
|
|
|
* @since 3.1.0
|
2015-05-29 16:17:26 -04:00
|
|
|
*
|
2015-11-02 16:03:24 -05:00
|
|
|
* @param array|string $args Array or string of arguments with information about the pagination.
|
2010-08-11 17:54:51 -04:00
|
|
|
*/
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
protected function set_pagination_args( $args ) {
|
2017-11-30 18:11:00 -05:00
|
|
|
$args = wp_parse_args(
|
2018-08-16 21:51:36 -04:00
|
|
|
$args,
|
|
|
|
array(
|
2017-11-30 18:11:00 -05:00
|
|
|
'total_items' => 0,
|
|
|
|
'total_pages' => 0,
|
|
|
|
'per_page' => 0,
|
|
|
|
)
|
|
|
|
);
|
2010-08-11 17:54:51 -04:00
|
|
|
|
2017-11-30 18:11:00 -05:00
|
|
|
if ( ! $args['total_pages'] && $args['per_page'] > 0 ) {
|
2024-02-17 10:24:08 -05:00
|
|
|
$args['total_pages'] = (int) ceil( $args['total_items'] / $args['per_page'] );
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2010-08-11 17:54:51 -04:00
|
|
|
|
2014-07-17 05:14:16 -04:00
|
|
|
// Redirect if page number is invalid and headers are not already sent.
|
2016-08-23 10:33:30 -04:00
|
|
|
if ( ! headers_sent() && ! wp_doing_ajax() && $args['total_pages'] > 0 && $this->get_pagenum() > $args['total_pages'] ) {
|
2011-05-12 02:09:42 -04:00
|
|
|
wp_redirect( add_query_arg( 'paged', $args['total_pages'] ) );
|
|
|
|
exit;
|
|
|
|
}
|
|
|
|
|
2010-08-11 17:54:51 -04:00
|
|
|
$this->_pagination_args = $args;
|
|
|
|
}
|
|
|
|
|
2010-08-18 18:26:22 -04:00
|
|
|
/**
|
2014-11-04 10:55:23 -05:00
|
|
|
* Access the pagination args.
|
2010-08-18 18:26:22 -04:00
|
|
|
*
|
|
|
|
* @since 3.1.0
|
|
|
|
*
|
2014-11-04 10:55:23 -05:00
|
|
|
* @param string $key Pagination argument to retrieve. Common values include 'total_items',
|
|
|
|
* 'total_pages', 'per_page', or 'infinite_scroll'.
|
|
|
|
* @return int Number of items that correspond to the given pagination argument.
|
2010-08-18 18:26:22 -04:00
|
|
|
*/
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
public function get_pagination_arg( $key ) {
|
2015-09-22 02:06:25 -04:00
|
|
|
if ( 'page' === $key ) {
|
2010-08-18 18:26:22 -04:00
|
|
|
return $this->get_pagenum();
|
2015-09-22 02:06:25 -04:00
|
|
|
}
|
2010-10-21 15:55:28 -04:00
|
|
|
|
2017-11-30 18:11:00 -05:00
|
|
|
if ( isset( $this->_pagination_args[ $key ] ) ) {
|
|
|
|
return $this->_pagination_args[ $key ];
|
2015-09-22 02:06:25 -04:00
|
|
|
}
|
2021-09-22 17:01:00 -04:00
|
|
|
|
|
|
|
return 0;
|
2010-08-18 18:26:22 -04:00
|
|
|
}
|
|
|
|
|
2010-08-11 17:54:51 -04:00
|
|
|
/**
|
2023-06-14 02:34:27 -04:00
|
|
|
* Determines whether the table has items to display or not
|
2010-08-11 17:54:51 -04:00
|
|
|
*
|
|
|
|
* @since 3.1.0
|
|
|
|
*
|
|
|
|
* @return bool
|
|
|
|
*/
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
public function has_items() {
|
2017-11-30 18:11:00 -05:00
|
|
|
return ! empty( $this->items );
|
2010-08-11 17:54:51 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Message to be displayed when there are no items
|
|
|
|
*
|
|
|
|
* @since 3.1.0
|
|
|
|
*/
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
public function no_items() {
|
2010-08-11 17:54:51 -04:00
|
|
|
_e( 'No items found.' );
|
|
|
|
}
|
|
|
|
|
2010-12-16 15:45:10 -05:00
|
|
|
/**
|
2016-07-23 07:00:36 -04:00
|
|
|
* Displays the search box.
|
2010-12-16 15:45:10 -05:00
|
|
|
*
|
|
|
|
* @since 3.1.0
|
|
|
|
*
|
2016-07-23 07:00:36 -04:00
|
|
|
* @param string $text The 'submit' button label.
|
|
|
|
* @param string $input_id ID attribute value for the search input field.
|
2010-12-16 15:45:10 -05:00
|
|
|
*/
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
public function search_box( $text, $input_id ) {
|
2017-11-30 18:11:00 -05:00
|
|
|
if ( empty( $_REQUEST['s'] ) && ! $this->has_items() ) {
|
2010-12-16 15:45:10 -05:00
|
|
|
return;
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2010-12-16 15:45:10 -05:00
|
|
|
|
|
|
|
$input_id = $input_id . '-search-input';
|
|
|
|
|
2017-11-30 18:11:00 -05:00
|
|
|
if ( ! empty( $_REQUEST['orderby'] ) ) {
|
2024-06-10 22:14:16 -04:00
|
|
|
if ( is_array( $_REQUEST['orderby'] ) ) {
|
|
|
|
foreach ( $_REQUEST['orderby'] as $key => $value ) {
|
|
|
|
echo '<input type="hidden" name="orderby[' . esc_attr( $key ) . ']" value="' . esc_attr( $value ) . '" />';
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
echo '<input type="hidden" name="orderby" value="' . esc_attr( $_REQUEST['orderby'] ) . '" />';
|
|
|
|
}
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
|
|
|
if ( ! empty( $_REQUEST['order'] ) ) {
|
2011-01-22 13:36:54 -05:00
|
|
|
echo '<input type="hidden" name="order" value="' . esc_attr( $_REQUEST['order'] ) . '" />';
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
|
|
|
if ( ! empty( $_REQUEST['post_mime_type'] ) ) {
|
2012-09-04 17:20:51 -04:00
|
|
|
echo '<input type="hidden" name="post_mime_type" value="' . esc_attr( $_REQUEST['post_mime_type'] ) . '" />';
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
|
|
|
if ( ! empty( $_REQUEST['detached'] ) ) {
|
2012-09-04 17:20:51 -04:00
|
|
|
echo '<input type="hidden" name="detached" value="' . esc_attr( $_REQUEST['detached'] ) . '" />';
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2018-08-16 21:51:36 -04:00
|
|
|
?>
|
2010-12-16 15:45:10 -05:00
|
|
|
<p class="search-box">
|
2016-07-23 07:00:36 -04:00
|
|
|
<label class="screen-reader-text" for="<?php echo esc_attr( $input_id ); ?>"><?php echo $text; ?>:</label>
|
|
|
|
<input type="search" id="<?php echo esc_attr( $input_id ); ?>" name="s" value="<?php _admin_search_query(); ?>" />
|
2018-08-16 21:51:36 -04:00
|
|
|
<?php submit_button( $text, '', '', false, array( 'id' => 'search-submit' ) ); ?>
|
2010-12-16 15:45:10 -05:00
|
|
|
</p>
|
2018-08-16 21:51:36 -04:00
|
|
|
<?php
|
2010-12-16 15:45:10 -05:00
|
|
|
}
|
|
|
|
|
2022-09-19 18:24:09 -04:00
|
|
|
/**
|
|
|
|
* Generates views links.
|
|
|
|
*
|
|
|
|
* @since 6.1.0
|
|
|
|
*
|
|
|
|
* @param array $link_data {
|
|
|
|
* An array of link data.
|
|
|
|
*
|
|
|
|
* @type string $url The link URL.
|
|
|
|
* @type string $label The link label.
|
|
|
|
* @type bool $current Optional. Whether this is the currently selected view.
|
|
|
|
* }
|
2023-02-07 16:21:18 -05:00
|
|
|
* @return string[] An array of link markup. Keys match the `$link_data` input array.
|
2022-09-19 18:24:09 -04:00
|
|
|
*/
|
|
|
|
protected function get_views_links( $link_data = array() ) {
|
|
|
|
if ( ! is_array( $link_data ) ) {
|
|
|
|
_doing_it_wrong(
|
|
|
|
__METHOD__,
|
|
|
|
sprintf(
|
|
|
|
/* translators: %s: The $link_data argument. */
|
|
|
|
__( 'The %s argument must be an array.' ),
|
|
|
|
'<code>$link_data</code>'
|
|
|
|
),
|
|
|
|
'6.1.0'
|
|
|
|
);
|
|
|
|
|
|
|
|
return array( '' );
|
|
|
|
}
|
|
|
|
|
|
|
|
$views_links = array();
|
|
|
|
|
|
|
|
foreach ( $link_data as $view => $link ) {
|
|
|
|
if ( empty( $link['url'] ) || ! is_string( $link['url'] ) || '' === trim( $link['url'] ) ) {
|
|
|
|
_doing_it_wrong(
|
|
|
|
__METHOD__,
|
|
|
|
sprintf(
|
|
|
|
/* translators: %1$s: The argument name. %2$s: The view name. */
|
|
|
|
__( 'The %1$s argument must be a non-empty string for %2$s.' ),
|
|
|
|
'<code>url</code>',
|
|
|
|
'<code>' . esc_html( $view ) . '</code>'
|
|
|
|
),
|
|
|
|
'6.1.0'
|
|
|
|
);
|
|
|
|
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
|
|
|
if ( empty( $link['label'] ) || ! is_string( $link['label'] ) || '' === trim( $link['label'] ) ) {
|
|
|
|
_doing_it_wrong(
|
|
|
|
__METHOD__,
|
|
|
|
sprintf(
|
|
|
|
/* translators: %1$s: The argument name. %2$s: The view name. */
|
|
|
|
__( 'The %1$s argument must be a non-empty string for %2$s.' ),
|
|
|
|
'<code>label</code>',
|
|
|
|
'<code>' . esc_html( $view ) . '</code>'
|
|
|
|
),
|
|
|
|
'6.1.0'
|
|
|
|
);
|
|
|
|
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
|
|
|
$views_links[ $view ] = sprintf(
|
|
|
|
'<a href="%s"%s>%s</a>',
|
|
|
|
esc_url( $link['url'] ),
|
|
|
|
isset( $link['current'] ) && true === $link['current'] ? ' class="current" aria-current="page"' : '',
|
|
|
|
$link['label']
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
return $views_links;
|
|
|
|
}
|
|
|
|
|
2010-09-05 17:26:27 -04:00
|
|
|
/**
|
2020-06-25 04:56:16 -04:00
|
|
|
* Gets the list of views available on this table.
|
|
|
|
*
|
|
|
|
* The format is an associative array:
|
|
|
|
* - `'id' => 'link'`
|
2010-09-05 17:26:27 -04:00
|
|
|
*
|
|
|
|
* @since 3.1.0
|
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
*/
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
protected function get_views() {
|
2010-09-05 17:26:27 -04:00
|
|
|
return array();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2020-06-25 04:56:16 -04:00
|
|
|
* Displays the list of views available on this table.
|
2010-09-05 17:26:27 -04:00
|
|
|
*
|
|
|
|
* @since 3.1.0
|
|
|
|
*/
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
public function views() {
|
2010-09-05 17:26:27 -04:00
|
|
|
$views = $this->get_views();
|
2013-11-26 03:12:09 -05:00
|
|
|
/**
|
2016-05-22 14:01:30 -04:00
|
|
|
* Filters the list of available list table views.
|
2013-11-26 03:12:09 -05:00
|
|
|
*
|
2014-11-30 06:28:24 -05:00
|
|
|
* The dynamic portion of the hook name, `$this->screen->id`, refers
|
2021-01-07 09:17:11 -05:00
|
|
|
* to the ID of the current screen.
|
2013-11-26 03:12:09 -05:00
|
|
|
*
|
2020-07-25 14:55:03 -04:00
|
|
|
* @since 3.1.0
|
2013-11-26 03:12:09 -05:00
|
|
|
*
|
2018-03-22 16:27:32 -04:00
|
|
|
* @param string[] $views An array of available list table views.
|
2013-11-26 03:12:09 -05:00
|
|
|
*/
|
|
|
|
$views = apply_filters( "views_{$this->screen->id}", $views );
|
2010-09-05 17:26:27 -04:00
|
|
|
|
2017-11-30 18:11:00 -05:00
|
|
|
if ( empty( $views ) ) {
|
2010-09-05 17:26:27 -04:00
|
|
|
return;
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2010-09-05 17:26:27 -04:00
|
|
|
|
2015-10-06 21:28:25 -04:00
|
|
|
$this->screen->render_screen_reader_content( 'heading_views' );
|
|
|
|
|
2010-09-05 17:26:27 -04:00
|
|
|
echo "<ul class='subsubsub'>\n";
|
2010-11-05 10:34:09 -04:00
|
|
|
foreach ( $views as $class => $view ) {
|
2010-12-17 18:47:40 -05:00
|
|
|
$views[ $class ] = "\t<li class='$class'>$view";
|
2010-11-05 10:34:09 -04:00
|
|
|
}
|
2010-09-05 17:26:27 -04:00
|
|
|
echo implode( " |</li>\n", $views ) . "</li>\n";
|
2017-11-30 18:11:00 -05:00
|
|
|
echo '</ul>';
|
2010-09-05 17:26:27 -04:00
|
|
|
}
|
|
|
|
|
2010-08-11 17:54:51 -04:00
|
|
|
/**
|
2020-10-18 12:22:10 -04:00
|
|
|
* Retrieves the list of bulk actions available for this table.
|
2020-06-25 04:56:16 -04:00
|
|
|
*
|
2020-10-18 12:22:10 -04:00
|
|
|
* The format is an associative array where each element represents either a top level option value and label, or
|
|
|
|
* an array representing an optgroup and its options.
|
|
|
|
*
|
|
|
|
* For a standard option, the array element key is the field value and the array element value is the field label.
|
|
|
|
*
|
|
|
|
* For an optgroup, the array element key is the label and the array element value is an associative array of
|
|
|
|
* options as above.
|
|
|
|
*
|
|
|
|
* Example:
|
|
|
|
*
|
|
|
|
* [
|
|
|
|
* 'edit' => 'Edit',
|
|
|
|
* 'delete' => 'Delete',
|
|
|
|
* 'Change State' => [
|
|
|
|
* 'feature' => 'Featured',
|
|
|
|
* 'sale' => 'On Sale',
|
|
|
|
* ]
|
|
|
|
* ]
|
2010-08-11 17:54:51 -04:00
|
|
|
*
|
|
|
|
* @since 3.1.0
|
2020-10-18 12:22:10 -04:00
|
|
|
* @since 5.6.0 A bulk action can now contain an array of options in order to create an optgroup.
|
2010-08-11 17:54:51 -04:00
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
*/
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
protected function get_bulk_actions() {
|
2010-08-11 17:54:51 -04:00
|
|
|
return array();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2020-06-25 04:56:16 -04:00
|
|
|
* Displays the bulk actions dropdown.
|
2010-08-11 17:54:51 -04:00
|
|
|
*
|
|
|
|
* @since 3.1.0
|
2014-07-24 20:20:16 -04:00
|
|
|
*
|
2024-02-16 16:47:12 -05:00
|
|
|
* @param string $which The location of the bulk actions: Either 'top' or 'bottom'.
|
2016-05-13 14:41:31 -04:00
|
|
|
* This is designated as optional for backward compatibility.
|
2010-08-11 17:54:51 -04:00
|
|
|
*/
|
2014-08-07 17:30:15 -04:00
|
|
|
protected function bulk_actions( $which = '' ) {
|
2010-08-11 17:54:51 -04:00
|
|
|
if ( is_null( $this->_actions ) ) {
|
2016-09-23 16:33:30 -04:00
|
|
|
$this->_actions = $this->get_bulk_actions();
|
2020-06-25 04:56:16 -04:00
|
|
|
|
2013-11-26 03:12:09 -05:00
|
|
|
/**
|
2020-10-18 12:22:10 -04:00
|
|
|
* Filters the items in the bulk actions menu of the list table.
|
2013-11-26 03:12:09 -05:00
|
|
|
*
|
2014-11-30 06:28:24 -05:00
|
|
|
* The dynamic portion of the hook name, `$this->screen->id`, refers
|
2020-10-18 12:22:10 -04:00
|
|
|
* to the ID of the current screen.
|
2013-11-26 03:12:09 -05:00
|
|
|
*
|
2020-07-25 14:55:03 -04:00
|
|
|
* @since 3.1.0
|
2020-10-18 12:22:10 -04:00
|
|
|
* @since 5.6.0 A bulk action can now contain an array of options in order to create an optgroup.
|
2013-11-26 03:12:09 -05:00
|
|
|
*
|
2020-10-18 12:22:10 -04:00
|
|
|
* @param array $actions An array of the available bulk actions.
|
2013-11-26 03:12:09 -05:00
|
|
|
*/
|
2020-01-28 19:45:18 -05:00
|
|
|
$this->_actions = apply_filters( "bulk_actions-{$this->screen->id}", $this->_actions ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
|
2020-06-25 04:56:16 -04:00
|
|
|
|
|
|
|
$two = '';
|
2011-01-14 02:20:13 -05:00
|
|
|
} else {
|
2010-08-11 17:54:51 -04:00
|
|
|
$two = '2';
|
|
|
|
}
|
|
|
|
|
2017-11-30 18:11:00 -05:00
|
|
|
if ( empty( $this->_actions ) ) {
|
2010-08-11 17:54:51 -04:00
|
|
|
return;
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2010-08-11 17:54:51 -04:00
|
|
|
|
I18N: Mark screen reader strings as such with translator comments.
This aims to provide better context for translators and make it easier to determine that some strings contain hidden accessibility text and are not displayed in the UI.
Props kebbet, mercime, pavelevap, ocean90, swissspidy, Chouby, jipmoors, afercia, desrosj, costdev, audrasjb, SergeyBiryukov.
Fixes #29748.
Built from https://develop.svn.wordpress.org/trunk@55276
git-svn-id: http://core.svn.wordpress.org/trunk@54809 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-07 12:10:21 -05:00
|
|
|
echo '<label for="bulk-action-selector-' . esc_attr( $which ) . '" class="screen-reader-text">' .
|
|
|
|
/* translators: Hidden accessibility text. */
|
|
|
|
__( 'Select bulk action' ) .
|
|
|
|
'</label>';
|
2015-09-23 21:07:24 -04:00
|
|
|
echo '<select name="action' . $two . '" id="bulk-action-selector-' . esc_attr( $which ) . "\">\n";
|
2020-07-06 17:52:21 -04:00
|
|
|
echo '<option value="-1">' . __( 'Bulk actions' ) . "</option>\n";
|
2011-06-10 19:01:45 -04:00
|
|
|
|
2020-10-18 12:22:10 -04:00
|
|
|
foreach ( $this->_actions as $key => $value ) {
|
|
|
|
if ( is_array( $value ) ) {
|
|
|
|
echo "\t" . '<optgroup label="' . esc_attr( $key ) . '">' . "\n";
|
|
|
|
|
|
|
|
foreach ( $value as $name => $title ) {
|
|
|
|
$class = ( 'edit' === $name ) ? ' class="hide-if-no-js"' : '';
|
|
|
|
|
|
|
|
echo "\t\t" . '<option value="' . esc_attr( $name ) . '"' . $class . '>' . $title . "</option>\n";
|
|
|
|
}
|
|
|
|
echo "\t" . "</optgroup>\n";
|
|
|
|
} else {
|
|
|
|
$class = ( 'edit' === $key ) ? ' class="hide-if-no-js"' : '';
|
2011-06-09 20:01:16 -04:00
|
|
|
|
2020-10-18 12:22:10 -04:00
|
|
|
echo "\t" . '<option value="' . esc_attr( $key ) . '"' . $class . '>' . $value . "</option>\n";
|
|
|
|
}
|
2011-06-09 20:01:16 -04:00
|
|
|
}
|
|
|
|
|
2010-08-11 17:54:51 -04:00
|
|
|
echo "</select>\n";
|
|
|
|
|
Quick/Bulk Edit: Add notice if no items selected.
Add an error notice if a user attempts to apply bulk edits with no items selected. Applies to post lists, comments, taxonomies, and plugins screens.
Props garrett-eclipse, nrqsnchz, sumitsingh, nihar007, royho, sabernhardt, oglekler, quadthemes, ankit-k-gupta, fnpen, ukdrahul, joedolson.
Fixes #45006, #58479.
Built from https://develop.svn.wordpress.org/trunk@59134
git-svn-id: http://core.svn.wordpress.org/trunk@58530 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-09-30 14:24:13 -04:00
|
|
|
submit_button( __( 'Apply' ), 'action', 'bulk_action', false, array( 'id' => "doaction$two" ) );
|
2010-10-28 17:56:43 -04:00
|
|
|
echo "\n";
|
2010-08-11 17:54:51 -04:00
|
|
|
}
|
|
|
|
|
2010-09-21 20:10:39 -04:00
|
|
|
/**
|
2020-06-25 04:56:16 -04:00
|
|
|
* Gets the current action selected from the bulk actions dropdown.
|
2010-09-21 20:10:39 -04:00
|
|
|
*
|
|
|
|
* @since 3.1.0
|
|
|
|
*
|
2020-06-25 04:56:16 -04:00
|
|
|
* @return string|false The action name. False if no action was selected.
|
2010-09-21 20:10:39 -04:00
|
|
|
*/
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
public function current_action() {
|
2017-11-30 18:11:00 -05:00
|
|
|
if ( isset( $_REQUEST['filter_action'] ) && ! empty( $_REQUEST['filter_action'] ) ) {
|
2014-06-29 21:10:15 -04:00
|
|
|
return false;
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2014-06-29 21:10:15 -04:00
|
|
|
|
2024-06-10 12:47:18 -04:00
|
|
|
if ( isset( $_REQUEST['action'] ) && '-1' !== $_REQUEST['action'] ) {
|
2020-06-23 01:56:08 -04:00
|
|
|
return $_REQUEST['action'];
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2010-10-21 15:55:28 -04:00
|
|
|
|
2010-09-21 20:10:39 -04:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2010-09-05 12:53:59 -04:00
|
|
|
/**
|
2019-10-28 15:48:01 -04:00
|
|
|
* Generates the required HTML for a list of row action links.
|
2010-09-05 12:53:59 -04:00
|
|
|
*
|
|
|
|
* @since 3.1.0
|
|
|
|
*
|
2018-03-22 16:27:32 -04:00
|
|
|
* @param string[] $actions An array of action links.
|
|
|
|
* @param bool $always_visible Whether the actions should be always visible.
|
2019-10-28 15:48:01 -04:00
|
|
|
* @return string The HTML for the row actions.
|
2010-09-05 12:53:59 -04:00
|
|
|
*/
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
protected function row_actions( $actions, $always_visible = false ) {
|
2010-09-05 12:53:59 -04:00
|
|
|
$action_count = count( $actions );
|
|
|
|
|
2017-11-30 18:11:00 -05:00
|
|
|
if ( ! $action_count ) {
|
2010-09-05 12:53:59 -04:00
|
|
|
return '';
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2010-09-05 12:53:59 -04:00
|
|
|
|
2020-07-07 15:12:03 -04:00
|
|
|
$mode = get_user_setting( 'posts_list_mode', 'list' );
|
2020-07-10 12:04:05 -04:00
|
|
|
|
2020-07-12 07:36:04 -04:00
|
|
|
if ( 'excerpt' === $mode ) {
|
2020-07-07 15:12:03 -04:00
|
|
|
$always_visible = true;
|
|
|
|
}
|
|
|
|
|
Coding Standards: Use more meaningful variable names for output in the admin.
This renames some variables for clarity, per the [https://developer.wordpress.org/coding-standards/wordpress-coding-standards/php/#naming-conventions Naming Conventions]:
> Don’t abbreviate variable names unnecessarily; let the code be unambiguous and self-documenting.
* `$out` is renamed to `$output` in various list table methods and admin functions.
* `$sep` is renamed to `$separator` in various list table methods and admin functions.
This affects:
* `WP_Comments_List_Table::handle_row_actions()`
* `WP_List_Table::row_actions()`
* `WP_Media_List_Table::column_default()`
* `WP_MS_Sites_List_Table::site_states()`
* `WP_MS_Users_List_Table::column_blogs()`
* `WP_Terms_List_Table::column_name()`
* `_wp_dashboard_recent_comments_row()`
* `image_align_input_fields()`
* `image_size_input_fields()`
* `wp_doc_link_parse()`
* `_post_states()`
* `_media_states()`
Follow-up to [8653], [8692], [8864], [8910], [8911], [8916], [9103], [9153], [10607], [15491], [17793], [32644], [54070].
Props mukesh27, costdev.
See #56448, #55647.
Built from https://develop.svn.wordpress.org/trunk@54071
git-svn-id: http://core.svn.wordpress.org/trunk@53630 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-09-05 13:19:09 -04:00
|
|
|
$output = '<div class="' . ( $always_visible ? 'row-actions visible' : 'row-actions' ) . '">';
|
2020-07-10 12:04:05 -04:00
|
|
|
|
|
|
|
$i = 0;
|
|
|
|
|
2010-09-05 12:53:59 -04:00
|
|
|
foreach ( $actions as $action => $link ) {
|
|
|
|
++$i;
|
2020-07-10 12:04:05 -04:00
|
|
|
|
Coding Standards: Use more meaningful variable names for output in the admin.
This renames some variables for clarity, per the [https://developer.wordpress.org/coding-standards/wordpress-coding-standards/php/#naming-conventions Naming Conventions]:
> Don’t abbreviate variable names unnecessarily; let the code be unambiguous and self-documenting.
* `$out` is renamed to `$output` in various list table methods and admin functions.
* `$sep` is renamed to `$separator` in various list table methods and admin functions.
This affects:
* `WP_Comments_List_Table::handle_row_actions()`
* `WP_List_Table::row_actions()`
* `WP_Media_List_Table::column_default()`
* `WP_MS_Sites_List_Table::site_states()`
* `WP_MS_Users_List_Table::column_blogs()`
* `WP_Terms_List_Table::column_name()`
* `_wp_dashboard_recent_comments_row()`
* `image_align_input_fields()`
* `image_size_input_fields()`
* `wp_doc_link_parse()`
* `_post_states()`
* `_media_states()`
Follow-up to [8653], [8692], [8864], [8910], [8911], [8916], [9103], [9153], [10607], [15491], [17793], [32644], [54070].
Props mukesh27, costdev.
See #56448, #55647.
Built from https://develop.svn.wordpress.org/trunk@54071
git-svn-id: http://core.svn.wordpress.org/trunk@53630 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-09-05 13:19:09 -04:00
|
|
|
$separator = ( $i < $action_count ) ? ' | ' : '';
|
2020-07-10 12:04:05 -04:00
|
|
|
|
Coding Standards: Use more meaningful variable names for output in the admin.
This renames some variables for clarity, per the [https://developer.wordpress.org/coding-standards/wordpress-coding-standards/php/#naming-conventions Naming Conventions]:
> Don’t abbreviate variable names unnecessarily; let the code be unambiguous and self-documenting.
* `$out` is renamed to `$output` in various list table methods and admin functions.
* `$sep` is renamed to `$separator` in various list table methods and admin functions.
This affects:
* `WP_Comments_List_Table::handle_row_actions()`
* `WP_List_Table::row_actions()`
* `WP_Media_List_Table::column_default()`
* `WP_MS_Sites_List_Table::site_states()`
* `WP_MS_Users_List_Table::column_blogs()`
* `WP_Terms_List_Table::column_name()`
* `_wp_dashboard_recent_comments_row()`
* `image_align_input_fields()`
* `image_size_input_fields()`
* `wp_doc_link_parse()`
* `_post_states()`
* `_media_states()`
Follow-up to [8653], [8692], [8864], [8910], [8911], [8916], [9103], [9153], [10607], [15491], [17793], [32644], [54070].
Props mukesh27, costdev.
See #56448, #55647.
Built from https://develop.svn.wordpress.org/trunk@54071
git-svn-id: http://core.svn.wordpress.org/trunk@53630 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-09-05 13:19:09 -04:00
|
|
|
$output .= "<span class='$action'>{$link}{$separator}</span>";
|
2010-09-05 12:53:59 -04:00
|
|
|
}
|
2020-07-10 12:04:05 -04:00
|
|
|
|
Coding Standards: Use more meaningful variable names for output in the admin.
This renames some variables for clarity, per the [https://developer.wordpress.org/coding-standards/wordpress-coding-standards/php/#naming-conventions Naming Conventions]:
> Don’t abbreviate variable names unnecessarily; let the code be unambiguous and self-documenting.
* `$out` is renamed to `$output` in various list table methods and admin functions.
* `$sep` is renamed to `$separator` in various list table methods and admin functions.
This affects:
* `WP_Comments_List_Table::handle_row_actions()`
* `WP_List_Table::row_actions()`
* `WP_Media_List_Table::column_default()`
* `WP_MS_Sites_List_Table::site_states()`
* `WP_MS_Users_List_Table::column_blogs()`
* `WP_Terms_List_Table::column_name()`
* `_wp_dashboard_recent_comments_row()`
* `image_align_input_fields()`
* `image_size_input_fields()`
* `wp_doc_link_parse()`
* `_post_states()`
* `_media_states()`
Follow-up to [8653], [8692], [8864], [8910], [8911], [8916], [9103], [9153], [10607], [15491], [17793], [32644], [54070].
Props mukesh27, costdev.
See #56448, #55647.
Built from https://develop.svn.wordpress.org/trunk@54071
git-svn-id: http://core.svn.wordpress.org/trunk@53630 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-09-05 13:19:09 -04:00
|
|
|
$output .= '</div>';
|
2010-09-05 12:53:59 -04:00
|
|
|
|
I18N: Mark screen reader strings as such with translator comments.
This aims to provide better context for translators and make it easier to determine that some strings contain hidden accessibility text and are not displayed in the UI.
Props kebbet, mercime, pavelevap, ocean90, swissspidy, Chouby, jipmoors, afercia, desrosj, costdev, audrasjb, SergeyBiryukov.
Fixes #29748.
Built from https://develop.svn.wordpress.org/trunk@55276
git-svn-id: http://core.svn.wordpress.org/trunk@54809 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-07 12:10:21 -05:00
|
|
|
$output .= '<button type="button" class="toggle-row"><span class="screen-reader-text">' .
|
|
|
|
/* translators: Hidden accessibility text. */
|
|
|
|
__( 'Show more details' ) .
|
|
|
|
'</span></button>';
|
List tables: A better responsive view.
Instead of truncating columns, the data that's already in the markup can now be toggled into view. Only seems appropriate to celebrate four years of contributing by finally doing the first thing I ever mocked up.
Known issues / concerns:
* Custom list tables that don't define a primary column will show nothing at all. These are not extremely common, as `WP_List_Table` isn't really recommended for plugin consumption, but it happens. We need to come up with some kind of fallback.
* Some visual elements, particularly whitespace, could use refining.
* Needs a11y review.
* Touch performance on iOS feels sluggish - is there anything we can do about that?
* Would this be better accordion-style (only one expanded at a time)?
* Is `wp_strip_all_tags()` good enough for column titles that have HTML in them? It's essentially a workaround for the fact that core's comments column does that for the icon, which maybe it shouldn't. Perhaps worth another ticket, as a markup change would be fairly independent.
* Visual hierarchy is not great when expanded (also worthy of another ticket).
* Quick edit now becomes noticeably more annoying to cancel out of, as you have to scroll all the way down and you lose your position from before it was opened. Again, worthy of another ticket.
props Michael Arestad, helen.
see #32395.
Built from https://develop.svn.wordpress.org/trunk@33016
git-svn-id: http://core.svn.wordpress.org/trunk@32987 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-06-30 21:31:25 -04:00
|
|
|
|
Coding Standards: Use more meaningful variable names for output in the admin.
This renames some variables for clarity, per the [https://developer.wordpress.org/coding-standards/wordpress-coding-standards/php/#naming-conventions Naming Conventions]:
> Don’t abbreviate variable names unnecessarily; let the code be unambiguous and self-documenting.
* `$out` is renamed to `$output` in various list table methods and admin functions.
* `$sep` is renamed to `$separator` in various list table methods and admin functions.
This affects:
* `WP_Comments_List_Table::handle_row_actions()`
* `WP_List_Table::row_actions()`
* `WP_Media_List_Table::column_default()`
* `WP_MS_Sites_List_Table::site_states()`
* `WP_MS_Users_List_Table::column_blogs()`
* `WP_Terms_List_Table::column_name()`
* `_wp_dashboard_recent_comments_row()`
* `image_align_input_fields()`
* `image_size_input_fields()`
* `wp_doc_link_parse()`
* `_post_states()`
* `_media_states()`
Follow-up to [8653], [8692], [8864], [8910], [8911], [8916], [9103], [9153], [10607], [15491], [17793], [32644], [54070].
Props mukesh27, costdev.
See #56448, #55647.
Built from https://develop.svn.wordpress.org/trunk@54071
git-svn-id: http://core.svn.wordpress.org/trunk@53630 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-09-05 13:19:09 -04:00
|
|
|
return $output;
|
2010-09-05 12:53:59 -04:00
|
|
|
}
|
|
|
|
|
2010-08-11 17:54:51 -04:00
|
|
|
/**
|
2019-10-28 15:48:01 -04:00
|
|
|
* Displays a dropdown for filtering items in the list table by month.
|
2010-08-11 17:54:51 -04:00
|
|
|
*
|
|
|
|
* @since 3.1.0
|
2014-11-30 19:33:23 -05:00
|
|
|
*
|
2019-08-03 21:12:56 -04:00
|
|
|
* @global wpdb $wpdb WordPress database abstraction object.
|
2019-08-03 21:46:55 -04:00
|
|
|
* @global WP_Locale $wp_locale WordPress date and time locale object.
|
2015-05-28 17:41:30 -04:00
|
|
|
*
|
2019-10-28 15:48:01 -04:00
|
|
|
* @param string $post_type The post type.
|
2010-08-11 17:54:51 -04:00
|
|
|
*/
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
protected function months_dropdown( $post_type ) {
|
2010-08-11 17:54:51 -04:00
|
|
|
global $wpdb, $wp_locale;
|
|
|
|
|
2015-02-12 13:38:29 -05:00
|
|
|
/**
|
2016-05-22 14:01:30 -04:00
|
|
|
* Filters whether to remove the 'Months' drop-down from the post list table.
|
2015-02-12 13:38:29 -05:00
|
|
|
*
|
|
|
|
* @since 4.2.0
|
|
|
|
*
|
|
|
|
* @param bool $disable Whether to disable the drop-down. Default false.
|
|
|
|
* @param string $post_type The post type.
|
|
|
|
*/
|
|
|
|
if ( apply_filters( 'disable_months_dropdown', false, $post_type ) ) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2013-09-21 14:35:09 -04:00
|
|
|
/**
|
2022-06-14 11:07:10 -04:00
|
|
|
* Filters whether to short-circuit performing the months dropdown query.
|
2013-09-21 14:35:09 -04:00
|
|
|
*
|
2021-02-02 15:34:04 -05:00
|
|
|
* @since 5.7.0
|
2013-09-21 14:35:09 -04:00
|
|
|
*
|
2021-02-02 15:34:04 -05:00
|
|
|
* @param object[]|false $months 'Months' drop-down results. Default false.
|
|
|
|
* @param string $post_type The post type.
|
2013-09-21 14:35:09 -04:00
|
|
|
*/
|
2021-02-02 15:34:04 -05:00
|
|
|
$months = apply_filters( 'pre_months_dropdown_query', false, $post_type );
|
|
|
|
|
|
|
|
if ( ! is_array( $months ) ) {
|
|
|
|
$extra_checks = "AND post_status != 'auto-draft'";
|
|
|
|
if ( ! isset( $_GET['post_status'] ) || 'trash' !== $_GET['post_status'] ) {
|
|
|
|
$extra_checks .= " AND post_status != 'trash'";
|
|
|
|
} elseif ( isset( $_GET['post_status'] ) ) {
|
|
|
|
$extra_checks = $wpdb->prepare( ' AND post_status = %s', $_GET['post_status'] );
|
|
|
|
}
|
|
|
|
|
|
|
|
$months = $wpdb->get_results(
|
|
|
|
$wpdb->prepare(
|
2023-05-25 08:55:19 -04:00
|
|
|
"SELECT DISTINCT YEAR( post_date ) AS year, MONTH( post_date ) AS month
|
|
|
|
FROM $wpdb->posts
|
|
|
|
WHERE post_type = %s
|
|
|
|
$extra_checks
|
|
|
|
ORDER BY post_date DESC",
|
2021-02-02 15:34:04 -05:00
|
|
|
$post_type
|
|
|
|
)
|
|
|
|
);
|
|
|
|
}
|
2013-09-21 14:35:09 -04:00
|
|
|
|
2021-02-16 14:58:05 -05:00
|
|
|
/**
|
|
|
|
* Filters the 'Months' drop-down results.
|
|
|
|
*
|
|
|
|
* @since 3.7.0
|
|
|
|
*
|
|
|
|
* @param object[] $months Array of the months drop-down query results.
|
|
|
|
* @param string $post_type The post type.
|
|
|
|
*/
|
|
|
|
$months = apply_filters( 'months_dropdown_results', $months, $post_type );
|
|
|
|
|
2010-08-11 17:54:51 -04:00
|
|
|
$month_count = count( $months );
|
|
|
|
|
2024-06-10 12:47:18 -04:00
|
|
|
if ( ! $month_count || ( 1 === $month_count && 0 === (int) $months[0]->month ) ) {
|
2010-08-11 17:54:51 -04:00
|
|
|
return;
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2010-08-11 17:54:51 -04:00
|
|
|
|
|
|
|
$m = isset( $_GET['m'] ) ? (int) $_GET['m'] : 0;
|
2018-08-16 21:51:36 -04:00
|
|
|
?>
|
2021-02-01 09:13:00 -05:00
|
|
|
<label for="filter-by-date" class="screen-reader-text"><?php echo get_post_type_object( $post_type )->labels->filter_by_date; ?></label>
|
2014-08-07 15:44:15 -04:00
|
|
|
<select name="m" id="filter-by-date">
|
2014-05-19 01:04:16 -04:00
|
|
|
<option<?php selected( $m, 0 ); ?> value="0"><?php _e( 'All dates' ); ?></option>
|
2018-08-16 21:51:36 -04:00
|
|
|
<?php
|
|
|
|
foreach ( $months as $arc_row ) {
|
2024-06-10 12:47:18 -04:00
|
|
|
if ( 0 === (int) $arc_row->year ) {
|
2018-08-16 21:51:36 -04:00
|
|
|
continue;
|
|
|
|
}
|
2010-08-11 17:54:51 -04:00
|
|
|
|
2018-08-16 21:51:36 -04:00
|
|
|
$month = zeroise( $arc_row->month, 2 );
|
|
|
|
$year = $arc_row->year;
|
2010-08-11 17:54:51 -04:00
|
|
|
|
2018-08-16 21:51:36 -04:00
|
|
|
printf(
|
|
|
|
"<option %s value='%s'>%s</option>\n",
|
|
|
|
selected( $m, $year . $month, false ),
|
|
|
|
esc_attr( $arc_row->year . $month ),
|
2019-09-02 20:41:05 -04:00
|
|
|
/* translators: 1: Month name, 2: 4-digit year. */
|
2018-08-16 21:51:36 -04:00
|
|
|
sprintf( __( '%1$s %2$d' ), $wp_locale->get_month( $month ), $year )
|
|
|
|
);
|
|
|
|
}
|
|
|
|
?>
|
2010-08-11 17:54:51 -04:00
|
|
|
</select>
|
2018-08-16 21:51:36 -04:00
|
|
|
<?php
|
2010-08-11 17:54:51 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2020-06-25 04:56:16 -04:00
|
|
|
* Displays a view switcher.
|
2010-08-11 17:54:51 -04:00
|
|
|
*
|
|
|
|
* @since 3.1.0
|
2014-11-30 19:33:23 -05:00
|
|
|
*
|
|
|
|
* @param string $current_mode
|
2010-08-11 17:54:51 -04:00
|
|
|
*/
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
protected function view_switcher( $current_mode ) {
|
2018-08-16 21:51:36 -04:00
|
|
|
?>
|
2010-08-11 17:54:51 -04:00
|
|
|
<input type="hidden" name="mode" value="<?php echo esc_attr( $current_mode ); ?>" />
|
|
|
|
<div class="view-switch">
|
2018-08-16 21:51:36 -04:00
|
|
|
<?php
|
|
|
|
foreach ( $this->modes as $mode => $title ) {
|
2019-11-18 11:51:02 -05:00
|
|
|
$classes = array( 'view-' . $mode );
|
|
|
|
$aria_current = '';
|
|
|
|
|
2018-08-16 21:51:36 -04:00
|
|
|
if ( $current_mode === $mode ) {
|
2019-11-18 11:51:02 -05:00
|
|
|
$classes[] = 'current';
|
|
|
|
$aria_current = ' aria-current="page"';
|
2018-08-16 21:51:36 -04:00
|
|
|
}
|
2020-07-12 07:36:04 -04:00
|
|
|
|
2018-08-16 21:51:36 -04:00
|
|
|
printf(
|
2023-07-18 10:09:21 -04:00
|
|
|
"<a href='%s' class='%s' id='view-switch-$mode'$aria_current>" .
|
|
|
|
"<span class='screen-reader-text'>%s</span>" .
|
|
|
|
"</a>\n",
|
2020-06-05 17:13:10 -04:00
|
|
|
esc_url( remove_query_arg( 'attachment-filter', add_query_arg( 'mode', $mode ) ) ),
|
2018-08-16 21:51:36 -04:00
|
|
|
implode( ' ', $classes ),
|
|
|
|
$title
|
|
|
|
);
|
|
|
|
}
|
2010-08-11 17:54:51 -04:00
|
|
|
?>
|
|
|
|
</div>
|
2018-08-16 21:51:36 -04:00
|
|
|
<?php
|
2010-08-11 17:54:51 -04:00
|
|
|
}
|
|
|
|
|
2010-08-18 12:41:58 -04:00
|
|
|
/**
|
2020-06-25 04:56:16 -04:00
|
|
|
* Displays a comment count bubble.
|
2010-08-18 12:30:27 -04:00
|
|
|
*
|
|
|
|
* @since 3.1.0
|
|
|
|
*
|
2014-07-03 15:28:14 -04:00
|
|
|
* @param int $post_id The post ID.
|
|
|
|
* @param int $pending_comments Number of pending comments.
|
2010-08-18 12:30:27 -04:00
|
|
|
*/
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
protected function comments_bubble( $post_id, $pending_comments ) {
|
2023-11-17 12:11:21 -05:00
|
|
|
$post_object = get_post( $post_id );
|
|
|
|
$edit_post_cap = $post_object ? 'edit_post' : 'edit_posts';
|
|
|
|
|
|
|
|
if ( ! current_user_can( $edit_post_cap, $post_id )
|
2024-01-15 12:42:18 -05:00
|
|
|
&& ( post_password_required( $post_id )
|
2023-11-17 12:11:21 -05:00
|
|
|
|| ! current_user_can( 'read_post', $post_id ) )
|
|
|
|
) {
|
|
|
|
// The user has no access to the post and thus cannot see the comments.
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2015-07-10 17:44:25 -04:00
|
|
|
$approved_comments = get_comments_number();
|
2010-08-18 12:30:27 -04:00
|
|
|
|
2015-07-10 17:44:25 -04:00
|
|
|
$approved_comments_number = number_format_i18n( $approved_comments );
|
2017-11-30 18:11:00 -05:00
|
|
|
$pending_comments_number = number_format_i18n( $pending_comments );
|
2010-08-18 12:30:27 -04:00
|
|
|
|
I18N: Improve translator comments.
* Add missing translator comments.
* Fix placement of some translator comments. Translator comments should be on the line directly above the line containing the translation function call for optimal compatibility with various `.pot` file generation tools. The CS auto-fixing, which changed some inconsistent function calls to multi-line function calls, is part of the reason why this was no longer the case for a select group of translator comments.
Includes minor code layout fixes.
Polyglots, rejoice! All WordPress core files now have translator comments for all strings with placeholders!
Props jrf, subrataemfluence, GaryJ, webdados, Dency, swissspidy, alvarogois, marcomartins, mihaiiceyro, vladwtz, niq1982, flipkeijzer, michielatyoast, chandrapatel, thrijith, joshuanoyce, FesoVik, tessak22, bhaktirajdev, cleancoded, dhavalkasvala, garrett-eclipse, bibliofille, socalchristina, priyankkpatel, 5hel2l2y, adamsilverstein, JeffPaul, pierlo, SergeyBiryukov.
Fixes #44360.
Built from https://develop.svn.wordpress.org/trunk@45926
git-svn-id: http://core.svn.wordpress.org/trunk@45737 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-09-01 13:13:59 -04:00
|
|
|
$approved_only_phrase = sprintf(
|
2019-09-02 20:41:05 -04:00
|
|
|
/* translators: %s: Number of comments. */
|
I18N: Improve translator comments.
* Add missing translator comments.
* Fix placement of some translator comments. Translator comments should be on the line directly above the line containing the translation function call for optimal compatibility with various `.pot` file generation tools. The CS auto-fixing, which changed some inconsistent function calls to multi-line function calls, is part of the reason why this was no longer the case for a select group of translator comments.
Includes minor code layout fixes.
Polyglots, rejoice! All WordPress core files now have translator comments for all strings with placeholders!
Props jrf, subrataemfluence, GaryJ, webdados, Dency, swissspidy, alvarogois, marcomartins, mihaiiceyro, vladwtz, niq1982, flipkeijzer, michielatyoast, chandrapatel, thrijith, joshuanoyce, FesoVik, tessak22, bhaktirajdev, cleancoded, dhavalkasvala, garrett-eclipse, bibliofille, socalchristina, priyankkpatel, 5hel2l2y, adamsilverstein, JeffPaul, pierlo, SergeyBiryukov.
Fixes #44360.
Built from https://develop.svn.wordpress.org/trunk@45926
git-svn-id: http://core.svn.wordpress.org/trunk@45737 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-09-01 13:13:59 -04:00
|
|
|
_n( '%s comment', '%s comments', $approved_comments ),
|
|
|
|
$approved_comments_number
|
|
|
|
);
|
|
|
|
|
|
|
|
$approved_phrase = sprintf(
|
2019-09-02 20:41:05 -04:00
|
|
|
/* translators: %s: Number of comments. */
|
I18N: Improve translator comments.
* Add missing translator comments.
* Fix placement of some translator comments. Translator comments should be on the line directly above the line containing the translation function call for optimal compatibility with various `.pot` file generation tools. The CS auto-fixing, which changed some inconsistent function calls to multi-line function calls, is part of the reason why this was no longer the case for a select group of translator comments.
Includes minor code layout fixes.
Polyglots, rejoice! All WordPress core files now have translator comments for all strings with placeholders!
Props jrf, subrataemfluence, GaryJ, webdados, Dency, swissspidy, alvarogois, marcomartins, mihaiiceyro, vladwtz, niq1982, flipkeijzer, michielatyoast, chandrapatel, thrijith, joshuanoyce, FesoVik, tessak22, bhaktirajdev, cleancoded, dhavalkasvala, garrett-eclipse, bibliofille, socalchristina, priyankkpatel, 5hel2l2y, adamsilverstein, JeffPaul, pierlo, SergeyBiryukov.
Fixes #44360.
Built from https://develop.svn.wordpress.org/trunk@45926
git-svn-id: http://core.svn.wordpress.org/trunk@45737 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-09-01 13:13:59 -04:00
|
|
|
_n( '%s approved comment', '%s approved comments', $approved_comments ),
|
|
|
|
$approved_comments_number
|
|
|
|
);
|
|
|
|
|
|
|
|
$pending_phrase = sprintf(
|
2019-09-02 20:41:05 -04:00
|
|
|
/* translators: %s: Number of comments. */
|
I18N: Improve translator comments.
* Add missing translator comments.
* Fix placement of some translator comments. Translator comments should be on the line directly above the line containing the translation function call for optimal compatibility with various `.pot` file generation tools. The CS auto-fixing, which changed some inconsistent function calls to multi-line function calls, is part of the reason why this was no longer the case for a select group of translator comments.
Includes minor code layout fixes.
Polyglots, rejoice! All WordPress core files now have translator comments for all strings with placeholders!
Props jrf, subrataemfluence, GaryJ, webdados, Dency, swissspidy, alvarogois, marcomartins, mihaiiceyro, vladwtz, niq1982, flipkeijzer, michielatyoast, chandrapatel, thrijith, joshuanoyce, FesoVik, tessak22, bhaktirajdev, cleancoded, dhavalkasvala, garrett-eclipse, bibliofille, socalchristina, priyankkpatel, 5hel2l2y, adamsilverstein, JeffPaul, pierlo, SergeyBiryukov.
Fixes #44360.
Built from https://develop.svn.wordpress.org/trunk@45926
git-svn-id: http://core.svn.wordpress.org/trunk@45737 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-09-01 13:13:59 -04:00
|
|
|
_n( '%s pending comment', '%s pending comments', $pending_comments ),
|
|
|
|
$pending_comments_number
|
|
|
|
);
|
2010-08-18 12:30:27 -04:00
|
|
|
|
2015-07-10 17:44:25 -04:00
|
|
|
if ( ! $approved_comments && ! $pending_comments ) {
|
Comments: Don't display edit links to trashed post comments.
If a post is in the trash, the comments bubble won't link to the comments list.
Fixes: #37826.
Props: swissspidy, helen, FolioVision, DrewAPicture, stevenlinx, donmhico, birgire, garrett-eclipse, andraganescu, johnbillion.
Built from https://develop.svn.wordpress.org/trunk@48050
git-svn-id: http://core.svn.wordpress.org/trunk@47817 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-06-15 19:06:08 -04:00
|
|
|
// No comments at all.
|
2017-11-30 18:11:00 -05:00
|
|
|
printf(
|
2023-07-18 10:09:21 -04:00
|
|
|
'<span aria-hidden="true">—</span>' .
|
|
|
|
'<span class="screen-reader-text">%s</span>',
|
2015-07-10 17:44:25 -04:00
|
|
|
__( 'No comments' )
|
|
|
|
);
|
Comments: Don't display edit links to trashed post comments.
If a post is in the trash, the comments bubble won't link to the comments list.
Fixes: #37826.
Props: swissspidy, helen, FolioVision, DrewAPicture, stevenlinx, donmhico, birgire, garrett-eclipse, andraganescu, johnbillion.
Built from https://develop.svn.wordpress.org/trunk@48050
git-svn-id: http://core.svn.wordpress.org/trunk@47817 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-06-15 19:06:08 -04:00
|
|
|
} elseif ( $approved_comments && 'trash' === get_post_status( $post_id ) ) {
|
|
|
|
// Don't link the comment bubble for a trashed post.
|
|
|
|
printf(
|
2023-07-18 10:09:21 -04:00
|
|
|
'<span class="post-com-count post-com-count-approved">' .
|
|
|
|
'<span class="comment-count-approved" aria-hidden="true">%s</span>' .
|
|
|
|
'<span class="screen-reader-text">%s</span>' .
|
|
|
|
'</span>',
|
Comments: Don't display edit links to trashed post comments.
If a post is in the trash, the comments bubble won't link to the comments list.
Fixes: #37826.
Props: swissspidy, helen, FolioVision, DrewAPicture, stevenlinx, donmhico, birgire, garrett-eclipse, andraganescu, johnbillion.
Built from https://develop.svn.wordpress.org/trunk@48050
git-svn-id: http://core.svn.wordpress.org/trunk@47817 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-06-15 19:06:08 -04:00
|
|
|
$approved_comments_number,
|
|
|
|
$pending_comments ? $approved_phrase : $approved_only_phrase
|
|
|
|
);
|
2015-07-10 17:44:25 -04:00
|
|
|
} elseif ( $approved_comments ) {
|
Comments: Don't display edit links to trashed post comments.
If a post is in the trash, the comments bubble won't link to the comments list.
Fixes: #37826.
Props: swissspidy, helen, FolioVision, DrewAPicture, stevenlinx, donmhico, birgire, garrett-eclipse, andraganescu, johnbillion.
Built from https://develop.svn.wordpress.org/trunk@48050
git-svn-id: http://core.svn.wordpress.org/trunk@47817 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-06-15 19:06:08 -04:00
|
|
|
// Link the comment bubble to approved comments.
|
2017-11-30 18:11:00 -05:00
|
|
|
printf(
|
2023-07-18 10:09:21 -04:00
|
|
|
'<a href="%s" class="post-com-count post-com-count-approved">' .
|
|
|
|
'<span class="comment-count-approved" aria-hidden="true">%s</span>' .
|
|
|
|
'<span class="screen-reader-text">%s</span>' .
|
|
|
|
'</a>',
|
2017-11-30 18:11:00 -05:00
|
|
|
esc_url(
|
|
|
|
add_query_arg(
|
|
|
|
array(
|
|
|
|
'p' => $post_id,
|
|
|
|
'comment_status' => 'approved',
|
2018-08-16 21:51:36 -04:00
|
|
|
),
|
|
|
|
admin_url( 'edit-comments.php' )
|
2017-11-30 18:11:00 -05:00
|
|
|
)
|
|
|
|
),
|
2015-07-10 17:44:25 -04:00
|
|
|
$approved_comments_number,
|
|
|
|
$pending_comments ? $approved_phrase : $approved_only_phrase
|
|
|
|
);
|
|
|
|
} else {
|
Comments: Don't display edit links to trashed post comments.
If a post is in the trash, the comments bubble won't link to the comments list.
Fixes: #37826.
Props: swissspidy, helen, FolioVision, DrewAPicture, stevenlinx, donmhico, birgire, garrett-eclipse, andraganescu, johnbillion.
Built from https://develop.svn.wordpress.org/trunk@48050
git-svn-id: http://core.svn.wordpress.org/trunk@47817 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-06-15 19:06:08 -04:00
|
|
|
// Don't link the comment bubble when there are no approved comments.
|
2017-11-30 18:11:00 -05:00
|
|
|
printf(
|
2023-07-18 10:09:21 -04:00
|
|
|
'<span class="post-com-count post-com-count-no-comments">' .
|
|
|
|
'<span class="comment-count comment-count-no-comments" aria-hidden="true">%s</span>' .
|
|
|
|
'<span class="screen-reader-text">%s</span>' .
|
|
|
|
'</span>',
|
2015-07-10 17:44:25 -04:00
|
|
|
$approved_comments_number,
|
I18N: Mark screen reader strings as such with translator comments.
This aims to provide better context for translators and make it easier to determine that some strings contain hidden accessibility text and are not displayed in the UI.
Props kebbet, mercime, pavelevap, ocean90, swissspidy, Chouby, jipmoors, afercia, desrosj, costdev, audrasjb, SergeyBiryukov.
Fixes #29748.
Built from https://develop.svn.wordpress.org/trunk@55276
git-svn-id: http://core.svn.wordpress.org/trunk@54809 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-07 12:10:21 -05:00
|
|
|
$pending_comments ?
|
|
|
|
/* translators: Hidden accessibility text. */
|
|
|
|
__( 'No approved comments' ) :
|
|
|
|
/* translators: Hidden accessibility text. */
|
|
|
|
__( 'No comments' )
|
2015-07-10 17:44:25 -04:00
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
if ( $pending_comments ) {
|
2017-11-30 18:11:00 -05:00
|
|
|
printf(
|
2023-07-18 10:09:21 -04:00
|
|
|
'<a href="%s" class="post-com-count post-com-count-pending">' .
|
|
|
|
'<span class="comment-count-pending" aria-hidden="true">%s</span>' .
|
|
|
|
'<span class="screen-reader-text">%s</span>' .
|
|
|
|
'</a>',
|
2017-11-30 18:11:00 -05:00
|
|
|
esc_url(
|
|
|
|
add_query_arg(
|
|
|
|
array(
|
|
|
|
'p' => $post_id,
|
|
|
|
'comment_status' => 'moderated',
|
2018-08-16 21:51:36 -04:00
|
|
|
),
|
|
|
|
admin_url( 'edit-comments.php' )
|
2017-11-30 18:11:00 -05:00
|
|
|
)
|
|
|
|
),
|
2015-07-10 17:44:25 -04:00
|
|
|
$pending_comments_number,
|
|
|
|
$pending_phrase
|
|
|
|
);
|
2015-08-20 12:36:25 -04:00
|
|
|
} else {
|
2017-11-30 18:11:00 -05:00
|
|
|
printf(
|
2023-07-18 10:09:21 -04:00
|
|
|
'<span class="post-com-count post-com-count-pending post-com-count-no-pending">' .
|
|
|
|
'<span class="comment-count comment-count-no-pending" aria-hidden="true">%s</span>' .
|
|
|
|
'<span class="screen-reader-text">%s</span>' .
|
|
|
|
'</span>',
|
2015-08-20 12:36:25 -04:00
|
|
|
$pending_comments_number,
|
I18N: Mark screen reader strings as such with translator comments.
This aims to provide better context for translators and make it easier to determine that some strings contain hidden accessibility text and are not displayed in the UI.
Props kebbet, mercime, pavelevap, ocean90, swissspidy, Chouby, jipmoors, afercia, desrosj, costdev, audrasjb, SergeyBiryukov.
Fixes #29748.
Built from https://develop.svn.wordpress.org/trunk@55276
git-svn-id: http://core.svn.wordpress.org/trunk@54809 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-07 12:10:21 -05:00
|
|
|
$approved_comments ?
|
|
|
|
/* translators: Hidden accessibility text. */
|
|
|
|
__( 'No pending comments' ) :
|
|
|
|
/* translators: Hidden accessibility text. */
|
|
|
|
__( 'No comments' )
|
2015-08-20 12:36:25 -04:00
|
|
|
);
|
2015-07-10 17:44:25 -04:00
|
|
|
}
|
2010-08-18 12:30:27 -04:00
|
|
|
}
|
|
|
|
|
2010-08-11 17:54:51 -04:00
|
|
|
/**
|
2020-06-25 04:56:16 -04:00
|
|
|
* Gets the current page number.
|
2010-08-11 17:54:51 -04:00
|
|
|
*
|
|
|
|
* @since 3.1.0
|
|
|
|
*
|
|
|
|
* @return int
|
|
|
|
*/
|
2014-07-11 23:27:14 -04:00
|
|
|
public function get_pagenum() {
|
2010-11-18 12:00:24 -05:00
|
|
|
$pagenum = isset( $_REQUEST['paged'] ) ? absint( $_REQUEST['paged'] ) : 0;
|
2010-10-19 03:48:22 -04:00
|
|
|
|
2017-11-30 18:11:00 -05:00
|
|
|
if ( isset( $this->_pagination_args['total_pages'] ) && $pagenum > $this->_pagination_args['total_pages'] ) {
|
2011-01-12 12:24:34 -05:00
|
|
|
$pagenum = $this->_pagination_args['total_pages'];
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2011-01-12 12:24:34 -05:00
|
|
|
|
2010-08-11 17:54:51 -04:00
|
|
|
return max( 1, $pagenum );
|
|
|
|
}
|
|
|
|
|
2010-09-05 11:15:46 -04:00
|
|
|
/**
|
2020-06-25 04:56:16 -04:00
|
|
|
* Gets the number of items to display on a single page.
|
2010-09-05 11:15:46 -04:00
|
|
|
*
|
|
|
|
* @since 3.1.0
|
|
|
|
*
|
2022-03-31 11:25:03 -04:00
|
|
|
* @param string $option User option name.
|
|
|
|
* @param int $default_value Optional. The number of items to display. Default 20.
|
2010-09-05 11:15:46 -04:00
|
|
|
* @return int
|
2010-10-19 03:48:22 -04:00
|
|
|
*/
|
Code Modernization: Rename parameters that use reserved keywords in `wp-admin/includes/class-wp-list-table.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit renames the `$default` parameter to `$default_value` in `WP_List_Table::get_items_per_page()`.
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #55327.
Built from https://develop.svn.wordpress.org/trunk@53039
git-svn-id: http://core.svn.wordpress.org/trunk@52628 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-03-31 11:21:04 -04:00
|
|
|
protected function get_items_per_page( $option, $default_value = 20 ) {
|
2010-09-05 11:15:46 -04:00
|
|
|
$per_page = (int) get_user_option( $option );
|
2017-11-30 18:11:00 -05:00
|
|
|
if ( empty( $per_page ) || $per_page < 1 ) {
|
Code Modernization: Rename parameters that use reserved keywords in `wp-admin/includes/class-wp-list-table.php`.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.
This commit renames the `$default` parameter to `$default_value` in `WP_List_Table::get_items_per_page()`.
Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029].
Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #55327.
Built from https://develop.svn.wordpress.org/trunk@53039
git-svn-id: http://core.svn.wordpress.org/trunk@52628 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-03-31 11:21:04 -04:00
|
|
|
$per_page = $default_value;
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2010-09-05 11:15:46 -04:00
|
|
|
|
2013-11-26 03:12:09 -05:00
|
|
|
/**
|
2016-05-22 14:01:30 -04:00
|
|
|
* Filters the number of items to be displayed on each page of the list table.
|
2013-11-26 03:12:09 -05:00
|
|
|
*
|
2020-07-13 18:10:07 -04:00
|
|
|
* The dynamic hook name, `$option`, refers to the `per_page` option depending
|
|
|
|
* on the type of list table in use. Possible filter names include:
|
|
|
|
*
|
|
|
|
* - `edit_comments_per_page`
|
|
|
|
* - `sites_network_per_page`
|
|
|
|
* - `site_themes_network_per_page`
|
2024-06-25 04:59:21 -04:00
|
|
|
* - `themes_network_per_page`
|
2020-07-13 18:10:07 -04:00
|
|
|
* - `users_network_per_page`
|
|
|
|
* - `edit_post_per_page`
|
2024-06-25 04:59:21 -04:00
|
|
|
* - `edit_page_per_page`
|
2020-07-13 18:10:07 -04:00
|
|
|
* - `edit_{$post_type}_per_page`
|
|
|
|
* - `edit_post_tag_per_page`
|
|
|
|
* - `edit_category_per_page`
|
|
|
|
* - `edit_{$taxonomy}_per_page`
|
|
|
|
* - `site_users_network_per_page`
|
|
|
|
* - `users_per_page`
|
2013-11-26 03:12:09 -05:00
|
|
|
*
|
|
|
|
* @since 2.9.0
|
|
|
|
*
|
|
|
|
* @param int $per_page Number of items to be displayed. Default 20.
|
|
|
|
*/
|
2016-12-13 23:18:42 -05:00
|
|
|
return (int) apply_filters( "{$option}", $per_page );
|
2010-09-05 11:15:46 -04:00
|
|
|
}
|
|
|
|
|
2010-08-11 17:54:51 -04:00
|
|
|
/**
|
2020-06-25 04:56:16 -04:00
|
|
|
* Displays the pagination.
|
2010-08-11 17:54:51 -04:00
|
|
|
*
|
|
|
|
* @since 3.1.0
|
2014-11-30 19:33:23 -05:00
|
|
|
*
|
2024-02-16 16:47:12 -05:00
|
|
|
* @param string $which The location of the pagination: Either 'top' or 'bottom'.
|
2010-08-11 17:54:51 -04:00
|
|
|
*/
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
protected function pagination( $which ) {
|
2014-05-13 01:27:14 -04:00
|
|
|
if ( empty( $this->_pagination_args ) ) {
|
2010-08-11 17:54:51 -04:00
|
|
|
return;
|
2014-05-13 01:27:14 -04:00
|
|
|
}
|
2010-08-11 17:54:51 -04:00
|
|
|
|
2017-11-30 18:11:00 -05:00
|
|
|
$total_items = $this->_pagination_args['total_items'];
|
|
|
|
$total_pages = $this->_pagination_args['total_pages'];
|
2014-05-13 01:27:14 -04:00
|
|
|
$infinite_scroll = false;
|
|
|
|
if ( isset( $this->_pagination_args['infinite_scroll'] ) ) {
|
|
|
|
$infinite_scroll = $this->_pagination_args['infinite_scroll'];
|
|
|
|
}
|
2010-08-11 17:54:51 -04:00
|
|
|
|
2015-10-06 21:28:25 -04:00
|
|
|
if ( 'top' === $which && $total_pages > 1 ) {
|
|
|
|
$this->screen->render_screen_reader_content( 'heading_pagination' );
|
|
|
|
}
|
|
|
|
|
I18N: Improve translator comments.
* Add missing translator comments.
* Fix placement of some translator comments. Translator comments should be on the line directly above the line containing the translation function call for optimal compatibility with various `.pot` file generation tools. The CS auto-fixing, which changed some inconsistent function calls to multi-line function calls, is part of the reason why this was no longer the case for a select group of translator comments.
Includes minor code layout fixes.
Polyglots, rejoice! All WordPress core files now have translator comments for all strings with placeholders!
Props jrf, subrataemfluence, GaryJ, webdados, Dency, swissspidy, alvarogois, marcomartins, mihaiiceyro, vladwtz, niq1982, flipkeijzer, michielatyoast, chandrapatel, thrijith, joshuanoyce, FesoVik, tessak22, bhaktirajdev, cleancoded, dhavalkasvala, garrett-eclipse, bibliofille, socalchristina, priyankkpatel, 5hel2l2y, adamsilverstein, JeffPaul, pierlo, SergeyBiryukov.
Fixes #44360.
Built from https://develop.svn.wordpress.org/trunk@45926
git-svn-id: http://core.svn.wordpress.org/trunk@45737 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-09-01 13:13:59 -04:00
|
|
|
$output = '<span class="displaying-num">' . sprintf(
|
2019-09-02 20:41:05 -04:00
|
|
|
/* translators: %s: Number of items. */
|
I18N: Improve translator comments.
* Add missing translator comments.
* Fix placement of some translator comments. Translator comments should be on the line directly above the line containing the translation function call for optimal compatibility with various `.pot` file generation tools. The CS auto-fixing, which changed some inconsistent function calls to multi-line function calls, is part of the reason why this was no longer the case for a select group of translator comments.
Includes minor code layout fixes.
Polyglots, rejoice! All WordPress core files now have translator comments for all strings with placeholders!
Props jrf, subrataemfluence, GaryJ, webdados, Dency, swissspidy, alvarogois, marcomartins, mihaiiceyro, vladwtz, niq1982, flipkeijzer, michielatyoast, chandrapatel, thrijith, joshuanoyce, FesoVik, tessak22, bhaktirajdev, cleancoded, dhavalkasvala, garrett-eclipse, bibliofille, socalchristina, priyankkpatel, 5hel2l2y, adamsilverstein, JeffPaul, pierlo, SergeyBiryukov.
Fixes #44360.
Built from https://develop.svn.wordpress.org/trunk@45926
git-svn-id: http://core.svn.wordpress.org/trunk@45737 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-09-01 13:13:59 -04:00
|
|
|
_n( '%s item', '%s items', $total_items ),
|
|
|
|
number_format_i18n( $total_items )
|
|
|
|
) . '</span>';
|
2010-08-11 17:54:51 -04:00
|
|
|
|
2017-11-30 18:11:00 -05:00
|
|
|
$current = $this->get_pagenum();
|
2016-06-08 21:56:27 -04:00
|
|
|
$removable_query_args = wp_removable_query_args();
|
2010-08-11 17:54:51 -04:00
|
|
|
|
2012-08-30 09:33:00 -04:00
|
|
|
$current_url = set_url_scheme( 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );
|
2011-02-09 12:35:36 -05:00
|
|
|
|
2016-06-08 21:56:27 -04:00
|
|
|
$current_url = remove_query_arg( $removable_query_args, $current_url );
|
2010-08-11 17:54:51 -04:00
|
|
|
|
|
|
|
$page_links = array();
|
|
|
|
|
2015-06-05 01:01:25 -04:00
|
|
|
$total_pages_before = '<span class="paging-input">';
|
2016-06-29 09:30:28 -04:00
|
|
|
$total_pages_after = '</span></span>';
|
2015-06-05 01:01:25 -04:00
|
|
|
|
2019-07-01 08:52:01 -04:00
|
|
|
$disable_first = false;
|
|
|
|
$disable_last = false;
|
|
|
|
$disable_prev = false;
|
|
|
|
$disable_next = false;
|
2015-06-25 16:32:26 -04:00
|
|
|
|
2024-06-10 12:47:18 -04:00
|
|
|
if ( 1 === $current ) {
|
2015-06-25 16:32:26 -04:00
|
|
|
$disable_first = true;
|
2017-11-30 18:11:00 -05:00
|
|
|
$disable_prev = true;
|
|
|
|
}
|
2024-06-10 12:47:18 -04:00
|
|
|
if ( $total_pages === $current ) {
|
2015-06-25 16:32:26 -04:00
|
|
|
$disable_last = true;
|
|
|
|
$disable_next = true;
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2015-06-25 16:32:26 -04:00
|
|
|
|
|
|
|
if ( $disable_first ) {
|
2018-04-29 12:25:21 -04:00
|
|
|
$page_links[] = '<span class="tablenav-pages-navspan button disabled" aria-hidden="true">«</span>';
|
2015-06-25 16:32:26 -04:00
|
|
|
} else {
|
2017-11-30 18:11:00 -05:00
|
|
|
$page_links[] = sprintf(
|
2023-07-18 10:09:21 -04:00
|
|
|
"<a class='first-page button' href='%s'>" .
|
|
|
|
"<span class='screen-reader-text'>%s</span>" .
|
|
|
|
"<span aria-hidden='true'>%s</span>" .
|
|
|
|
'</a>',
|
2015-06-25 16:32:26 -04:00
|
|
|
esc_url( remove_query_arg( 'paged', $current_url ) ),
|
I18N: Mark screen reader strings as such with translator comments.
This aims to provide better context for translators and make it easier to determine that some strings contain hidden accessibility text and are not displayed in the UI.
Props kebbet, mercime, pavelevap, ocean90, swissspidy, Chouby, jipmoors, afercia, desrosj, costdev, audrasjb, SergeyBiryukov.
Fixes #29748.
Built from https://develop.svn.wordpress.org/trunk@55276
git-svn-id: http://core.svn.wordpress.org/trunk@54809 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-07 12:10:21 -05:00
|
|
|
/* translators: Hidden accessibility text. */
|
2015-06-25 16:32:26 -04:00
|
|
|
__( 'First page' ),
|
|
|
|
'«'
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
if ( $disable_prev ) {
|
2018-04-29 12:25:21 -04:00
|
|
|
$page_links[] = '<span class="tablenav-pages-navspan button disabled" aria-hidden="true">‹</span>';
|
2015-06-25 16:32:26 -04:00
|
|
|
} else {
|
2017-11-30 18:11:00 -05:00
|
|
|
$page_links[] = sprintf(
|
2023-07-18 10:09:21 -04:00
|
|
|
"<a class='prev-page button' href='%s'>" .
|
|
|
|
"<span class='screen-reader-text'>%s</span>" .
|
|
|
|
"<span aria-hidden='true'>%s</span>" .
|
|
|
|
'</a>',
|
2017-11-30 18:11:00 -05:00
|
|
|
esc_url( add_query_arg( 'paged', max( 1, $current - 1 ), $current_url ) ),
|
I18N: Mark screen reader strings as such with translator comments.
This aims to provide better context for translators and make it easier to determine that some strings contain hidden accessibility text and are not displayed in the UI.
Props kebbet, mercime, pavelevap, ocean90, swissspidy, Chouby, jipmoors, afercia, desrosj, costdev, audrasjb, SergeyBiryukov.
Fixes #29748.
Built from https://develop.svn.wordpress.org/trunk@55276
git-svn-id: http://core.svn.wordpress.org/trunk@54809 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-07 12:10:21 -05:00
|
|
|
/* translators: Hidden accessibility text. */
|
2015-06-25 16:32:26 -04:00
|
|
|
__( 'Previous page' ),
|
|
|
|
'‹'
|
|
|
|
);
|
2014-05-13 01:27:14 -04:00
|
|
|
}
|
2010-08-11 17:54:51 -04:00
|
|
|
|
2015-09-22 02:06:25 -04:00
|
|
|
if ( 'bottom' === $which ) {
|
2015-06-05 01:01:25 -04:00
|
|
|
$html_current_page = $current;
|
2023-07-18 10:09:21 -04:00
|
|
|
$total_pages_before = sprintf(
|
|
|
|
'<span class="screen-reader-text">%s</span>' .
|
|
|
|
'<span id="table-paging" class="paging-input">' .
|
|
|
|
'<span class="tablenav-paging-text">',
|
I18N: Mark screen reader strings as such with translator comments.
This aims to provide better context for translators and make it easier to determine that some strings contain hidden accessibility text and are not displayed in the UI.
Props kebbet, mercime, pavelevap, ocean90, swissspidy, Chouby, jipmoors, afercia, desrosj, costdev, audrasjb, SergeyBiryukov.
Fixes #29748.
Built from https://develop.svn.wordpress.org/trunk@55276
git-svn-id: http://core.svn.wordpress.org/trunk@54809 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-07 12:10:21 -05:00
|
|
|
/* translators: Hidden accessibility text. */
|
2023-07-18 10:09:21 -04:00
|
|
|
__( 'Current Page' )
|
|
|
|
);
|
2014-05-13 01:27:14 -04:00
|
|
|
} else {
|
2017-11-30 18:11:00 -05:00
|
|
|
$html_current_page = sprintf(
|
2023-07-18 10:09:21 -04:00
|
|
|
'<label for="current-page-selector" class="screen-reader-text">%s</label>' .
|
|
|
|
"<input class='current-page' id='current-page-selector' type='text'
|
|
|
|
name='paged' value='%s' size='%d' aria-describedby='table-paging' />" .
|
|
|
|
"<span class='tablenav-paging-text'>",
|
|
|
|
/* translators: Hidden accessibility text. */
|
|
|
|
__( 'Current Page' ),
|
2011-01-16 16:47:24 -05:00
|
|
|
$current,
|
|
|
|
strlen( $total_pages )
|
|
|
|
);
|
2014-05-13 01:27:14 -04:00
|
|
|
}
|
2023-07-18 10:09:21 -04:00
|
|
|
|
2010-08-11 17:54:51 -04:00
|
|
|
$html_total_pages = sprintf( "<span class='total-pages'>%s</span>", number_format_i18n( $total_pages ) );
|
2023-07-18 10:09:21 -04:00
|
|
|
|
|
|
|
$page_links[] = $total_pages_before . sprintf(
|
2019-09-02 20:41:05 -04:00
|
|
|
/* translators: 1: Current page, 2: Total pages. */
|
I18N: Improve translator comments.
* Add missing translator comments.
* Fix placement of some translator comments. Translator comments should be on the line directly above the line containing the translation function call for optimal compatibility with various `.pot` file generation tools. The CS auto-fixing, which changed some inconsistent function calls to multi-line function calls, is part of the reason why this was no longer the case for a select group of translator comments.
Includes minor code layout fixes.
Polyglots, rejoice! All WordPress core files now have translator comments for all strings with placeholders!
Props jrf, subrataemfluence, GaryJ, webdados, Dency, swissspidy, alvarogois, marcomartins, mihaiiceyro, vladwtz, niq1982, flipkeijzer, michielatyoast, chandrapatel, thrijith, joshuanoyce, FesoVik, tessak22, bhaktirajdev, cleancoded, dhavalkasvala, garrett-eclipse, bibliofille, socalchristina, priyankkpatel, 5hel2l2y, adamsilverstein, JeffPaul, pierlo, SergeyBiryukov.
Fixes #44360.
Built from https://develop.svn.wordpress.org/trunk@45926
git-svn-id: http://core.svn.wordpress.org/trunk@45737 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-09-01 13:13:59 -04:00
|
|
|
_x( '%1$s of %2$s', 'paging' ),
|
|
|
|
$html_current_page,
|
|
|
|
$html_total_pages
|
|
|
|
) . $total_pages_after;
|
2010-08-11 17:54:51 -04:00
|
|
|
|
2015-06-25 16:32:26 -04:00
|
|
|
if ( $disable_next ) {
|
2018-04-29 12:25:21 -04:00
|
|
|
$page_links[] = '<span class="tablenav-pages-navspan button disabled" aria-hidden="true">›</span>';
|
2015-06-25 16:32:26 -04:00
|
|
|
} else {
|
2017-11-30 18:11:00 -05:00
|
|
|
$page_links[] = sprintf(
|
2023-07-18 10:09:21 -04:00
|
|
|
"<a class='next-page button' href='%s'>" .
|
|
|
|
"<span class='screen-reader-text'>%s</span>" .
|
|
|
|
"<span aria-hidden='true'>%s</span>" .
|
|
|
|
'</a>',
|
2017-11-30 18:11:00 -05:00
|
|
|
esc_url( add_query_arg( 'paged', min( $total_pages, $current + 1 ), $current_url ) ),
|
I18N: Mark screen reader strings as such with translator comments.
This aims to provide better context for translators and make it easier to determine that some strings contain hidden accessibility text and are not displayed in the UI.
Props kebbet, mercime, pavelevap, ocean90, swissspidy, Chouby, jipmoors, afercia, desrosj, costdev, audrasjb, SergeyBiryukov.
Fixes #29748.
Built from https://develop.svn.wordpress.org/trunk@55276
git-svn-id: http://core.svn.wordpress.org/trunk@54809 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-07 12:10:21 -05:00
|
|
|
/* translators: Hidden accessibility text. */
|
2015-06-25 16:32:26 -04:00
|
|
|
__( 'Next page' ),
|
|
|
|
'›'
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
if ( $disable_last ) {
|
2018-04-29 12:25:21 -04:00
|
|
|
$page_links[] = '<span class="tablenav-pages-navspan button disabled" aria-hidden="true">»</span>';
|
2015-06-25 16:32:26 -04:00
|
|
|
} else {
|
2017-11-30 18:11:00 -05:00
|
|
|
$page_links[] = sprintf(
|
2023-07-18 10:09:21 -04:00
|
|
|
"<a class='last-page button' href='%s'>" .
|
|
|
|
"<span class='screen-reader-text'>%s</span>" .
|
|
|
|
"<span aria-hidden='true'>%s</span>" .
|
|
|
|
'</a>',
|
2015-06-25 16:32:26 -04:00
|
|
|
esc_url( add_query_arg( 'paged', $total_pages, $current_url ) ),
|
I18N: Mark screen reader strings as such with translator comments.
This aims to provide better context for translators and make it easier to determine that some strings contain hidden accessibility text and are not displayed in the UI.
Props kebbet, mercime, pavelevap, ocean90, swissspidy, Chouby, jipmoors, afercia, desrosj, costdev, audrasjb, SergeyBiryukov.
Fixes #29748.
Built from https://develop.svn.wordpress.org/trunk@55276
git-svn-id: http://core.svn.wordpress.org/trunk@54809 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-07 12:10:21 -05:00
|
|
|
/* translators: Hidden accessibility text. */
|
2015-06-25 16:32:26 -04:00
|
|
|
__( 'Last page' ),
|
|
|
|
'»'
|
|
|
|
);
|
|
|
|
}
|
2010-08-11 17:54:51 -04:00
|
|
|
|
2012-03-02 17:09:26 -05:00
|
|
|
$pagination_links_class = 'pagination-links';
|
2014-05-13 01:27:14 -04:00
|
|
|
if ( ! empty( $infinite_scroll ) ) {
|
2017-07-09 07:12:43 -04:00
|
|
|
$pagination_links_class .= ' hide-if-js';
|
2014-05-13 01:27:14 -04:00
|
|
|
}
|
2020-10-18 13:27:06 -04:00
|
|
|
$output .= "\n<span class='$pagination_links_class'>" . implode( "\n", $page_links ) . '</span>';
|
2010-08-11 17:54:51 -04:00
|
|
|
|
2014-05-13 01:27:14 -04:00
|
|
|
if ( $total_pages ) {
|
2011-05-04 15:45:41 -04:00
|
|
|
$page_class = $total_pages < 2 ? ' one-page' : '';
|
2014-05-13 01:27:14 -04:00
|
|
|
} else {
|
2011-05-04 15:45:41 -04:00
|
|
|
$page_class = ' no-pages';
|
2014-05-13 01:27:14 -04:00
|
|
|
}
|
2010-12-26 17:06:15 -05:00
|
|
|
$this->_pagination = "<div class='tablenav-pages{$page_class}'>$output</div>";
|
2010-08-11 17:54:51 -04:00
|
|
|
|
|
|
|
echo $this->_pagination;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2020-06-25 04:56:16 -04:00
|
|
|
* Gets a list of columns.
|
|
|
|
*
|
|
|
|
* The format is:
|
|
|
|
* - `'internal-name' => 'Title'`
|
2010-08-11 17:54:51 -04:00
|
|
|
*
|
|
|
|
* @since 3.1.0
|
2011-01-12 03:05:23 -05:00
|
|
|
* @abstract
|
2010-08-11 17:54:51 -04:00
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
*/
|
2014-07-11 23:27:14 -04:00
|
|
|
public function get_columns() {
|
2019-11-17 02:43:01 -05:00
|
|
|
die( 'function WP_List_Table::get_columns() must be overridden in a subclass.' );
|
2010-08-11 17:54:51 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2020-06-25 04:56:16 -04:00
|
|
|
* Gets a list of sortable columns.
|
2010-11-25 21:03:02 -05:00
|
|
|
*
|
2020-06-23 19:15:10 -04:00
|
|
|
* The format is:
|
|
|
|
* - `'internal-name' => 'orderby'`
|
2023-06-21 17:47:23 -04:00
|
|
|
* - `'internal-name' => array( 'orderby', bool, 'abbr', 'orderby-text', 'initially-sorted-column-order' )` -
|
2020-06-25 04:56:16 -04:00
|
|
|
* - `'internal-name' => array( 'orderby', 'asc' )` - The second element sets the initial sorting order.
|
|
|
|
* - `'internal-name' => array( 'orderby', true )` - The second element makes the initial order descending.
|
2010-08-11 17:54:51 -04:00
|
|
|
*
|
2023-06-21 17:47:23 -04:00
|
|
|
* In the second format, passing true as second parameter will make the initial
|
|
|
|
* sorting order be descending. Following parameters add a short column name to
|
2023-07-18 10:05:29 -04:00
|
|
|
* be used as 'abbr' attribute, a translatable string for the current sorting,
|
2023-06-21 17:47:23 -04:00
|
|
|
* and the initial order for the initial sorted column, 'asc' or 'desc' (default: false).
|
|
|
|
*
|
2010-08-11 17:54:51 -04:00
|
|
|
* @since 3.1.0
|
2023-06-21 17:47:23 -04:00
|
|
|
* @since 6.3.0 Added 'abbr', 'orderby-text' and 'initially-sorted-column-order'.
|
2010-08-11 17:54:51 -04:00
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
*/
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
protected function get_sortable_columns() {
|
2010-08-11 17:54:51 -04:00
|
|
|
return array();
|
|
|
|
}
|
|
|
|
|
2015-05-28 22:41:25 -04:00
|
|
|
/**
|
2015-07-12 14:32:24 -04:00
|
|
|
* Gets the name of the default primary column.
|
2015-05-28 22:41:25 -04:00
|
|
|
*
|
|
|
|
* @since 4.3.0
|
|
|
|
*
|
2015-05-30 21:29:26 -04:00
|
|
|
* @return string Name of the default primary column, in this case, an empty string.
|
2015-05-28 22:41:25 -04:00
|
|
|
*/
|
|
|
|
protected function get_default_primary_column_name() {
|
2015-07-07 11:12:27 -04:00
|
|
|
$columns = $this->get_columns();
|
2017-11-30 18:11:00 -05:00
|
|
|
$column = '';
|
2015-07-07 11:12:27 -04:00
|
|
|
|
2015-11-18 18:01:26 -05:00
|
|
|
if ( empty( $columns ) ) {
|
|
|
|
return $column;
|
|
|
|
}
|
|
|
|
|
2023-07-09 15:52:24 -04:00
|
|
|
/*
|
|
|
|
* We need a primary defined so responsive views show something,
|
|
|
|
* so let's fall back to the first non-checkbox column.
|
|
|
|
*/
|
2015-08-25 16:28:22 -04:00
|
|
|
foreach ( $columns as $col => $column_name ) {
|
2015-07-07 11:12:27 -04:00
|
|
|
if ( 'cb' === $col ) {
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
|
|
|
$column = $col;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
|
|
|
return $column;
|
2015-05-28 22:41:25 -04:00
|
|
|
}
|
|
|
|
|
2015-09-14 23:35:25 -04:00
|
|
|
/**
|
2023-06-14 02:34:27 -04:00
|
|
|
* Gets the name of the primary column.
|
|
|
|
*
|
2015-09-16 06:51:25 -04:00
|
|
|
* Public wrapper for WP_List_Table::get_default_primary_column_name().
|
2015-09-14 23:35:25 -04:00
|
|
|
*
|
|
|
|
* @since 4.4.0
|
|
|
|
*
|
|
|
|
* @return string Name of the default primary column.
|
|
|
|
*/
|
2015-09-14 16:29:26 -04:00
|
|
|
public function get_primary_column() {
|
|
|
|
return $this->get_primary_column_name();
|
|
|
|
}
|
|
|
|
|
2015-05-28 22:41:25 -04:00
|
|
|
/**
|
2015-07-12 14:32:24 -04:00
|
|
|
* Gets the name of the primary column.
|
2015-05-28 22:41:25 -04:00
|
|
|
*
|
|
|
|
* @since 4.3.0
|
|
|
|
*
|
2015-05-30 21:29:26 -04:00
|
|
|
* @return string The name of the primary column.
|
2015-05-28 22:41:25 -04:00
|
|
|
*/
|
2015-09-14 16:29:26 -04:00
|
|
|
protected function get_primary_column_name() {
|
2015-11-07 10:27:25 -05:00
|
|
|
$columns = get_column_headers( $this->screen );
|
2015-05-28 22:41:25 -04:00
|
|
|
$default = $this->get_default_primary_column_name();
|
2015-05-30 21:29:26 -04:00
|
|
|
|
2023-07-09 15:52:24 -04:00
|
|
|
/*
|
|
|
|
* If the primary column doesn't exist,
|
|
|
|
* fall back to the first non-checkbox column.
|
|
|
|
*/
|
2015-07-14 12:18:25 -04:00
|
|
|
if ( ! isset( $columns[ $default ] ) ) {
|
2020-10-18 13:18:07 -04:00
|
|
|
$default = self::get_default_primary_column_name();
|
2015-07-14 12:18:25 -04:00
|
|
|
}
|
|
|
|
|
2015-05-28 22:41:25 -04:00
|
|
|
/**
|
2016-05-22 14:01:30 -04:00
|
|
|
* Filters the name of the primary column for the current list table.
|
2015-05-28 22:41:25 -04:00
|
|
|
*
|
|
|
|
* @since 4.3.0
|
|
|
|
*
|
2015-05-30 21:29:26 -04:00
|
|
|
* @param string $default Column name default for the specific list table, e.g. 'name'.
|
|
|
|
* @param string $context Screen ID for specific list table, e.g. 'plugins'.
|
2015-05-28 22:41:25 -04:00
|
|
|
*/
|
2017-11-30 18:11:00 -05:00
|
|
|
$column = apply_filters( 'list_table_primary_column', $default, $this->screen->id );
|
2015-05-28 22:41:25 -04:00
|
|
|
|
|
|
|
if ( empty( $column ) || ! isset( $columns[ $column ] ) ) {
|
|
|
|
$column = $default;
|
|
|
|
}
|
|
|
|
|
|
|
|
return $column;
|
|
|
|
}
|
|
|
|
|
2010-08-11 17:54:51 -04:00
|
|
|
/**
|
2020-11-14 11:54:08 -05:00
|
|
|
* Gets a list of all, hidden, and sortable columns, with filter applied.
|
2010-08-11 17:54:51 -04:00
|
|
|
*
|
|
|
|
* @since 3.1.0
|
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
*/
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
protected function get_column_info() {
|
2020-01-28 19:45:18 -05:00
|
|
|
// $_column_headers is already set / cached.
|
2022-08-08 20:33:11 -04:00
|
|
|
if (
|
|
|
|
isset( $this->_column_headers ) &&
|
|
|
|
is_array( $this->_column_headers )
|
|
|
|
) {
|
2021-03-09 17:35:06 -05:00
|
|
|
/*
|
|
|
|
* Backward compatibility for `$_column_headers` format prior to WordPress 4.3.
|
|
|
|
*
|
2021-03-09 18:22:06 -05:00
|
|
|
* In WordPress 4.3 the primary column name was added as a fourth item in the
|
2021-03-09 17:35:06 -05:00
|
|
|
* column headers property. This ensures the primary column name is included
|
|
|
|
* in plugins setting the property directly in the three item format.
|
|
|
|
*/
|
2022-08-08 20:33:11 -04:00
|
|
|
if ( 4 === count( $this->_column_headers ) ) {
|
|
|
|
return $this->_column_headers;
|
|
|
|
}
|
|
|
|
|
2015-07-07 11:12:27 -04:00
|
|
|
$column_headers = array( array(), array(), array(), $this->get_primary_column_name() );
|
2015-06-10 10:59:30 -04:00
|
|
|
foreach ( $this->_column_headers as $key => $value ) {
|
|
|
|
$column_headers[ $key ] = $value;
|
|
|
|
}
|
|
|
|
|
2022-08-08 20:33:11 -04:00
|
|
|
$this->_column_headers = $column_headers;
|
|
|
|
|
|
|
|
return $this->_column_headers;
|
2015-06-09 21:46:27 -04:00
|
|
|
}
|
2010-11-25 21:03:02 -05:00
|
|
|
|
2012-09-19 08:43:31 -04:00
|
|
|
$columns = get_column_headers( $this->screen );
|
2017-11-30 18:11:00 -05:00
|
|
|
$hidden = get_hidden_columns( $this->screen );
|
2010-08-11 17:54:51 -04:00
|
|
|
|
2013-11-26 03:12:09 -05:00
|
|
|
$sortable_columns = $this->get_sortable_columns();
|
|
|
|
/**
|
2016-05-22 14:01:30 -04:00
|
|
|
* Filters the list table sortable columns for a specific screen.
|
2013-11-26 03:12:09 -05:00
|
|
|
*
|
2014-11-30 06:28:24 -05:00
|
|
|
* The dynamic portion of the hook name, `$this->screen->id`, refers
|
2020-10-10 15:14:04 -04:00
|
|
|
* to the ID of the current screen.
|
2013-11-26 03:12:09 -05:00
|
|
|
*
|
2020-07-25 14:55:03 -04:00
|
|
|
* @since 3.1.0
|
2013-11-26 03:12:09 -05:00
|
|
|
*
|
|
|
|
* @param array $sortable_columns An array of sortable columns.
|
|
|
|
*/
|
|
|
|
$_sortable = apply_filters( "manage_{$this->screen->id}_sortable_columns", $sortable_columns );
|
2010-11-25 21:03:02 -05:00
|
|
|
|
|
|
|
$sortable = array();
|
|
|
|
foreach ( $_sortable as $id => $data ) {
|
2017-11-30 18:11:00 -05:00
|
|
|
if ( empty( $data ) ) {
|
2010-11-25 21:03:02 -05:00
|
|
|
continue;
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2010-11-25 21:03:02 -05:00
|
|
|
|
|
|
|
$data = (array) $data;
|
2023-06-21 17:47:23 -04:00
|
|
|
// Descending initial sorting.
|
2017-11-30 18:11:00 -05:00
|
|
|
if ( ! isset( $data[1] ) ) {
|
2010-11-25 21:03:02 -05:00
|
|
|
$data[1] = false;
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2023-06-21 17:47:23 -04:00
|
|
|
// Current sorting translatable string.
|
|
|
|
if ( ! isset( $data[2] ) ) {
|
|
|
|
$data[2] = '';
|
|
|
|
}
|
|
|
|
// Initial view sorted column and asc/desc order, default: false.
|
|
|
|
if ( ! isset( $data[3] ) ) {
|
|
|
|
$data[3] = false;
|
|
|
|
}
|
|
|
|
// Initial order for the initial sorted column, default: false.
|
|
|
|
if ( ! isset( $data[4] ) ) {
|
|
|
|
$data[4] = false;
|
|
|
|
}
|
2010-12-13 16:21:50 -05:00
|
|
|
|
2017-11-30 18:11:00 -05:00
|
|
|
$sortable[ $id ] = $data;
|
2010-08-11 17:54:51 -04:00
|
|
|
}
|
|
|
|
|
2017-11-30 18:11:00 -05:00
|
|
|
$primary = $this->get_primary_column_name();
|
2015-05-28 22:41:25 -04:00
|
|
|
$this->_column_headers = array( $columns, $hidden, $sortable, $primary );
|
2010-11-25 21:03:02 -05:00
|
|
|
|
2010-08-11 17:54:51 -04:00
|
|
|
return $this->_column_headers;
|
|
|
|
}
|
|
|
|
|
2010-11-14 13:00:09 -05:00
|
|
|
/**
|
2020-06-25 04:56:16 -04:00
|
|
|
* Returns the number of visible columns.
|
2010-11-14 13:00:09 -05:00
|
|
|
*
|
|
|
|
* @since 3.1.0
|
|
|
|
*
|
|
|
|
* @return int
|
|
|
|
*/
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
public function get_column_count() {
|
2010-11-14 13:00:09 -05:00
|
|
|
list ( $columns, $hidden ) = $this->get_column_info();
|
2017-11-30 18:11:00 -05:00
|
|
|
$hidden = array_intersect( array_keys( $columns ), array_filter( $hidden ) );
|
2010-11-14 13:00:09 -05:00
|
|
|
return count( $columns ) - count( $hidden );
|
|
|
|
}
|
|
|
|
|
2010-08-11 17:54:51 -04:00
|
|
|
/**
|
2020-06-25 04:56:16 -04:00
|
|
|
* Prints column headers, accounting for hidden and sortable columns.
|
2010-08-11 17:54:51 -04:00
|
|
|
*
|
|
|
|
* @since 3.1.0
|
2010-08-21 14:08:42 -04:00
|
|
|
*
|
2020-06-20 08:02:12 -04:00
|
|
|
* @param bool $with_id Whether to set the ID attribute or not
|
2010-08-11 17:54:51 -04:00
|
|
|
*/
|
2014-07-13 18:09:16 -04:00
|
|
|
public function print_column_headers( $with_id = true ) {
|
List tables: A better responsive view.
Instead of truncating columns, the data that's already in the markup can now be toggled into view. Only seems appropriate to celebrate four years of contributing by finally doing the first thing I ever mocked up.
Known issues / concerns:
* Custom list tables that don't define a primary column will show nothing at all. These are not extremely common, as `WP_List_Table` isn't really recommended for plugin consumption, but it happens. We need to come up with some kind of fallback.
* Some visual elements, particularly whitespace, could use refining.
* Needs a11y review.
* Touch performance on iOS feels sluggish - is there anything we can do about that?
* Would this be better accordion-style (only one expanded at a time)?
* Is `wp_strip_all_tags()` good enough for column titles that have HTML in them? It's essentially a workaround for the fact that core's comments column does that for the icon, which maybe it shouldn't. Perhaps worth another ticket, as a markup change would be fairly independent.
* Visual hierarchy is not great when expanded (also worthy of another ticket).
* Quick edit now becomes noticeably more annoying to cancel out of, as you have to scroll all the way down and you lose your position from before it was opened. Again, worthy of another ticket.
props Michael Arestad, helen.
see #32395.
Built from https://develop.svn.wordpress.org/trunk@33016
git-svn-id: http://core.svn.wordpress.org/trunk@32987 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-06-30 21:31:25 -04:00
|
|
|
list( $columns, $hidden, $sortable, $primary ) = $this->get_column_info();
|
2010-08-11 17:54:51 -04:00
|
|
|
|
2012-08-30 09:33:00 -04:00
|
|
|
$current_url = set_url_scheme( 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );
|
2011-01-16 16:47:24 -05:00
|
|
|
$current_url = remove_query_arg( 'paged', $current_url );
|
2010-08-11 17:54:51 -04:00
|
|
|
|
2023-06-21 17:47:23 -04:00
|
|
|
// When users click on a column header to sort by other columns.
|
2015-12-07 14:16:26 -05:00
|
|
|
if ( isset( $_GET['orderby'] ) ) {
|
|
|
|
$current_orderby = $_GET['orderby'];
|
2023-06-21 17:47:23 -04:00
|
|
|
// In the initial view there's no orderby parameter.
|
2015-12-07 14:16:26 -05:00
|
|
|
} else {
|
|
|
|
$current_orderby = '';
|
|
|
|
}
|
|
|
|
|
2023-06-21 17:47:23 -04:00
|
|
|
// Not in the initial view and descending order.
|
2023-07-18 10:05:29 -04:00
|
|
|
if ( isset( $_GET['order'] ) && 'desc' === $_GET['order'] ) {
|
2015-12-07 14:16:26 -05:00
|
|
|
$current_order = 'desc';
|
|
|
|
} else {
|
2023-07-18 10:05:29 -04:00
|
|
|
// The initial view is not always 'asc', we'll take care of this below.
|
2015-12-07 14:16:26 -05:00
|
|
|
$current_order = 'asc';
|
|
|
|
}
|
2010-08-11 17:54:51 -04:00
|
|
|
|
2012-07-24 14:01:22 -04:00
|
|
|
if ( ! empty( $columns['cb'] ) ) {
|
|
|
|
static $cb_counter = 1;
|
2023-09-22 15:58:16 -04:00
|
|
|
$columns['cb'] = '<input id="cb-select-all-' . $cb_counter . '" type="checkbox" />
|
|
|
|
<label for="cb-select-all-' . $cb_counter . '">' .
|
2023-06-20 21:54:19 -04:00
|
|
|
'<span class="screen-reader-text">' .
|
I18N: Mark screen reader strings as such with translator comments.
This aims to provide better context for translators and make it easier to determine that some strings contain hidden accessibility text and are not displayed in the UI.
Props kebbet, mercime, pavelevap, ocean90, swissspidy, Chouby, jipmoors, afercia, desrosj, costdev, audrasjb, SergeyBiryukov.
Fixes #29748.
Built from https://develop.svn.wordpress.org/trunk@55276
git-svn-id: http://core.svn.wordpress.org/trunk@54809 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-07 12:10:21 -05:00
|
|
|
/* translators: Hidden accessibility text. */
|
|
|
|
__( 'Select All' ) .
|
2023-06-20 21:54:19 -04:00
|
|
|
'</span>' .
|
2023-09-22 15:58:16 -04:00
|
|
|
'</label>';
|
2023-09-09 05:28:26 -04:00
|
|
|
++$cb_counter;
|
2012-07-24 14:01:22 -04:00
|
|
|
}
|
|
|
|
|
2010-08-11 17:54:51 -04:00
|
|
|
foreach ( $columns as $column_key => $column_display_name ) {
|
2023-06-21 17:47:23 -04:00
|
|
|
$class = array( 'manage-column', "column-$column_key" );
|
|
|
|
$aria_sort_attr = '';
|
|
|
|
$abbr_attr = '';
|
|
|
|
$order_text = '';
|
2010-08-11 17:54:51 -04:00
|
|
|
|
2020-04-04 23:02:11 -04:00
|
|
|
if ( in_array( $column_key, $hidden, true ) ) {
|
2015-06-10 15:47:27 -04:00
|
|
|
$class[] = 'hidden';
|
|
|
|
}
|
2010-08-11 17:54:51 -04:00
|
|
|
|
2017-11-30 18:11:00 -05:00
|
|
|
if ( 'cb' === $column_key ) {
|
2010-08-11 17:54:51 -04:00
|
|
|
$class[] = 'check-column';
|
2020-04-04 23:02:11 -04:00
|
|
|
} elseif ( in_array( $column_key, array( 'posts', 'comments', 'links' ), true ) ) {
|
2010-08-11 17:54:51 -04:00
|
|
|
$class[] = 'num';
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2010-08-11 17:54:51 -04:00
|
|
|
|
List tables: A better responsive view.
Instead of truncating columns, the data that's already in the markup can now be toggled into view. Only seems appropriate to celebrate four years of contributing by finally doing the first thing I ever mocked up.
Known issues / concerns:
* Custom list tables that don't define a primary column will show nothing at all. These are not extremely common, as `WP_List_Table` isn't really recommended for plugin consumption, but it happens. We need to come up with some kind of fallback.
* Some visual elements, particularly whitespace, could use refining.
* Needs a11y review.
* Touch performance on iOS feels sluggish - is there anything we can do about that?
* Would this be better accordion-style (only one expanded at a time)?
* Is `wp_strip_all_tags()` good enough for column titles that have HTML in them? It's essentially a workaround for the fact that core's comments column does that for the icon, which maybe it shouldn't. Perhaps worth another ticket, as a markup change would be fairly independent.
* Visual hierarchy is not great when expanded (also worthy of another ticket).
* Quick edit now becomes noticeably more annoying to cancel out of, as you have to scroll all the way down and you lose your position from before it was opened. Again, worthy of another ticket.
props Michael Arestad, helen.
see #32395.
Built from https://develop.svn.wordpress.org/trunk@33016
git-svn-id: http://core.svn.wordpress.org/trunk@32987 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-06-30 21:31:25 -04:00
|
|
|
if ( $column_key === $primary ) {
|
|
|
|
$class[] = 'column-primary';
|
|
|
|
}
|
|
|
|
|
2017-11-30 18:11:00 -05:00
|
|
|
if ( isset( $sortable[ $column_key ] ) ) {
|
2023-06-23 13:49:28 -04:00
|
|
|
$orderby = isset( $sortable[ $column_key ][0] ) ? $sortable[ $column_key ][0] : '';
|
|
|
|
$desc_first = isset( $sortable[ $column_key ][1] ) ? $sortable[ $column_key ][1] : false;
|
|
|
|
$abbr = isset( $sortable[ $column_key ][2] ) ? $sortable[ $column_key ][2] : '';
|
|
|
|
$orderby_text = isset( $sortable[ $column_key ][3] ) ? $sortable[ $column_key ][3] : '';
|
|
|
|
$initial_order = isset( $sortable[ $column_key ][4] ) ? $sortable[ $column_key ][4] : '';
|
2023-06-21 17:47:23 -04:00
|
|
|
|
|
|
|
/*
|
|
|
|
* We're in the initial view and there's no $_GET['orderby'] then check if the
|
|
|
|
* initial sorting information is set in the sortable columns and use that.
|
|
|
|
*/
|
|
|
|
if ( '' === $current_orderby && $initial_order ) {
|
|
|
|
// Use the initially sorted column $orderby as current orderby.
|
|
|
|
$current_orderby = $orderby;
|
|
|
|
// Use the initially sorted column asc/desc order as initial order.
|
|
|
|
$current_order = $initial_order;
|
|
|
|
}
|
2010-11-25 21:03:02 -05:00
|
|
|
|
2023-06-21 17:47:23 -04:00
|
|
|
/*
|
|
|
|
* True in the initial view when an initial orderby is set via get_sortable_columns()
|
|
|
|
* and true in the sorted views when the actual $_GET['orderby'] is equal to $orderby.
|
|
|
|
*/
|
2015-09-22 02:06:25 -04:00
|
|
|
if ( $current_orderby === $orderby ) {
|
2023-06-21 17:47:23 -04:00
|
|
|
// The sorted column. The `aria-sort` attribute must be set only on the sorted column.
|
2023-07-18 10:05:29 -04:00
|
|
|
if ( 'asc' === $current_order ) {
|
2023-06-21 17:47:23 -04:00
|
|
|
$order = 'desc';
|
|
|
|
$aria_sort_attr = ' aria-sort="ascending"';
|
|
|
|
} else {
|
|
|
|
$order = 'asc';
|
|
|
|
$aria_sort_attr = ' aria-sort="descending"';
|
|
|
|
}
|
2023-07-18 10:05:29 -04:00
|
|
|
|
2010-11-25 21:03:02 -05:00
|
|
|
$class[] = 'sorted';
|
|
|
|
$class[] = $current_order;
|
2010-08-11 17:54:51 -04:00
|
|
|
} else {
|
2023-06-21 17:47:23 -04:00
|
|
|
// The other sortable columns.
|
2020-06-25 07:35:13 -04:00
|
|
|
$order = strtolower( $desc_first );
|
|
|
|
|
|
|
|
if ( ! in_array( $order, array( 'desc', 'asc' ), true ) ) {
|
2020-06-23 19:15:10 -04:00
|
|
|
$order = $desc_first ? 'desc' : 'asc';
|
|
|
|
}
|
2020-06-25 04:56:16 -04:00
|
|
|
|
2023-06-23 13:49:28 -04:00
|
|
|
$class[] = 'sortable';
|
|
|
|
$class[] = 'desc' === $order ? 'asc' : 'desc';
|
2023-07-18 10:05:29 -04:00
|
|
|
|
2023-06-23 13:49:28 -04:00
|
|
|
/* translators: Hidden accessibility text. */
|
|
|
|
$asc_text = __( 'Sort ascending.' );
|
|
|
|
/* translators: Hidden accessibility text. */
|
|
|
|
$desc_text = __( 'Sort descending.' );
|
|
|
|
$order_text = 'asc' === $order ? $asc_text : $desc_text;
|
2023-06-21 17:47:23 -04:00
|
|
|
}
|
2023-07-18 10:05:29 -04:00
|
|
|
|
2023-06-21 17:47:23 -04:00
|
|
|
if ( '' !== $order_text ) {
|
|
|
|
$order_text = ' <span class="screen-reader-text">' . $order_text . '</span>';
|
2010-08-11 17:54:51 -04:00
|
|
|
}
|
2010-11-25 21:03:02 -05:00
|
|
|
|
2023-06-21 17:47:23 -04:00
|
|
|
// Print an 'abbr' attribute if a value is provided via get_sortable_columns().
|
2023-07-18 10:09:21 -04:00
|
|
|
$abbr_attr = $abbr ? ' abbr="' . esc_attr( $abbr ) . '"' : '';
|
|
|
|
|
|
|
|
$column_display_name = sprintf(
|
|
|
|
'<a href="%1$s">' .
|
|
|
|
'<span>%2$s</span>' .
|
|
|
|
'<span class="sorting-indicators">' .
|
|
|
|
'<span class="sorting-indicator asc" aria-hidden="true"></span>' .
|
|
|
|
'<span class="sorting-indicator desc" aria-hidden="true"></span>' .
|
|
|
|
'</span>' .
|
|
|
|
'%3$s' .
|
|
|
|
'</a>',
|
|
|
|
esc_url( add_query_arg( compact( 'orderby', 'order' ), $current_url ) ),
|
|
|
|
$column_display_name,
|
|
|
|
$order_text
|
|
|
|
);
|
2010-08-11 17:54:51 -04:00
|
|
|
}
|
|
|
|
|
2017-11-30 18:11:00 -05:00
|
|
|
$tag = ( 'cb' === $column_key ) ? 'td' : 'th';
|
2015-06-28 01:46:25 -04:00
|
|
|
$scope = ( 'th' === $tag ) ? 'scope="col"' : '';
|
2017-11-30 18:11:00 -05:00
|
|
|
$id = $with_id ? "id='$column_key'" : '';
|
2010-08-11 17:54:51 -04:00
|
|
|
|
2017-11-30 18:11:00 -05:00
|
|
|
if ( ! empty( $class ) ) {
|
2020-10-18 13:27:06 -04:00
|
|
|
$class = "class='" . implode( ' ', $class ) . "'";
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2010-08-11 17:54:51 -04:00
|
|
|
|
2023-06-21 17:47:23 -04:00
|
|
|
echo "<$tag $scope $id $class $aria_sort_attr $abbr_attr>$column_display_name</$tag>";
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Print a table description with information about current sorting and order.
|
|
|
|
*
|
|
|
|
* For the table initial view, information about initial orderby and order
|
|
|
|
* should be provided via get_sortable_columns().
|
|
|
|
*
|
2023-06-23 13:49:28 -04:00
|
|
|
* @since 6.3.0
|
2023-06-21 17:47:23 -04:00
|
|
|
* @access public
|
|
|
|
*/
|
|
|
|
public function print_table_description() {
|
|
|
|
list( $columns, $hidden, $sortable ) = $this->get_column_info();
|
|
|
|
|
|
|
|
if ( empty( $sortable ) ) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
// When users click on a column header to sort by other columns.
|
|
|
|
if ( isset( $_GET['orderby'] ) ) {
|
|
|
|
$current_orderby = $_GET['orderby'];
|
|
|
|
// In the initial view there's no orderby parameter.
|
|
|
|
} else {
|
|
|
|
$current_orderby = '';
|
|
|
|
}
|
|
|
|
|
|
|
|
// Not in the initial view and descending order.
|
2023-07-18 10:05:29 -04:00
|
|
|
if ( isset( $_GET['order'] ) && 'desc' === $_GET['order'] ) {
|
2023-06-21 17:47:23 -04:00
|
|
|
$current_order = 'desc';
|
|
|
|
} else {
|
2023-07-18 10:05:29 -04:00
|
|
|
// The initial view is not always 'asc', we'll take care of this below.
|
2023-06-21 17:47:23 -04:00
|
|
|
$current_order = 'asc';
|
|
|
|
}
|
|
|
|
|
|
|
|
foreach ( array_keys( $columns ) as $column_key ) {
|
|
|
|
|
|
|
|
if ( isset( $sortable[ $column_key ] ) ) {
|
2023-06-23 13:49:28 -04:00
|
|
|
$orderby = isset( $sortable[ $column_key ][0] ) ? $sortable[ $column_key ][0] : '';
|
|
|
|
$desc_first = isset( $sortable[ $column_key ][1] ) ? $sortable[ $column_key ][1] : false;
|
|
|
|
$abbr = isset( $sortable[ $column_key ][2] ) ? $sortable[ $column_key ][2] : '';
|
|
|
|
$orderby_text = isset( $sortable[ $column_key ][3] ) ? $sortable[ $column_key ][3] : '';
|
|
|
|
$initial_order = isset( $sortable[ $column_key ][4] ) ? $sortable[ $column_key ][4] : '';
|
2023-06-21 17:47:23 -04:00
|
|
|
|
|
|
|
if ( ! is_string( $orderby_text ) || '' === $orderby_text ) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
/*
|
|
|
|
* We're in the initial view and there's no $_GET['orderby'] then check if the
|
|
|
|
* initial sorting information is set in the sortable columns and use that.
|
|
|
|
*/
|
|
|
|
if ( '' === $current_orderby && $initial_order ) {
|
|
|
|
// Use the initially sorted column $orderby as current orderby.
|
|
|
|
$current_orderby = $orderby;
|
|
|
|
// Use the initially sorted column asc/desc order as initial order.
|
|
|
|
$current_order = $initial_order;
|
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* True in the initial view when an initial orderby is set via get_sortable_columns()
|
|
|
|
* and true in the sorted views when the actual $_GET['orderby'] is equal to $orderby.
|
|
|
|
*/
|
2023-07-18 10:05:29 -04:00
|
|
|
if ( $current_orderby === $orderby ) {
|
2023-06-23 13:49:28 -04:00
|
|
|
/* translators: Hidden accessibility text. */
|
|
|
|
$asc_text = __( 'Ascending.' );
|
|
|
|
/* translators: Hidden accessibility text. */
|
|
|
|
$desc_text = __( 'Descending.' );
|
|
|
|
$order_text = 'asc' === $current_order ? $asc_text : $desc_text;
|
|
|
|
echo '<caption class="screen-reader-text">' . $orderby_text . ' ' . $order_text . '</caption>';
|
2023-06-21 17:47:23 -04:00
|
|
|
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
}
|
2010-08-11 17:54:51 -04:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2019-09-29 07:04:58 -04:00
|
|
|
* Displays the table.
|
2010-08-11 17:54:51 -04:00
|
|
|
*
|
|
|
|
* @since 3.1.0
|
|
|
|
*/
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
public function display() {
|
2014-05-13 01:08:13 -04:00
|
|
|
$singular = $this->_args['singular'];
|
2010-08-11 17:54:51 -04:00
|
|
|
|
|
|
|
$this->display_tablenav( 'top' );
|
2015-10-06 21:28:25 -04:00
|
|
|
|
|
|
|
$this->screen->render_screen_reader_content( 'heading_list' );
|
2018-08-16 21:51:36 -04:00
|
|
|
?>
|
2014-01-26 15:28:12 -05:00
|
|
|
<table class="wp-list-table <?php echo implode( ' ', $this->get_table_classes() ); ?>">
|
2023-06-21 17:47:23 -04:00
|
|
|
<?php $this->print_table_description(); ?>
|
2010-08-11 17:54:51 -04:00
|
|
|
<thead>
|
|
|
|
<tr>
|
|
|
|
<?php $this->print_column_headers(); ?>
|
|
|
|
</tr>
|
|
|
|
</thead>
|
|
|
|
|
2017-11-30 18:11:00 -05:00
|
|
|
<tbody id="the-list"
|
2018-08-16 21:51:36 -04:00
|
|
|
<?php
|
|
|
|
if ( $singular ) {
|
|
|
|
echo " data-wp-lists='list:$singular'";
|
|
|
|
}
|
2017-11-30 18:11:00 -05:00
|
|
|
?>
|
|
|
|
>
|
2010-12-16 14:05:14 -05:00
|
|
|
<?php $this->display_rows_or_placeholder(); ?>
|
2010-08-11 17:54:51 -04:00
|
|
|
</tbody>
|
2015-02-22 16:48:26 -05:00
|
|
|
|
|
|
|
<tfoot>
|
|
|
|
<tr>
|
|
|
|
<?php $this->print_column_headers( false ); ?>
|
|
|
|
</tr>
|
|
|
|
</tfoot>
|
|
|
|
|
2010-08-11 17:54:51 -04:00
|
|
|
</table>
|
2018-08-16 21:51:36 -04:00
|
|
|
<?php
|
2010-08-11 17:54:51 -04:00
|
|
|
$this->display_tablenav( 'bottom' );
|
|
|
|
}
|
|
|
|
|
2010-12-16 14:05:14 -05:00
|
|
|
/**
|
2020-06-25 04:56:16 -04:00
|
|
|
* Gets a list of CSS classes for the WP_List_Table table tag.
|
2010-12-16 14:05:14 -05:00
|
|
|
*
|
|
|
|
* @since 3.1.0
|
|
|
|
*
|
2019-11-05 16:30:03 -05:00
|
|
|
* @return string[] Array of CSS classes for the table tag.
|
2010-12-16 14:05:14 -05:00
|
|
|
*/
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
protected function get_table_classes() {
|
2020-07-10 12:04:05 -04:00
|
|
|
$mode = get_user_setting( 'posts_list_mode', 'list' );
|
|
|
|
|
|
|
|
$mode_class = esc_attr( 'table-view-' . $mode );
|
2020-07-07 15:12:03 -04:00
|
|
|
|
|
|
|
return array( 'widefat', 'fixed', 'striped', $mode_class, $this->_args['plural'] );
|
2010-12-16 14:05:14 -05:00
|
|
|
}
|
|
|
|
|
2010-08-11 17:54:51 -04:00
|
|
|
/**
|
2020-06-25 04:56:16 -04:00
|
|
|
* Generates the table navigation above or below the table
|
2010-08-11 17:54:51 -04:00
|
|
|
*
|
|
|
|
* @since 3.1.0
|
2024-02-16 16:47:12 -05:00
|
|
|
* @param string $which The location of the navigation: Either 'top' or 'bottom'.
|
2010-08-11 17:54:51 -04:00
|
|
|
*/
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
protected function display_tablenav( $which ) {
|
2015-09-22 02:06:25 -04:00
|
|
|
if ( 'top' === $which ) {
|
2010-08-11 17:54:51 -04:00
|
|
|
wp_nonce_field( 'bulk-' . $this->_args['plural'] );
|
2015-09-22 02:06:25 -04:00
|
|
|
}
|
2015-09-29 20:47:27 -04:00
|
|
|
?>
|
2010-11-28 14:05:12 -05:00
|
|
|
<div class="tablenav <?php echo esc_attr( $which ); ?>">
|
2010-08-11 17:54:51 -04:00
|
|
|
|
2017-11-30 18:11:00 -05:00
|
|
|
<?php if ( $this->has_items() ) : ?>
|
2013-09-19 17:01:09 -04:00
|
|
|
<div class="alignleft actions bulkactions">
|
2014-07-24 20:20:16 -04:00
|
|
|
<?php $this->bulk_actions( $which ); ?>
|
2010-08-11 17:54:51 -04:00
|
|
|
</div>
|
2018-08-16 21:51:36 -04:00
|
|
|
<?php
|
2017-11-30 18:11:00 -05:00
|
|
|
endif;
|
2010-08-11 17:54:51 -04:00
|
|
|
$this->extra_tablenav( $which );
|
|
|
|
$this->pagination( $which );
|
2019-01-12 01:41:52 -05:00
|
|
|
?>
|
2010-08-11 17:54:51 -04:00
|
|
|
|
2010-10-31 01:13:46 -04:00
|
|
|
<br class="clear" />
|
2010-08-11 17:54:51 -04:00
|
|
|
</div>
|
2018-08-16 21:51:36 -04:00
|
|
|
<?php
|
2010-08-11 17:54:51 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2023-06-14 02:34:27 -04:00
|
|
|
* Displays extra controls between bulk actions and pagination.
|
2010-08-11 17:54:51 -04:00
|
|
|
*
|
|
|
|
* @since 3.1.0
|
2014-11-30 19:33:23 -05:00
|
|
|
*
|
|
|
|
* @param string $which
|
2010-08-11 17:54:51 -04:00
|
|
|
*/
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
protected function extra_tablenav( $which ) {}
|
2010-08-11 17:54:51 -04:00
|
|
|
|
|
|
|
/**
|
2020-06-25 04:56:16 -04:00
|
|
|
* Generates the tbody element for the list table.
|
2010-08-11 17:54:51 -04:00
|
|
|
*
|
|
|
|
* @since 3.1.0
|
|
|
|
*/
|
2014-07-13 18:09:16 -04:00
|
|
|
public function display_rows_or_placeholder() {
|
2010-12-16 14:05:14 -05:00
|
|
|
if ( $this->has_items() ) {
|
|
|
|
$this->display_rows();
|
|
|
|
} else {
|
2011-01-21 02:39:21 -05:00
|
|
|
echo '<tr class="no-items"><td class="colspanchange" colspan="' . $this->get_column_count() . '">';
|
2010-12-16 14:05:14 -05:00
|
|
|
$this->no_items();
|
|
|
|
echo '</td></tr>';
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2024-07-17 11:43:15 -04:00
|
|
|
* Generates the list table rows.
|
2010-12-16 14:05:14 -05:00
|
|
|
*
|
|
|
|
* @since 3.1.0
|
|
|
|
*/
|
2014-07-13 18:09:16 -04:00
|
|
|
public function display_rows() {
|
2017-11-30 18:11:00 -05:00
|
|
|
foreach ( $this->items as $item ) {
|
2010-09-16 16:07:39 -04:00
|
|
|
$this->single_row( $item );
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2010-09-16 16:07:39 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2020-06-25 04:56:16 -04:00
|
|
|
* Generates content for a single row of the table.
|
2010-09-16 16:07:39 -04:00
|
|
|
*
|
|
|
|
* @since 3.1.0
|
|
|
|
*
|
2020-10-18 16:53:08 -04:00
|
|
|
* @param object|array $item The current item
|
2010-09-16 16:07:39 -04:00
|
|
|
*/
|
2014-07-13 18:09:16 -04:00
|
|
|
public function single_row( $item ) {
|
2015-01-14 17:14:22 -05:00
|
|
|
echo '<tr>';
|
2013-04-28 21:10:50 -04:00
|
|
|
$this->single_row_columns( $item );
|
2010-09-18 13:21:32 -04:00
|
|
|
echo '</tr>';
|
|
|
|
}
|
2010-09-16 16:07:39 -04:00
|
|
|
|
2015-05-29 16:17:26 -04:00
|
|
|
/**
|
2020-10-18 16:53:08 -04:00
|
|
|
* @param object|array $item
|
2015-05-29 16:17:26 -04:00
|
|
|
* @param string $column_name
|
|
|
|
*/
|
2015-01-16 13:37:24 -05:00
|
|
|
protected function column_default( $item, $column_name ) {}
|
|
|
|
|
2015-05-29 16:17:26 -04:00
|
|
|
/**
|
2020-10-18 16:53:08 -04:00
|
|
|
* @param object|array $item
|
2015-05-29 16:17:26 -04:00
|
|
|
*/
|
2015-01-16 13:37:24 -05:00
|
|
|
protected function column_cb( $item ) {}
|
2015-01-16 12:42:22 -05:00
|
|
|
|
2010-09-18 13:21:32 -04:00
|
|
|
/**
|
2020-06-25 04:56:16 -04:00
|
|
|
* Generates the columns for a single row of the table.
|
2010-09-18 13:21:32 -04:00
|
|
|
*
|
|
|
|
* @since 3.1.0
|
|
|
|
*
|
2020-10-18 16:53:08 -04:00
|
|
|
* @param object|array $item The current item.
|
2010-09-18 13:21:32 -04:00
|
|
|
*/
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
protected function single_row_columns( $item ) {
|
2015-05-28 22:41:25 -04:00
|
|
|
list( $columns, $hidden, $sortable, $primary ) = $this->get_column_info();
|
2010-09-16 16:07:39 -04:00
|
|
|
|
|
|
|
foreach ( $columns as $column_name => $column_display_name ) {
|
2015-05-28 22:41:25 -04:00
|
|
|
$classes = "$column_name column-$column_name";
|
|
|
|
if ( $primary === $column_name ) {
|
|
|
|
$classes .= ' has-row-actions column-primary';
|
|
|
|
}
|
2010-09-16 16:07:39 -04:00
|
|
|
|
2020-04-04 23:02:11 -04:00
|
|
|
if ( in_array( $column_name, $hidden, true ) ) {
|
2015-06-10 15:47:27 -04:00
|
|
|
$classes .= ' hidden';
|
2015-05-28 22:41:25 -04:00
|
|
|
}
|
2010-09-16 16:07:39 -04:00
|
|
|
|
2023-07-09 15:52:24 -04:00
|
|
|
/*
|
|
|
|
* Comments column uses HTML in the display name with screen reader text.
|
|
|
|
* Strip tags to get closer to a user-friendly string.
|
|
|
|
*/
|
2021-06-08 18:21:57 -04:00
|
|
|
$data = 'data-colname="' . esc_attr( wp_strip_all_tags( $column_display_name ) ) . '"';
|
List tables: A better responsive view.
Instead of truncating columns, the data that's already in the markup can now be toggled into view. Only seems appropriate to celebrate four years of contributing by finally doing the first thing I ever mocked up.
Known issues / concerns:
* Custom list tables that don't define a primary column will show nothing at all. These are not extremely common, as `WP_List_Table` isn't really recommended for plugin consumption, but it happens. We need to come up with some kind of fallback.
* Some visual elements, particularly whitespace, could use refining.
* Needs a11y review.
* Touch performance on iOS feels sluggish - is there anything we can do about that?
* Would this be better accordion-style (only one expanded at a time)?
* Is `wp_strip_all_tags()` good enough for column titles that have HTML in them? It's essentially a workaround for the fact that core's comments column does that for the icon, which maybe it shouldn't. Perhaps worth another ticket, as a markup change would be fairly independent.
* Visual hierarchy is not great when expanded (also worthy of another ticket).
* Quick edit now becomes noticeably more annoying to cancel out of, as you have to scroll all the way down and you lose your position from before it was opened. Again, worthy of another ticket.
props Michael Arestad, helen.
see #32395.
Built from https://develop.svn.wordpress.org/trunk@33016
git-svn-id: http://core.svn.wordpress.org/trunk@32987 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2015-06-30 21:31:25 -04:00
|
|
|
|
|
|
|
$attributes = "class='$classes' $data";
|
2010-09-16 16:07:39 -04:00
|
|
|
|
2015-09-22 02:06:25 -04:00
|
|
|
if ( 'cb' === $column_name ) {
|
2010-09-16 16:07:39 -04:00
|
|
|
echo '<th scope="row" class="check-column">';
|
|
|
|
echo $this->column_cb( $item );
|
|
|
|
echo '</th>';
|
2015-07-14 13:47:24 -04:00
|
|
|
} elseif ( method_exists( $this, '_column_' . $column_name ) ) {
|
|
|
|
echo call_user_func(
|
|
|
|
array( $this, '_column_' . $column_name ),
|
|
|
|
$item,
|
|
|
|
$classes,
|
|
|
|
$data,
|
|
|
|
$primary
|
|
|
|
);
|
|
|
|
} elseif ( method_exists( $this, 'column_' . $column_name ) ) {
|
2010-09-16 16:07:39 -04:00
|
|
|
echo "<td $attributes>";
|
2013-09-05 12:34:09 -04:00
|
|
|
echo call_user_func( array( $this, 'column_' . $column_name ), $item );
|
2015-05-28 22:41:25 -04:00
|
|
|
echo $this->handle_row_actions( $item, $column_name, $primary );
|
2017-11-30 18:11:00 -05:00
|
|
|
echo '</td>';
|
2015-07-14 13:47:24 -04:00
|
|
|
} else {
|
2010-09-16 16:07:39 -04:00
|
|
|
echo "<td $attributes>";
|
|
|
|
echo $this->column_default( $item, $column_name );
|
2015-05-28 22:41:25 -04:00
|
|
|
echo $this->handle_row_actions( $item, $column_name, $primary );
|
2017-11-30 18:11:00 -05:00
|
|
|
echo '</td>';
|
2010-09-16 16:07:39 -04:00
|
|
|
}
|
|
|
|
}
|
2010-08-11 17:54:51 -04:00
|
|
|
}
|
|
|
|
|
2015-05-28 22:41:25 -04:00
|
|
|
/**
|
2015-07-12 14:32:24 -04:00
|
|
|
* Generates and display row actions links for the list table.
|
2015-05-28 22:41:25 -04:00
|
|
|
*
|
|
|
|
* @since 4.3.0
|
|
|
|
*
|
2020-10-18 16:53:08 -04:00
|
|
|
* @param object|array $item The item being acted upon.
|
|
|
|
* @param string $column_name Current column name.
|
|
|
|
* @param string $primary Primary column name.
|
2020-01-11 12:57:03 -05:00
|
|
|
* @return string The row actions HTML, or an empty string
|
|
|
|
* if the current column is not the primary column.
|
2015-05-28 22:41:25 -04:00
|
|
|
*/
|
|
|
|
protected function handle_row_actions( $item, $column_name, $primary ) {
|
I18N: Mark screen reader strings as such with translator comments.
This aims to provide better context for translators and make it easier to determine that some strings contain hidden accessibility text and are not displayed in the UI.
Props kebbet, mercime, pavelevap, ocean90, swissspidy, Chouby, jipmoors, afercia, desrosj, costdev, audrasjb, SergeyBiryukov.
Fixes #29748.
Built from https://develop.svn.wordpress.org/trunk@55276
git-svn-id: http://core.svn.wordpress.org/trunk@54809 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-07 12:10:21 -05:00
|
|
|
return $column_name === $primary ? '<button type="button" class="toggle-row"><span class="screen-reader-text">' .
|
|
|
|
/* translators: Hidden accessibility text. */
|
|
|
|
__( 'Show more details' ) .
|
|
|
|
'</span></button>' : '';
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2015-05-28 22:41:25 -04:00
|
|
|
|
2010-08-11 17:54:51 -04:00
|
|
|
/**
|
2020-06-25 04:56:16 -04:00
|
|
|
* Handles an incoming ajax request (called from admin-ajax.php)
|
2010-08-11 17:54:51 -04:00
|
|
|
*
|
2010-08-24 20:51:44 -04:00
|
|
|
* @since 3.1.0
|
2010-08-11 17:54:51 -04:00
|
|
|
*/
|
Add access modifiers to methods and members of list table classes:
* `WP_List_Table` is the base class that implements `__get()` and `__call()` for BC
* Adds unit tests to confirm that subclasses properly inherit magic methods
* Add modifiers to subclasses: `WP_Links_List_Table`, `WP_Media_List_Table`, `WP_MS_Sites_List_Table`, `WP_MS_Themes_List_Table`, `WP_MS_Users_List_Table`, `WP_Plugin_Install_List_Table`, `WP_Plugins_List_Table`, `WP_Posts_List_Table`, `WP_Terms_List_Table`, `WP_Theme_Install_List_Table`, `WP_Themes_List_Table`
See #27881, #22234.
Built from https://develop.svn.wordpress.org/trunk@28493
git-svn-id: http://core.svn.wordpress.org/trunk@28319 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-05-18 21:17:15 -04:00
|
|
|
public function ajax_response() {
|
2010-08-12 19:21:05 -04:00
|
|
|
$this->prepare_items();
|
|
|
|
|
2010-08-11 17:54:51 -04:00
|
|
|
ob_start();
|
2014-05-13 01:14:14 -04:00
|
|
|
if ( ! empty( $_REQUEST['no_placeholder'] ) ) {
|
2010-12-20 10:26:44 -05:00
|
|
|
$this->display_rows();
|
2014-05-13 01:14:14 -04:00
|
|
|
} else {
|
2010-12-20 10:26:44 -05:00
|
|
|
$this->display_rows_or_placeholder();
|
2014-05-13 01:14:14 -04:00
|
|
|
}
|
2010-12-20 10:26:44 -05:00
|
|
|
|
2010-08-11 17:54:51 -04:00
|
|
|
$rows = ob_get_clean();
|
|
|
|
|
2010-10-21 11:30:35 -04:00
|
|
|
$response = array( 'rows' => $rows );
|
|
|
|
|
2014-05-13 01:14:14 -04:00
|
|
|
if ( isset( $this->_pagination_args['total_items'] ) ) {
|
|
|
|
$response['total_items_i18n'] = sprintf(
|
2019-09-02 20:41:05 -04:00
|
|
|
/* translators: Number of items. */
|
2015-05-09 15:22:24 -04:00
|
|
|
_n( '%s item', '%s items', $this->_pagination_args['total_items'] ),
|
2014-05-13 01:14:14 -04:00
|
|
|
number_format_i18n( $this->_pagination_args['total_items'] )
|
|
|
|
);
|
|
|
|
}
|
|
|
|
if ( isset( $this->_pagination_args['total_pages'] ) ) {
|
2017-11-30 18:11:00 -05:00
|
|
|
$response['total_pages'] = $this->_pagination_args['total_pages'];
|
2014-05-13 01:14:14 -04:00
|
|
|
$response['total_pages_i18n'] = number_format_i18n( $this->_pagination_args['total_pages'] );
|
2010-11-17 12:03:27 -05:00
|
|
|
}
|
2010-10-21 11:30:35 -04:00
|
|
|
|
2014-10-28 14:35:19 -04:00
|
|
|
die( wp_json_encode( $response ) );
|
2010-08-11 17:54:51 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2020-06-25 04:56:16 -04:00
|
|
|
* Sends required variables to JavaScript land.
|
|
|
|
*
|
|
|
|
* @since 3.1.0
|
2010-08-11 17:54:51 -04:00
|
|
|
*/
|
2014-07-13 18:09:16 -04:00
|
|
|
public function _js_vars() {
|
2010-11-04 11:00:55 -04:00
|
|
|
$args = array(
|
2011-09-30 20:24:44 -04:00
|
|
|
'class' => get_class( $this ),
|
|
|
|
'screen' => array(
|
2012-09-19 08:43:31 -04:00
|
|
|
'id' => $this->screen->id,
|
|
|
|
'base' => $this->screen->base,
|
2017-11-30 18:11:00 -05:00
|
|
|
),
|
2010-08-11 17:54:51 -04:00
|
|
|
);
|
2010-11-04 11:00:55 -04:00
|
|
|
|
2014-10-28 14:35:19 -04:00
|
|
|
printf( "<script type='text/javascript'>list_args = %s;</script>\n", wp_json_encode( $args ) );
|
2010-08-11 17:54:51 -04:00
|
|
|
}
|
|
|
|
}
|