wp-crontrol/src/event-list-table.php at develop · johnbillion/wp-crontrol · GitHub

History

904 lines (789 loc) · 26.6 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

<?php

/**

* List table for cron events.

namespace Crontrol\Event;

use Crontrol\Context\UserContext;

use Crontrol\Context\FeatureContext;

use Crontrol\Exception\UnknownScheduleException;

use DateTimeImmutable;

require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';

/**

* Cron event list table class.

class Table extends \WP_List_Table {

/**

* Array of Event instances for the current page.

* @var list<Event>

public $items;

/**

* The user capability context.

private UserContext $user_context;

/**

* The feature flag context.

private FeatureContext $feature_context;

/**

* Array of the count of each hook.

* @var array<string,int> Array of count of each hooked, keyed by hook name.

protected $count_by_hook = array();

/**

* Array of all cron events.

* @var array<string,Event> Array of event objects.

protected $all_events = array();

/**

* Constructor.

* @param UserContext $user_context The user capability context.

* @param FeatureContext $feature_context The feature flag context.

public function __construct( UserContext $user_context, FeatureContext $feature_context ) {

$this->user_context = $user_context;

$this->feature_context = $feature_context;

parent::__construct( array(

'singular' => 'crontrol-event',

'plural' => 'crontrol-events',

'ajax' => false,

'screen' => 'crontrol-events',

) );

}

/**

* Prepares the list table items and arguments.

* @return void

#[\Override]

public function prepare_items() {

$this->count_by_hook = count_by_hook();

$events = get();

$this->all_events = $events;

// Apply search filter

if ( ! empty( $_GET['s'] ) && is_string( $_GET['s'] ) ) {

$search = sanitize_text_field( wp_unslash( $_GET['s'] ) );

$events = self::filter_events_by_search( $events, $search );

}

// Apply hooks type filter

if ( ! empty( $_GET['crontrol_hooks_type'] ) && is_string( $_GET['crontrol_hooks_type'] ) ) {

$hooks_type = sanitize_text_field( wp_unslash( $_GET['crontrol_hooks_type'] ) );

$events = self::filter_events_by_type( $events, $hooks_type );

}

$count = count( $events );

$per_page = 50;

$page_num = $this->get_pagenum();

$this->items = self::paginate_events( $events, $page_num, $per_page );

$has_integrity_failures = self::has_integrity_failures( $this->items );

if ( $has_integrity_failures && empty( $_GET['crontrol_action'] ) ) {

add_action(

'admin_notices',

function () {

wp_admin_notice(

sprintf(

'%1$s <a href="%2$s">%3$s</a>',

esc_html__( 'One or more of your cron events needs to be checked for integrity. These events will not run until you check and re-save them.', 'wp-crontrol' ),

'https://wp-crontrol.com/help/check-cron-events/',

esc_html__( 'Read what to do', 'wp-crontrol' )

array(

'id' => 'crontrol-integrity-failures-message',

'type' => 'error',

)

);

}

);

}

$this->set_pagination_args( array(

'total_items' => $count,

'per_page' => $per_page,

'total_pages' => (int) ceil( $count / $per_page ),

) );

}

/**

* Paginates events for display.

* @param array<Event> $events Array of events to paginate.

* @param int $page_num Current page number (1-indexed).

* @param int $per_page Number of events per page.

* @return list<Event> Paginated array of events.

public static function paginate_events( array $events, int $page_num, int $per_page ): array {

return paginate( $events, $page_num, $per_page );

}

/**

* Filters events by search term.

* @param array<Event> $events Array of events to filter.

* @param string $search Search term to filter by.

* @return array<Event> Filtered array of events.

public static function filter_events_by_search( array $events, string $search ): array {

return filter_by_search( $events, $search );

}

/**

* Filters events by hooks type.

* @param array<Event> $events Array of events to filter.

* @param string $hooks_type The hooks type to filter by.

* @return array<Event> Filtered array of events.

public static function filter_events_by_type( array $events, string $hooks_type ): array {

$filtered = self::get_filtered_events( $events );

if ( isset( $filtered[ $hooks_type ] ) ) {

return $filtered[ $hooks_type ];

}

return $events;

}

/**

* Checks if any events have integrity failures.

* @param array<Event> $events Array of events to check.

public static function has_integrity_failures( array $events ): bool {

return \Crontrol\Event\has_integrity_failures( $events );

}

/**

* Returns events filtered by various parameters

* @param array<string,\Crontrol\Event\Event> $events The list of all events.

* @return array<string,array<string,\Crontrol\Event\Event>> Array of filtered events keyed by filter name.

public static function get_filtered_events( array $events ) {

$filtered = array(

'all' => $events,

);

$filtered['noaction'] = array_filter(

$events,

fn( $event ) => empty( $event->get_callbacks() )

);

$filtered['core'] = array_filter(

$events,

fn( $event ) => $event instanceof CoreCronEvent

);

$filtered['custom'] = array_filter(

$events,

fn( $event ) => ! ( $event instanceof CoreCronEvent )

);

$filtered['php'] = array_filter(

$events,

fn( $event ) => $event instanceof PHPCronEvent

);

$filtered['url'] = array_filter(

$events,

fn( $event ) => $event instanceof URLCronEvent

);

$filtered['paused'] = array_filter(

$events,

fn( $event ) => $event->is_paused()

);

$filtered['duplicated'] = filter_duplicated( $events );

$filtered['woocommerce'] = filter_woocommerce( $events );

/**

* Filters the available filtered events on the cron event listing screen.

* See the corresponding `crontrol/filter-types` filter to adjust the list of filter types.

* @since 1.11.0

* @param array[] $filtered Array of filtered event arrays keyed by filter name.

* @param \Crontrol\Event\Event[] $events Array of all events.

$filtered = apply_filters( 'crontrol/filtered-events', $filtered, $events );

return $filtered;

}

/**

* Returns an array of column names for the table.

* @return array<string,string> Array of column names keyed by their ID.

#[\Override]

public function get_columns() {

return array(

'cb' => '<input type="checkbox" />',

'crontrol_hook' => esc_html__( 'Hook', 'wp-crontrol' ),

'crontrol_next' => esc_html(

sprintf(

/* translators: %s: UTC offset */

