1.2 WordPress Smart Coding Tips | Schedule Event / scheduled tasks

AL EMRAN — Wed, 17 Nov 2021 16:11:42 +0000

Normally in WordPress plugin development, we declare a scheduled event like the following.

register_activation_hook( __FILE__, 'my_plugin_activation_event' );

function my_plugin_activation_event() {
    if ( ! wp_next_scheduled( 'my_plugin_activation_event' ) ) {
        wp_schedule_event( time(), 'daily', 'my_plugin_activation_event' );
    }
}

register_deactivation_hook( __FILE__, 'my_plugin_deactivation_event' );

function my_plugin_deactivation_event() {
    wp_clear_scheduled_hook( 'my_plugin_deactivation_event' );
}

We use this type of code in many places.

Problem is that - This code is not re-usable.

We can create a class for reuse.

Let's Start

Create a class or global functions file

a. First create a class name Schedule

namespace MyPlugin\Utilities;

class Scheduler {

}

b. Then add a method name add

public static function add( $hook, $callback, $recurrence = 'daily', $start_time = null ) {
        if ( ! wp_next_scheduled( $hook ) ) {
            if(!$start_time) $start_time = time();
            wp_schedule_event( $start_time, $recurrence, $hook );
        }

     add_action( $hook, $callback );
 }

** $hook: hook name for the event.
** $callback: callback function or array for add action of our event hook.
** $recurrence: How often the event should subsequently recur. See wp_get_schedules() for accepted values. Default id 'daily'
** $start_time: event first starting time. You can pass your desired time.

c. Then we need to remove/clean our event.
For that let's create a method for removing events.

  public static function delete($hook){
      wp_clear_scheduled_hook($hook);
  }

Uses

Schedule::add('my-custom-schedule-event', [$this, 'event_handler']);

Schedule::delete('my-custom-schedule-event');

OR you can create global functions as like previous methods.

AL EMRAN
Github

For Creating Awesome Structured PSR Based Plugin:
PluginMaster, a WordPress plugin development framework

1.1 WordPress Smart Coding Tips | Escaping & translation

AL EMRAN — Sun, 14 Nov 2021 04:16:35 +0000

Get $100 Digitalocean credit

When we develop WordPress plugin/theme, we need to use translatable function(gettextFunctions) and also escaping text. In WordPress have some functions for scaping and translating text. like (), esc_html(), _e(), esc_html_e()

We declare those functions like.

__('Hello Awesome WordPress', 'my-plugin-text-domain');

But problem is that we declare those functions many places with our text domain it's repeating same text again and again and if we need to change our text domain then need to change all files where declared those functions.

Let's try to solve the problem.

Create a file in your plugin/theme for global function declaring. file name like: global-functions.php
declaring following functions:

1

if ( !function_exists( 'mp_text' ) ) {
    function mp_text( $text, $fn = '__' ) {
        return $fn( $text, 'my-plugin-text-domain' );
    }
}

*** This function will return translated text with __() function but you can pass any function related to same purpose.
*** mp is my plugin short name. Add sort prefix of your plugin/theme name.
*** you can declare the function with your desired name but must use a sort prefix.

2

if ( !function_exists( 'mp_text_p' ) ) {
    function mp_text_p( $text, $fn = '_e' ) {
        $fn( $text, 'my-plugin-text-domain' );
    }
}

*** This function will print translated text with _e() function but you can pass any function related to same purpose.
*** mp is my plugin short name. Add sort prefix of your plugin/theme name.

3

if ( !function_exists( 'mp_title' ) ) {
    function sep_title( $text, $fn = 'esc_html__' ) { 
         return $fn( $text, 'my-plugin-text-domain' ); 
    }
}

*** This function will return translated text with html escaping with esc_html__() function but you can pass any function related to same purpose.
*** You can declare the function with your desired name but must use a sort prefix.

4

if ( !function_exists( 'mp_title_p' ) ) {
    function sep_title_p( $text, $fn = 'esc_html__' ) { 
         echo $fn( $text, 'my-plugin-text-domain' ); 
    }
}

*** This function will print translated text after html escaping with esc_html__() function but you can pass any function related to same purpose.

*** If you have question that when we create pot file through any tool, we must use those function not custom wrapper functions.
Answer is no, every pot file generating tool's have custom functions adding system for filtering php file. You can check
https://github.com/wp-pot/wp-pot

Uses

mp_title_p('Hello Awesome WordPress');
echo mp_text('Hello Awesome WordPress');
echo mp_text('container', 'esc_attr__');

AL EMRAN
Github

PluginMaster, a WordPress plugin development framework

DEV Community: WP PluginMaster

1.2 WordPress Smart Coding Tips | Schedule Event / scheduled tasks

Problem is that - This code is not re-usable.

We can create a class for reuse.

Uses

OR you can create global functions as like previous methods.

1.1 WordPress Smart Coding Tips | Escaping & translation

Get $100 Digitalocean credit

But problem is that we declare those functions many places with our text domain it's repeating same text again and again and if we need to change our text domain then need to change all files where declared those functions.

Let's try to solve the problem.

1

2

3

4

Uses