__( 'Next Run (%s)', 'wp-crontrol' ),

\Crontrol\get_timezone_location()

'crontrol_schedule' => esc_html_x( 'Schedule', 'noun', 'wp-crontrol' ),

'crontrol_actions' => esc_html__( 'Action', 'wp-crontrol' ),

);

}

/**

* Columns to make sortable.

* @return array<string,array<int,mixed>>

* @phpstan-return array<string,array{

* 0: string,

* 1: bool,

* 2?: ?string,

* 3?: ?string,

* 4?: 'asc'|'desc',

* }>

#[\Override]

public function get_sortable_columns() {

return array(

'crontrol_hook' => array( 'crontrol_hook', false ),

'crontrol_next' => array( 'crontrol_next', false, null, null, 'asc' ),

'crontrol_schedule' => array( 'crontrol_schedule', false ),

);

}

/**

* Returns an array of CSS class names for the table.

* @return array<int,string> Array of class names.

#[\Override]

protected function get_table_classes() {

return array( 'widefat', 'striped', 'table-view-list', $this->_args['plural'] );

}

/**

* Get an associative array ( option_name => option_title ) with the list

* of bulk actions available on this table.

* @return array<string,string>

#[\Override]

protected function get_bulk_actions() {

return array(

'crontrol_delete_crons' => esc_html__( 'Delete', 'wp-crontrol' ),

);

}

/**

* Display the list of hook types.

* @return array<string,string>

#[\Override]

public function get_views() {

$filtered = self::get_filtered_events( $this->all_events );

$views = array();

$hooks_type = ( ! empty( $_GET['crontrol_hooks_type'] ) ? $_GET['crontrol_hooks_type'] : 'all' );

$types = array(

'all' => __( 'All events', 'wp-crontrol' ),

'noaction' => __( 'Events with no action', 'wp-crontrol' ),

'woocommerce' => __( 'WooCommerce events', 'wp-crontrol' ),

'core' => __( 'WordPress core events', 'wp-crontrol' ),

'custom' => __( 'Custom events', 'wp-crontrol' ),

'php' => __( 'PHP events', 'wp-crontrol' ),

'url' => __( 'URL events', 'wp-crontrol' ),

'paused' => __( 'Paused events', 'wp-crontrol' ),

'duplicated' => __( 'Duplicated events', 'wp-crontrol' ),

);

/**

* Filters the filter types on the cron event listing screen.

* See the corresponding `crontrol/filtered-events` filter to adjust the filtered events.

* @since 1.11.0

* @param string[] $types Array of filter names keyed by filter name.

* @param string $hooks_type The current filter name.

$types = apply_filters( 'crontrol/filter-types', $types, $hooks_type );

$url = admin_url( 'tools.php?page=wp-crontrol' );

/**

* @var array<string,string> $types

foreach ( $types as $key => $type ) {

if ( ! isset( $filtered[ $key ] ) ) {

continue;

}

$count = count( $filtered[ $key ] );

if ( ! $count ) {

continue;

}

$link = ( 'all' === $key ) ? $url : add_query_arg( 'crontrol_hooks_type', $key, $url );

$views[ $key ] = sprintf(

'<a href="%1$s"%2$s>%3$s (%4$s)</a>',

esc_url( $link ),

$hooks_type === $key ? ' class="current"' : '',

esc_html( $type ),

esc_html( number_format_i18n( $count ) )

);

}

return $views;

}

/**

* Extra controls to be displayed between bulk actions and pagination.

* @param string $which One of 'top' or 'bottom' to indicate the position on the screen.

* @return void

#[\Override]

protected function extra_tablenav( $which ) {

wp_nonce_field( 'crontrol-export-event-csv', 'crontrol_nonce' );

printf(

'<input type="hidden" name="crontrol_hooks_type" value="%s"/>',

esc_attr( isset( $_GET['crontrol_hooks_type'] ) ? sanitize_text_field( wp_unslash( $_GET['crontrol_hooks_type'] ) ) : 'all' )

);

printf(

'<input type="hidden" name="s" value="%s"/>',

esc_attr( isset( $_GET['s'] ) ? sanitize_text_field( wp_unslash( $_GET['s'] ) ) : '' )

);

printf(

'<button class="button" type="submit" name="crontrol_action" value="export-event-csv">%s</button>',

esc_html__( 'Export', 'wp-crontrol' )

);

}

/**

* Generates content for a single row of the table.

* @param Event $event The current event.

* @return void

#[\Override]

public function single_row( $event ) {

$classes = array();

if ( $event->has_error() ) {

$classes[] = 'crontrol-error';

}

try {

$schedule_name = $event->get_schedule_name();

} catch ( UnknownScheduleException $e ) {

$classes[] = 'crontrol-error';

}

$callbacks = $event->get_callbacks();

if ( ! $callbacks ) {

$classes[] = 'crontrol-no-action';

} else {

foreach ( $callbacks as $callback ) {

if ( ! empty( $callback['callback']['error'] ) ) {

$classes[] = 'crontrol-error';

break;

}

if ( $event->is_late() || $event->is_too_frequent() ) {

$classes[] = 'crontrol-warning';

}

if ( $event->is_paused() ) {

$classes[] = 'crontrol-paused';

}

if ( ! $event->is_enabled( $this->feature_context ) ) {

$classes[] = 'crontrol-disabled';

}

printf(

'<tr class="%s">',

esc_attr( implode( ' ', $classes ) )

);

$this->single_row_columns( $event );

echo '</tr>';

}

/**

* Generates and displays row action links for the table.

* @param Event $event The cron event for the current row.

* @param string $column_name Current column name.

* @param string $primary Primary column name.

* @return string The row actions HTML.

#[\Override]

protected function handle_row_actions( $event, $column_name, $primary ) {

if ( $primary !== $column_name ) {

return '';

}

$links = $this->get_row_action_links( $event );

return $this->row_actions( $links );

}

/**

* Gets the array of row action links for an event.

* @param Event $event The cron event for the current row.

* @return array<string,string> Array of action link HTML strings, keyed by action name.

public function get_row_action_links( Event $event ): array {

$links = array();

if ( $event->is_immediate() ) {

// This is an event that is scheduled to run immediately. These only appear when there's a problem with

// the event runner, so the only link we need to show is the "Delete" link.

$link = array(

'page' => 'wp-crontrol',

'crontrol_action' => 'delete-cron',

'crontrol_id' => rawurlencode( $event->hook ),

'crontrol_sig' => rawurlencode( $event->sig ),

'crontrol_next_run_utc' => '1',

);

$link = add_query_arg( $link, admin_url( 'tools.php' ) );

$link = wp_nonce_url( $link, "crontrol-delete-cron_{$event->hook}_{$event->sig}_{$event->timestamp}" );

$links['delete'] = "<a href='" . esc_url( $link ) . "'>" . esc_html__( 'Delete', 'wp-crontrol' ) . '</a>';

return $links;

}

if ( $event->editable( $this->user_context, $this->feature_context ) ) {

$link = array(

'page' => 'wp-crontrol',

'crontrol_action' => 'edit-cron',

'crontrol_id' => rawurlencode( $event->hook ),

'crontrol_sig' => rawurlencode( $event->sig ),

'crontrol_next_run_utc' => $event->timestamp,

);

$link = add_query_arg( $link, admin_url( 'tools.php' ) );

if ( $event->integrity_failed() ) {

$label = __( 'Check and edit', 'wp-crontrol' );

} else {

$label = __( 'Edit', 'wp-crontrol' );

}

$links['edit'] = sprintf(

'<a href="%1$s">%2$s</a>',

esc_url( $link ),

esc_html( $label )

);

}

if ( $event->runnable( $this->user_context, $this->feature_context ) ) {

$link = array(

'page' => 'wp-crontrol',

'crontrol_action' => 'run-cron',

'crontrol_id' => rawurlencode( $event->hook ),

'crontrol_sig' => rawurlencode( $event->sig ),

'crontrol_next_run_utc' => $event->timestamp,

);

$link = add_query_arg( $link, admin_url( 'tools.php' ) );

$link = wp_nonce_url( $link, "crontrol-run-cron_{$event->hook}_{$event->sig}" );

$links['run'] = "<a href='" . esc_url( $link ) . "'>" . esc_html__( 'Run now', 'wp-crontrol' ) . '</a>';

}

if ( $event->is_paused() ) {

$link = array(

'page' => 'wp-crontrol',

'crontrol_action' => 'resume-hook',

'crontrol_id' => rawurlencode( $event->hook ),

);

$link = add_query_arg( $link, admin_url( 'tools.php' ) );

$link = wp_nonce_url( $link, "crontrol-resume-hook_{$event->hook}" );

/* translators: Resume is a verb */

$links['resume'] = "<a href='" . esc_url( $link ) . "'>" . esc_html__( 'Resume this hook', 'wp-crontrol' ) . '</a>';

} elseif ( $event->pausable() ) {

$link = array(

'page' => 'wp-crontrol',

'crontrol_action' => 'pause-hook',

'crontrol_id' => rawurlencode( $event->hook ),

);

$link = add_query_arg( $link, admin_url( 'tools.php' ) );

$link = wp_nonce_url( $link, "crontrol-pause-hook_{$event->hook}" );

/* translators: Pause is a verb */

$links['pause'] = "<a href='" . esc_url( $link ) . "'>" . esc_html__( 'Pause this hook', 'wp-crontrol' ) . '</a>';

}

$links = apply_filters( 'crontrol/event-actions', $links, $event );

if ( $event->deletable( $this->user_context, $this->feature_context ) ) {

$link = array(

'page' => 'wp-crontrol',

'crontrol_action' => 'delete-cron',

'crontrol_id' => rawurlencode( $event->hook ),

'crontrol_sig' => rawurlencode( $event->sig ),

'crontrol_next_run_utc' => $event->timestamp,

);

$link = add_query_arg( $link, admin_url( 'tools.php' ) );

$link = wp_nonce_url( $link, "crontrol-delete-cron_{$event->hook}_{$event->sig}_{$event->timestamp}" );

$links['delete'] = "<a href='" . esc_url( $link ) . "' data-crontrol-delete-event>" . esc_html__( 'Delete', 'wp-crontrol' ) . '</a>';

}

if ( ! ( $event instanceof CrontrolEvent ) ) {

if ( isset( $this->count_by_hook[ $event->hook ] ) && $this->count_by_hook[ $event->hook ] > 1 ) {

$link = array(

'page' => 'wp-crontrol',

'crontrol_action' => 'delete-hook',

'crontrol_id' => rawurlencode( $event->hook ),

);

$link = add_query_arg( $link, admin_url( 'tools.php' ) );

$link = wp_nonce_url(

$link,

sprintf(

'crontrol-delete-hook_%1$s',

$event->hook

)

);

$text = sprintf(

/* translators: %s: The number of events with this hook */

__( 'Delete all events with this hook (%s)', 'wp-crontrol' ),

number_format_i18n( $this->count_by_hook[ $event->hook ] )

);

$links['delete-hook'] = sprintf(

'<a href="%1$s" data-crontrol-delete-hook>%2$s</a>',

esc_url( $link ),

esc_html( $text )

);

}

return $links;

}

/**

* Outputs the checkbox cell of a table row.

* @param Event $event The cron event for the current row.

* @return string The cell output.

#[\Override]

protected function column_cb( $event ) {

$id = sprintf(

'crontrol-delete-%1$d-%2$s-%3$s',

$event->timestamp,

rawurlencode( $event->hook ),

$event->sig

);

if ( $event->persistent() ) {

if ( $event instanceof CoreCronEvent ) {

return sprintf(

'

%s',

esc_html( $event->get_persistent_message() )

);

}

// Other persistent events don't show checkbox or logo

return '';

}

if ( ! $event->deletable( $this->user_context, $this->feature_context ) ) {

return '';

}

return sprintf(

'<label for="%1$s">%2$s</label>

<input type="checkbox" name="crontrol_bulk[%3$d][%4$s]" value="%5$s" id="%1$s">',

esc_attr( $id ),

esc_html__( 'Select this row', 'wp-crontrol' ),

intval( $event->timestamp ),

esc_attr( rawurlencode( $event->hook ) ),

esc_attr( $event->sig )

);

}

/**

* Returns the output for the hook name cell of a table row.

* @param Event $event The cron event for the current row.

protected function column_crontrol_hook( Event $event ): string {

$output = $event->get_hook_name_label();

if ( ( $event instanceof PHPCronEvent ) || ( $event instanceof URLCronEvent ) ) {

if ( ! $event->is_enabled( $this->feature_context ) ) {

$output .= sprintf(

' — %s',

/* translators: State of a cron event, adjective */

esc_html__( 'Disabled', 'wp-crontrol' )

);

} elseif ( $event->integrity_failed() ) {

$output .= sprintf(

' — %s',

esc_html__( 'Needs checking', 'wp-crontrol' )

);

} elseif ( $event->has_error() ) {

$output .= $event->get_error_status_html();

}

return $output;

}

if ( $event->is_paused() ) {

$output .= sprintf(

' — %s',

/* translators: State of a cron event, adjective */

esc_html__( 'Paused', 'wp-crontrol' )

);

}

if ( $event->has_invalid_args() ) {

$output .= sprintf(

' %s',

esc_html__( 'This event has invalid arguments and will not run correctly.', 'wp-crontrol' )

);

}

if ( $event->args !== [] ) {

$output .= sprintf(

' <details><summary>%s</summary><pre>%s</pre></details>',

esc_html__( 'View arguments', 'wp-crontrol' ),

esc_html( \Crontrol\json_output( $event->args ) )

);

}

return $output;

}

/**

* Returns the output for the actions cell of a table row.

* @param Event $event The cron event for the current row.

protected function column_crontrol_actions( Event $event ): string {

if ( $event instanceof PHPCronEvent && ! $this->feature_context->php_crons_enabled() ) {

$help = sprintf(

'<a href="%s">%s</a>',

'https://wp-crontrol.com/docs/php-cron-events/',

esc_html__( 'Help', 'wp-crontrol' )

);

return sprintf(

' %1$s (%2$s)',

esc_html__( 'PHP cron events are disabled', 'wp-crontrol' ),

$help

);

}

if ( $event instanceof URLCronEvent && ! $this->feature_context->url_crons_enabled() ) {

$help = sprintf(

'<a href="%s">%s</a>',

'https://wp-crontrol.com/docs/url-cron-events/',

esc_html__( 'Help', 'wp-crontrol' )

);

return sprintf(

' %1$s (%2$s)',

esc_html__( 'URL cron events are disabled', 'wp-crontrol' ),

$help

);

}

$hook_callbacks = $event->get_callbacks();

if ( $event instanceof CrontrolEvent ) {

return 'WP Crontrol';

} elseif ( ! empty( $hook_callbacks ) ) {

if ( count( $hook_callbacks ) === 1 ) {

return \Crontrol\output_callback( $hook_callbacks[0] );

}

$callbacks = array();

foreach ( $hook_callbacks as $callback ) {

$callbacks[] = \Crontrol\output_callback( $callback );

}

return '<ol><li>' . implode( '</li><li>', $callbacks ) . '</li>'; // WPCS:: XSS ok.

} else {

$help = sprintf(

'<a href="%s">%s</a>',

'https://wp-crontrol.com/help/no-action-cron-events/',

esc_html__( 'Help', 'wp-crontrol' )

);

return sprintf(

' %1$s (%2$s)',

esc_html__( 'None', 'wp-crontrol' ),

$help,

);

}

/**

* Returns the output for the next run cell of a table row.

* @param Event $event The cron event for the current row.

protected function column_crontrol_next( Event $event ): string {

if ( $event->is_immediate() ) {

return sprintf(

' %s',

esc_html__( 'Immediately', 'wp-crontrol' ),

);

}

$time_format = 'g:i a';

$event_datetime_utc = $event->get_next_run_utc( 'Y-m-d H:i:s' );

$timezone_local = wp_timezone();

$event_local = get_date_from_gmt( $event_datetime_utc, 'Y-m-d' );

$today_local = ( new DateTimeImmutable( 'now', $timezone_local ) )->format( 'Y-m-d' );

$tomorrow_local = ( new DateTimeImmutable( 'tomorrow', $timezone_local ) )->format( 'Y-m-d' );

$yesterday_local = ( new DateTimeImmutable( 'yesterday', $timezone_local ) )->format( 'Y-m-d' );

// If the offset of the date of the event is different from the offset of the site, add a marker.

if ( get_date_from_gmt( $event_datetime_utc, 'P' ) !== get_date_from_gmt( 'now', 'P' ) ) {

$time_format .= ' (P)';

}

$event_time_local = get_date_from_gmt( $event_datetime_utc, $time_format );

if ( $event_local === $today_local ) {

$date = sprintf(

/* translators: %s: Time */

__( 'Today at %s', 'wp-crontrol' ),

$event_time_local,

);

} elseif ( $event_local === $tomorrow_local ) {

$date = sprintf(

/* translators: %s: Time */

__( 'Tomorrow at %s', 'wp-crontrol' ),

$event_time_local,

);

} elseif ( $event_local === $yesterday_local ) {

$date = sprintf(

/* translators: %s: Time */

__( 'Yesterday at %s', 'wp-crontrol' ),

$event_time_local,

);

} else {

$date = sprintf(

/* translators: 1: Date, 2: Time */

__( '%1$s at %2$s', 'wp-crontrol' ),

get_date_from_gmt( $event_datetime_utc, 'F jS' ),

$event_time_local,

);

}

$time = sprintf(

'<time datetime="%1$s">%2$s</time>',

esc_attr( $event->get_next_run_utc() ),

esc_html( $date )

);

$until = $event->timestamp - time();

$late = $event->is_late();

if ( $late ) {

// Show a warning for events that are late.

$ago = sprintf(

/* translators: %s: Time period, for example "8 minutes" */

__( '%s ago', 'wp-crontrol' ),

\Crontrol\interval( abs( $until ) )

);

$help = sprintf(

'<a href="%s">%s</a>',

'https://wp-crontrol.com/help/missed-cron-events/',

esc_html__( 'Help', 'wp-crontrol' )

);

return sprintf(

' %s (%s) %s',

esc_html( $ago ),

$help,

$time,

);

}

if ( $until <= 0 ) {

$in = __( 'Now', 'wp-crontrol' );

} else {

$in = sprintf(

/* translators: %s: Time period, for example "8 minutes" */

__( 'In %s', 'wp-crontrol' ),

\Crontrol\interval( $until ),

);

}

return sprintf(

'%s %s',

esc_html( $in ),

$time,

);

}

/**

* Returns the output for the schedule cell of a table row.

* @param Event $event The cron event for the current row.

* @return string The cell output.

protected function column_crontrol_schedule( Event $event ): string {

try {

$schedule_name = $event->get_schedule_name();

} catch ( UnknownScheduleException $e ) {

return sprintf(

' %s',

esc_html( $e->getMessage() )

);

}

if ( $event->is_too_frequent() ) {

return sprintf(

'%1$s %2$s',

esc_html( $schedule_name ),

sprintf(

/* translators: 1: The name of the configuration constant, 2: The value of the configuration constant */

esc_html__( 'This interval is less than the %1$s constant which is set to %2$s seconds. Events that use it may not run on time.', 'wp-crontrol' ),

'<code>WP_CRON_LOCK_TIMEOUT</code>',

intval( WP_CRON_LOCK_TIMEOUT )

)

);

} else {

return esc_html( $schedule_name );

}

/**

* Outputs a message when there are no items to show in the table.

* @return void

#[\Override]

public function no_items() {

if ( empty( $_GET['s'] ) && empty( $_GET['crontrol_hooks_type'] ) ) {

esc_html_e( 'There are currently no scheduled cron events.', 'wp-crontrol' );

} else {

esc_html_e( 'No matching cron events.', 'wp-crontrol' );

}

wp-crontrol/src/event-list-table.php at develop · johnbillion/wp-crontrol · GitHub

Uh oh!

Expand file tree

Breadcrumbs

event-list-table.php

Latest commit

History

Breadcrumbs

event-list-table.php

File metadata and controls