नेविगेशन के लिए अगले बटन का उपयोग करके व्यवस्थापक सूचक वाले उपयोगकर्ताओं के लिए WP ट्यूटोरियल बनाएं


9

मेरा उद्देश्य व्यवस्थापक क्षेत्र के लिए अपने उपयोगकर्ताओं पर एक ट्यूटोरियल बनाना है। इसे प्राप्त करने के लिए, मैं WP कोर में उपलब्ध व्यवस्थापक पॉइंटर्स का उपयोग कर रहा हूं। मेरा लक्ष्य:

यहाँ छवि विवरण दर्ज करें

मैं लगभग वहाँ हूँ। मुझे अब तक क्या मिला ...

Enqueue wp-pointer स्क्रिप्ट:

add_action( 'admin_enqueue_scripts', 'custom_admin_pointers_header' );

function custom_admin_pointers_header() {
    if ( custom_admin_pointers_check() ) {
        add_action( 'admin_print_footer_scripts', 'custom_admin_pointers_footer' );

        wp_enqueue_script( 'wp-pointer' );
        wp_enqueue_style( 'wp-pointer' );
    }
}

सशर्त जांच और पाद लेख स्क्रिप्ट सहित सहायक कार्य:

function custom_admin_pointers_check() {
    $admin_pointers = custom_admin_pointers();
    foreach ( $admin_pointers as $pointer => $array ) {
        if ( $array['active'] )
            return true;
    }
}

function custom_admin_pointers_footer() {
    $admin_pointers = custom_admin_pointers();
    ?>
    <script type="text/javascript">
        /* <![CDATA[ */
        ( function($) {
            <?php
            foreach ( $admin_pointers as $pointer => $array ) {
               if ( $array['active'] ) {
                  ?>
            $( '<?php echo $array['anchor_id']; ?>' ).pointer( {
                content: '<?php echo $array['content']; ?>',
                position: {
                    edge: '<?php echo $array['edge']; ?>',
                    align: '<?php echo $array['align']; ?>'
                },
                close: function() {
                    $.post( ajaxurl, {
                        pointer: '<?php echo $pointer; ?>',
                        action: 'dismiss-wp-pointer'
                    } );
                }
            } ).pointer( 'open' );
            <?php
         }
      }
      ?>
        } )(jQuery);
        /* ]]> */
    </script>
<?php
}

अब हम बिंदुओं की सारणी को एक साथ रखने के लिए तैयार हैं:

function custom_admin_pointers() {
    $dismissed = explode( ',', (string) get_user_meta( get_current_user_id(), 'dismissed_wp_pointers', true ) );
    $version = '1_0'; // replace all periods in 1.0 with an underscore
    $prefix = 'custom_admin_pointers' . $version . '_';

    $new_pointer_content = '<h3>' . __( 'Add New Item' ) . '</h3>';
    $new_pointer_content .= '<p>' . __( 'Easily add a new post, media item, link, page or user by selecting from this drop down menu.' ) . '</p>';

    $story_pointer_content = '<h3>' . __( 'Another info' ) . '</h3>';
    $story_pointer_content .= '<p>' . __( 'Lorem ipsum...' ) . '</p>';


    return array(
        $prefix . 'new_items' => array(
            'content' => $new_pointer_content,
            'anchor_id' => '#wp-admin-bar-new-content',
            'edge' => 'top',
            'align' => 'left',
            'active' => ( ! in_array( $prefix . 'new_items', $dismissed ) )
        ),
        $prefix.'story_cover_help' => array(
            'content' => $story_pointer_content,
            'anchor_id' => '#save-post',
            'edge' => 'top',
            'align' => 'right',
            'active' => ( ! in_array( $prefix . 'story_cover_help', $dismissed ) )
        )
    );

}

कोड आत्म-व्याख्यात्मक है। हम आसानी से सरणी को बढ़ाकर अधिक पॉइंटर्स जोड़ सकते हैं। WP4 में सब कुछ ठीक काम करता है।

अब समस्या के लिए: एक ही समय में सभी पॉपअप पॉइंटर्स दिखाई देते हैं, जिससे यह एक ट्यूटोरियल के लिए खराब इंटरफ़ेस बन जाता है।

मेरा उद्देश्य बिंदुओं को एक-एक करके दिखाना है, और उपयोगकर्ता को ट्यूटोरियल के माध्यम से नेविगेट करने के लिए नेक्स्ट बटन पर क्लिक करने की अनुमति देता है । अगले बटन को अगला पॉइंटर खोलना चाहिए और आखिरी को बंद करना चाहिए।

मैं यह कैसे कर सकता हूँ?

जवाबों:


10

आप .pointer( 'open' );सभी पॉइंट ऑब्जेक्ट्स पर जावास्क्रिप्ट फ़ंक्शन को कॉल कर रहे हैं, इसलिए यह आश्चर्य की बात नहीं है कि सभी पॉइंटर्स एक ही समय पर दिखाई देते हैं ...

उस ने कहा, मुझे समझ में नहीं आता है कि आप सभी पॉइंटर्स (यहां तक ​​कि गैर-सक्रिय वाले) को क्यों लौटाते हैं custom_admin_pointers()और फिर जाँचने के लिए एक अतिरिक्त फ़ंक्शन if ( $array['active'] ) {जोड़ते हैं कि क्या जावास्क्रिप्ट पॉइंटर जोड़ने के लिए चुनने के लिए कुछ सक्रिय पॉइंटर्स और पॉइंटर्स लूप ( ) के अंदर एक चेक है या नहीं। क्या सिर्फ़ सिर्फ़ सक्रिय बिंदुओं को लौटाना सरल नहीं है?

इसके अलावा, आप सभी व्यवस्थापक पृष्ठों पर उस जावास्क्रिप्ट को जोड़ रहे हैं, बहुत अधिक नहीं है? यह भी विचार करें कि "# सेव-पोस्ट" जैसे कुछ तत्व केवल नए पोस्ट पेज पर उपलब्ध हैं, इसलिए केवल नए पॉट पेज में पॉइंटर्स जोड़ना बेहतर नहीं है?

अंत में, उस जावास्क्रिप्ट को PHP के साथ कैसे गड़बड़ किया गया, मुझे लगता है कि आपको wp_localize_scriptजावास्क्रिप्ट को डेटा पास करने के लिए उपयोग करने पर विचार करना चाहिए ।

योजना:

  1. PHP में पॉइंटर्स की परिभाषाओं को एक अलग फ़ाइल में ले जाएं, इस तरह से इसे संपादित करना आसान है और PHP कोड से मार्कअप को भी हटा दें, सब कुछ अधिक पठनीय और मुख्य है।
  2. पॉइंटर्स कॉन्फ़िगरेशन में एक गुण जोड़ें "जहां" जिसका उपयोग उस सेट में किया जाएगा जिसमें व्यवस्थापक पृष्ठ पॉपअप दिखाई दे:: post-new.php, index.php...
  3. एक वर्ग लिखें जो लोडिंग, पार्सिंग और पॉइंटर्स जानकारी को फ़िल्टर करने का काम करेगा
  4. कुछ js अच्छाई लिखें जो हमें "अगला" बटन डिफ़ॉल्ट "निकालें" को बदलने में मदद करेगा

# 4 कर सकते हैं (शायद) आसानी से किया सूचक अच्छी तरह से जानते हुए भी प्लगइन है, लेकिन यह मेरे मामले में नहीं है। इसलिए मैं परिणाम प्राप्त करने के लिए सामान्य jQuery कोड का उपयोग करूंगा, अगर कोई मेरे कोड में सुधार कर सकता है जिसकी मैं सराहना करूंगा।


संपादित करें

मैंने कोड (मुख्य रूप से js) को संपादित किया क्योंकि वहाँ अलग-अलग चीजें हैं जिन पर मैंने विचार नहीं किया था: कुछ संकेत एक ही लंगर में जोड़े जा सकते हैं, या एक ही संकेत गैर-मौजूदा या गैर-दृश्यमान एंकर में जोड़े जा सकते हैं। पिछले कोड में काम नहीं करने वाले सभी मामलों में, नया संस्करण उस मुद्दे को अच्छी तरह से संबोधित करता है।

मैंने उन सभी कोड के साथ एक Gist सेटअप भी किया है जिसका मैं परीक्षण करता था।


आइए अंक # 1 और # 2 के साथ शुरू करें : नाम से एक फ़ाइल बनाएं pointers.phpऔर वहां लिखें:

<?php
$pointers = array();

$pointers['new-items'] = array(
  'title'     => sprintf( '<h3>%s</h3>', esc_html__( 'Add New Item' ) ),
  'content'   => sprintf( '<p>%s</p>', esc_html__( 'Easily add a new post..' ) ),
  'anchor_id' => '#wp-admin-bar-new-content',
  'edge'      => 'top',
  'align'     => 'left',
  'where'     => array( 'index.php', 'post-new.php' ) // <-- Please note this
);

$pointers['story_cover_help'] = array(
  'title'     => sprintf( '<h3>%s</h3>', esc_html__( 'Another info' ) ),
  'content'   => sprintf( '<p>%s</p>', esc_html__( 'Lore ipsum....' ) ),
  'anchor_id' => '#save-post',
  'edge'      => 'top',
  'align'     => 'right',
  'where'     => array( 'post-new.php' ) // <-- Please note this
);

// more pointers here...

return $pointers; 

सभी संकेत विन्यास यहाँ है। जब आपको कुछ बदलने की आवश्यकता होती है, तो बस इस फ़ाइल को खोलें और इसे संपादित करें।

"जहां" संपत्ति पर ध्यान दें जो पृष्ठों की एक सरणी है जहां सूचक उपलब्ध होना चाहिए।

यदि आप किसी प्लगइन द्वारा जनरेट किए गए पृष्ठ में पॉइंटर्स प्रदर्शित करना चाहते हैं, तो नीचे उल्लिखित इस लाइन को देखें public function filter( $page ) {और die($page);तुरंत इसे नीचे जोड़ें । फिर संबंधित प्लगइन पेज खोलें और whereसंपत्ति में उस स्ट्रिंग का उपयोग करें ।

ठीक है, अब बिंदु # 3

कक्षा लिखने से पहले मैं केवल एक इंटरफ़ेस कोड करना चाहता हूं: वहां मैं टिप्पणियां डालूंगा ताकि आप बेहतर समझ सकें कि कक्षा क्या करेगी।

<?php
interface PointersManagerInterface {

  /**
  * Load pointers from file and setup id with prefix and version.
  * Cast pointers to objects.
  */
  public function parse();

  /**
  * Remove from parse pointers dismissed ones and pointers
  * that should not be shown on given page
  *
  * @param string $page Current admin page file
  */
  public function filter( $page );

}

मुझे लगता है कि बहुत स्पष्ट होना चाहिए। अब क्लास लिखते हैं, इसमें इंटरफ़ेस और कंस्ट्रक्टर के 2 तरीके होंगे।

<?php namespace GM;

class PointersManager implements PointersManagerInterface {

  private $pfile;
  private $version;
  private $prefix;
  private $pointers = array();

  public function __construct( $file, $version, $prefix ) {
    $this->pfile = file_exists( $file ) ? $file : FALSE;
    $this->version = str_replace( '.', '_', $version );
    $this->prefix = $prefix;
  }

  public function parse() {
    if ( empty( $this->pfile ) ) return;
    $pointers = (array) require_once $this->pfile;
    if ( empty($pointers) ) return;
    foreach ( $pointers as $i => $pointer ) {
      $pointer['id'] = "{$this->prefix}{$this->version}_{$i}";
      $this->pointers[$pointer['id']] = (object) $pointer;
    }
  }

  public function filter( $page ) {
    if ( empty( $this->pointers ) ) return array();
    $uid = get_current_user_id();
    $no = explode( ',', (string) get_user_meta( $uid, 'dismissed_wp_pointers', TRUE ) );
    $active_ids = array_diff( array_keys( $this->pointers ), $no );
    $good = array();
    foreach( $this->pointers as $i => $pointer ) {
      if (
        in_array( $i, $active_ids, TRUE ) // is active
        && isset( $pointer->where ) // has where
        && in_array( $page, (array) $pointer->where, TRUE ) // current page is in where
      ) {
       $good[] = $pointer;
      }
    }
    $count = count( $good );
    if ( $good === 0 ) return array();
    foreach( array_values( $good ) as $i => $pointer ) {
      $good[$i]->next = $i+1 < $count ? $good[$i+1]->id : '';
    }
    return $good;
  }
}

कोड बहुत सरल है, और वास्तव में इंटरफ़ेस क्या उम्मीद करता है।

हालाँकि, कक्षा अपने आप कुछ नहीं करती है, हमें एक हुक की आवश्यकता होती है जहाँ कक्षा nad को तुरंत शुरू करने के लिए 2 विधियाँ उचित तर्क प्रस्तुत करती हैं।

'admin_enqueue_scripts'हमारे क्षेत्र के लिए एकदम सही है: वहाँ हम वर्तमान व्यवस्थापक पृष्ठ के लिए उपयोग होगा और हम भी कतारबद्ध स्क्रिप्ट और शैलियों की जरूरत कर सकते हैं।

add_action( 'admin_enqueue_scripts', function( $page ) {
  $file = plugin_dir_path( __FILE__ ) . 'pointers.php';
  // Arguments: pointers php file, version (dots will be replaced), prefix
  $manager = new PointersManager( $file, '5.0', 'custom_admin_pointers' );
  $manager->parse();
  $pointers = $manager->filter( $page );
  if ( empty( $pointers ) ) { // nothing to do if no pointers pass the filter
    return;
  }
  wp_enqueue_style( 'wp-pointer' );
  $js_url = plugins_url( 'pointers.js', __FILE__ );
  wp_enqueue_script( 'custom_admin_pointers', $js_url, array('wp-pointer'), NULL, TRUE );
  // data to pass to javascript
  $data = array(
    'next_label' => __( 'Next' ),
    'close_label' => __('Close'),
    'pointers' => $pointers
  );
  wp_localize_script( 'custom_admin_pointers', 'MyAdminPointers', $data );
} );

कुछ खास नहीं: सिर्फ पॉइंटर्स डेटा प्राप्त करने के लिए क्लास का उपयोग करना और अगर कुछ पॉइंटर्स फिल्टर एनक्यू स्टाइल और स्क्रिप्ट पास करना। फिर बटन के लिए स्थानीयकृत "नेक्स्ट" लेबल के साथ स्क्रिप्ट को पॉइंटर्स डेटा पास करें।

ठीक है, अब "सबसे कठिन" हिस्सा: जेएस। फिर से मैं यह बताना चाहता हूं कि मुझे पता नहीं है कि पॉइंटर प्लगइन वर्डप्रेस का उपयोग करता है, इसलिए मैं अपने कोड में जो करता हूं वह बेहतर हो सकता है यदि कोई इसे जानता है, हालांकि मेरा कोड अपना काम करता है और मूल रूप से बोलता है- यह इतना बुरा नहीं है।

( function($, MAP) {

  $(document).on( 'MyAdminPointers.setup_done', function( e, data ) {
    e.stopImmediatePropagation();
    MAP.setPlugin( data ); // open first popup
  } );

  $(document).on( 'MyAdminPointers.current_ready', function( e ) {
    e.stopImmediatePropagation();
    MAP.openPointer(); // open a popup
  } );

  MAP.js_pointers = {};        // contain js-parsed pointer objects
  MAP.first_pointer = false;   // contain first pointer anchor jQuery object
  MAP.current_pointer = false; // contain current pointer jQuery object
  MAP.last_pointer = false;    // contain last pointer jQuery object
  MAP.visible_pointers = [];   // contain ids of pointers whose anchors are visible

  MAP.hasNext = function( data ) { // check if a given pointer has valid next property
    return typeof data.next === 'string'
      && data.next !== ''
      && typeof MAP.js_pointers[data.next].data !== 'undefined'
      && typeof MAP.js_pointers[data.next].data.id === 'string';
  };

  MAP.isVisible = function( data ) { // check if anchor for given pointer is visible
    return $.inArray( data.id, MAP.visible_pointers ) !== -1;
  };

  // given a pointer object, return its the anchor jQuery object if available
  // otherwise return first available, lookin at next property of subsequent pointers
  MAP.getPointerData = function( data ) { 
    var $target = $( data.anchor_id );
    if ( $.inArray(data.id, MAP.visible_pointers) !== -1 ) {
      return { target: $target, data: data };
    }
    $target = false;
    while( MAP.hasNext( data ) && ! MAP.isVisible( data ) ) {
      data = MAP.js_pointers[data.next].data;
      if ( MAP.isVisible( data ) ) {
        $target = $(data.anchor_id);
      }
    }
    return MAP.isVisible( data )
      ? { target: $target, data: data }
      : { target: false, data: false };
  };

  // take pointer data and setup pointer plugin for anchor element
  MAP.setPlugin = function( data ) {
    if ( typeof MAP.last_pointer === 'object') {
      MAP.last_pointer.pointer('destroy');
      MAP.last_pointer = false;
    }
    MAP.current_pointer = false;
    var pointer_data = MAP.getPointerData( data );
      if ( ! pointer_data.target || ! pointer_data.data ) {
      return;
    }
    $target = pointer_data.target;
    data = pointer_data.data;
    $pointer = $target.pointer({
      content: data.title + data.content,
      position: { edge: data.edge, align: data.align },
      close: function() {
        // open next pointer if it exists
        if ( MAP.hasNext( data ) ) {
          MAP.setPlugin( MAP.js_pointers[data.next].data );
        }
        $.post( ajaxurl, { pointer: data.id, action: 'dismiss-wp-pointer' } );
      }
    });
    MAP.current_pointer = { pointer: $pointer, data: data };
    $(document).trigger( 'MyAdminPointers.current_ready' );
  };

  // scroll the page to current pointer then open it
  MAP.openPointer = function() {          
    var $pointer = MAP.current_pointer.pointer;
    if ( ! typeof $pointer === 'object' ) {
      return;
    }
    $('html, body').animate({ // scroll page to pointer
      scrollTop: $pointer.offset().top - 30
    }, 300, function() { // when scroll complete
      MAP.last_pointer = $pointer;
        var $widget = $pointer.pointer('widget');
        MAP.setNext( $widget, MAP.current_pointer.data );
        $pointer.pointer( 'open' ); // open
    });
  };

  // if there is a next pointer set button label to "Next", to "Close" otherwise
  MAP.setNext = function( $widget, data ) {
    if ( typeof $widget === 'object' ) {
      var $buttons = $widget.find('.wp-pointer-buttons').eq(0);        
      var $close = $buttons.find('a.close').eq(0);
      $button = $close.clone(true, true).removeClass('close');
      $buttons.find('a.close').remove();
      $button.addClass('button').addClass('button-primary');
      has_next = false;
      if ( MAP.hasNext( data ) ) {
        has_next_data = MAP.getPointerData(MAP.js_pointers[data.next].data);
        has_next = has_next_data.target && has_next_data.data;
      }
      var label = has_next ? MAP.next_label : MAP.close_label;
      $button.html(label).appendTo($buttons);
    }
  };

  $(MAP.pointers).each(function(index, pointer) { // loop pointers data
    if( ! $().pointer ) return;      // do nothing if pointer plugin isn't available
    MAP.js_pointers[pointer.id] = { data: pointer };
    var $target = $(pointer.anchor_id);
    if ( $target.length && $target.is(':visible') ) { // anchor exists and is visible?
      MAP.visible_pointers.push(pointer.id);
      if ( ! MAP.first_pointer ) {
        MAP.first_pointer = pointer;
      }
    }
    if ( index === ( MAP.pointers.length - 1 ) && MAP.first_pointer ) {
      $(document).trigger( 'MyAdminPointers.setup_done', MAP.first_pointer );
    }
  });

} )(jQuery, MyAdminPointers); // MyAdminPointers is passed by `wp_localize_script`

टिप्पणियों की मदद से कोड बहुत स्पष्ट होना चाहिए, कम से कम, मुझे उम्मीद है।

ठीक है, हम कर रहे हैं हमारा PHP सरल और बेहतर रूप से व्यवस्थित है, हमारी जावास्क्रिप्ट अधिक पठनीय है, संकेत संपादित करना आसान है और, अधिक महत्वपूर्ण, सब कुछ काम करता है।


1
@ChristineCooper सुनिश्चित करें। ठीक है, समस्याएं 2 हैं: 1 अब स्क्रिप्ट कैसे काम करती है, इसके लिए आप 1 एंकर आईडी के लिए 1 पॉइंटर जोड़ सकते हैं: एक से अधिक पॉइंटर के लिए एक ही एंकर का उपयोग करने से स्क्रिप्ट विफल हो जाएगी। दूसरी समस्या यह है कि कुछ पॉइंटर्स आईडी में एंकर का उपयोग करते हैं जो पृष्ठ में नहीं हो सकता है। जैसे एक सूचक index.php में '# टिप्पणी -55' के लिए है, और यह नहीं मिला है। कुछ संकेत पोस्ट.फैप में ऐसे मेटाबोक्स को लक्षित करते हैं जो छिपे हो सकते हैं ... और इसी तरह। स्क्रिप्ट पॉइंटर्स के वर्तमान संस्करण में एक बार "जंजीर" हो जाती है यदि एक नहीं मिली तो सभी बाद वाले भी काम नहीं करेंगे। मैं यह देखने जा रहा हूं कि क्या उन मुद्दों को दूर करने का एक सरल तरीका है।
gmazzap

1
@ क्रिसिनकोपर ग्लैड यह काम किया। मैं यहाँ Gist से सभी कोड कॉपी करूँगा। add_action( 'admin_enqueue_scripts', function( $page ) {यदि उपयोगकर्ता की कोई आवश्यक भूमिका नहीं है, तो बस वापस लौटने के बाद शर्त रखी जा सकती है ।
gmazzap

कृपया 30 मान को 120 पर लाइन में बदलें: "स्क्रॉलटॉप: $ पॉइंटर.ऑफसेट ()। शीर्ष - 30" - इसका कारण यह है कि शीर्ष टूलबार स्क्रॉल करते समय कभी-कभी पॉइंटर विंडो को कवर करता है।
क्रिस्टीन कूपर

मुझे एक छोटी सी समस्या है। जिस पृष्ठ को प्रदर्शित करने के लिए मुझे कुछ बिंदुओं की आवश्यकता है, वह यह है: "admin.php? पृष्ठ = प्लगइन-पथ / file.php" - मैं वास्तव में कहां से जोड़ूं ? मैंने "admin.php", "plugin-path / file.php", "file.php" और मेरे द्वारा सोचे गए किसी भी भिन्नता की कोशिश की। क्या कोई कारण है कि यह इस पृष्ठ का पता नहीं लगा सकता है या क्या मैं यह गलत कर रहा हूं?
क्रिस्टीन कूपर

1
@ChristineCooper प्लगइन व्यवस्थापक पृष्ठ खोलें और ब्राउज़र से url की प्रतिलिपि बनाएँ । उसके बाद, उस फ़ाइल को खोलें जिसमें मेरा कोड ऊपर है। कक्षा public function filter( $page ) {में लाइन का पता लगाएं PointersManager, और उसके तुरंत बाद लाइन लगाएं die($page);। अपना ब्राउज़र खोलें और url को वापस पेस्ट करें, पृष्ठ एक स्ट्रिंग के साथ मर जाएगा: यह वही है जो आपको उपयोग करना है 'where'
gmazzap

7

आह्ह .. हाँ। वर्डप्रेस पॉइंटर्स। आप जानते हैं, पॉइंटर्स का उपयोग करने पर काफी मिश्रित भावनाएँ होती हैं;)

आप ऊपर दिए गए अपने कोड के साथ सही रास्ते पर थे। लेकिन कुछ मुद्दे हैं।

@GM pointer('open')एक बार में आपके सभी पॉइंटर्स को खोलने वाली कमांड के बारे में सही है । इसके अलावा, आप संकेत के माध्यम से अग्रिम करने के लिए एक विधि प्रदान नहीं कर रहे हैं।

मैंने इसी मुद्दे पर लड़ाई लड़ी .. और अपने दृष्टिकोण के साथ आया। मैं url में एक क्वेरी चर का उपयोग करता हूं, पृष्ठ को उस व्यवस्थापक पृष्ठ पर पुनः लोड करता हूं, जहां मैं अगला पॉइंटर प्रदर्शित करना चाहता हूं, और jQuery को शेष को संभालने देता हूं।

WP पॉइंटर्स क्लास

मैंने इसे एक वर्ग के रूप में लिखने का फैसला किया। लेकिन मैं आपको यह समझने में मदद करने के लिए पहली बार वेतन वृद्धि में दिखाने जा रहा हूं कि क्या हो रहा है।

कक्षा की शुरुआत

// Create as a class
class testWPpointers {

    // Define pointer version
    const DISPLAY_VERSION = 'v1.0';

    // Initiate construct
    function __construct () {
        add_action('admin_enqueue_scripts', array($this, 'admin_enqueue_scripts'));  // Hook to admin_enqueue_scripts
    }

    function admin_enqueue_scripts () {

        // Check to see if user has already dismissed the pointer tour
        $dismissed = explode (',', get_user_meta (wp_get_current_user ()->ID, 'dismissed_wp_pointers', true));
        $do_tour = !in_array ('test_wp_pointer', $dismissed);

        // If not, we are good to continue
        if ($do_tour) {

            // Enqueue necessary WP scripts and styles
            wp_enqueue_style ('wp-pointer');
            wp_enqueue_script ('wp-pointer');

            // Finish hooking to WP admin areas
            add_action('admin_print_footer_scripts', array($this, 'admin_print_footer_scripts'));  // Hook to admin footer scripts
            add_action('admin_head', array($this, 'admin_head'));  // Hook to admin head
        }
    }

    // Used to add spacing between the two buttons in the pointer overlay window.
    function admin_head () {
        ?>
        <style type="text/css" media="screen">
            #pointer-primary {
                margin: 0 5px 0 0;
            }
        </style>
        <?php
    }
  1. हमने वर्ग को परिभाषित किया है।
  2. हमने कक्षा का निर्माण किया, और इसमें एक क्रिया जोड़ी admin_enqueue_scripts
  3. हमने निर्धारित किया कि हमारे संकेत पहले ही खारिज कर दिए गए हैं।
  4. यदि नहीं, तो हम आवश्यक स्क्रिप्ट को जारी रखना चाहते हैं।

आपको इन पहले कार्यों में कुछ भी बदलने की आवश्यकता नहीं है।

पॉइंटर आइटम की सरणी सेट करना

अगला चरण प्रत्येक बिंदु को परिभाषित कर रहा है। पांच आइटम हैं जिन्हें हमें परिभाषित करने की आवश्यकता है (अंतिम पॉइंटर के लिए छूट)। हम एरे का उपयोग करके ऐसा करेंगे। आइए फ़ंक्शन पर एक नज़र डालें:

// Define footer scripts
function admin_print_footer_scripts () {

    // Define global variables
    global $pagenow;
    global $current_user;

    //*****************************************************************************************************
    // This is our array of individual pointers.
    // -- The array key should be unique.  It is what will be used to 'advance' to the next pointer.
    // -- The 'id' should correspond to an html element id on the page.
    // -- The 'content' will be displayed inside the pointer overlay window.
    // -- The 'button2' is the text to show for the 'action' button in the pointer overlay window.
    // -- The 'function' is the method used to reload the window (or relocate to a new window).
    //    This also creates a query variable to add to the end of the url.
    //    The query variable is used to determine which pointer to display.
    //*****************************************************************************************************
    $tour = array (
        'quick_press' => array (
            'id' => '#dashboard_quick_press',
            'content' => '<h3>' . __('Congratulations!', 'test_lang') . '</h3>'
                . '<p><strong>' . __('WP Pointers is working properly.', 'test_lang') . '</strong></p>'
                . '<p>' . __('This pointer is attached to the "Quick Draft" admin widget.', 'test_lang') . '</p>'
                . '<p>' . __('Our next pointer will take us to the "Settings" admin menu.', 'test_lang') . '</p>',
            'button2' => __('Next', 'test_lang'),
            'function' => 'window.location="' . $this->get_admin_url('options-general.php', 'site_title') . '"'  // We are relocating to "Settings" page with the 'site_title' query var
            ),
        'site_title' => array (
            'id' => '#blogname',
            'content' => '<h3>' . __('Moving along to Site Title.', 'test_lang') . '</h3>'
            . '<p><strong>' . __('Another WP Pointer.', 'test_lang') . '</strong></p>'
            . '<p>' . __('This pointer is attached to the "Blog Title" input field.', 'test_lang') . '</p>',
            'button2' => __('Next', 'test_lang'),
            'function' => 'window.location="' . $this->get_admin_url('index.php', 'quick_press_last') . '"'  // We are relocating back to "Dashboard" with 'quick_press_last' query var
            ),
        'quick_press_last' => array (
            'id' => '#dashboard_quick_press',
            'content' => '<h3>' . __('This concludes our WP Pointers tour.', 'test_lang') . '</h3>'
            . '<p><strong>' . __('Last WP Pointer.', 'test_lang') . '</strong></p>'
            . '<p>' . __('When closing the pointer tour; it will be saved in the users custom meta.  The tour will NOT be shown to that user again.', 'test_lang') . '</p>'
            )
        );

    // Determine which tab is set in the query variable
    $tab = isset($_GET['tab']) ? $_GET['tab'] : '';
    // Define other variables
    $function = '';
    $button2 = '';
    $options = array ();
    $show_pointer = false;

    // *******************************************************************************************************
    // This will be the first pointer shown to the user.
    // If no query variable is set in the url.. then the 'tab' cannot be determined... and we start with this pointer.
    // *******************************************************************************************************
    if (!array_key_exists($tab, $tour)) {

        $show_pointer = true;
        $file_error = true;

        $id = '#dashboard_right_now';  // Define ID used on page html element where we want to display pointer
        $content = '<h3>' . sprintf (__('Test WP Pointers %s', 'test_lang'), self::DISPLAY_VERSION) . '</h3>';
        $content .= __('<p>Welcome to Test WP Pointers admin tour!</p>', 'test_lang');
        $content .= __('<p>This pointer is attached to the "At a Glance" dashboard widget.</p>', 'test_lang');
        $content .= '<p>' . __('Click the <em>Begin Tour</em> button to get started.', 'test_lang' ) . '</p>';

        $options = array (
            'content' => $content,
            'position' => array ('edge' => 'top', 'align' => 'left')
            );
        $button2 = __('Begin Tour', 'test_lang' );
        $function = 'document.location="' . $this->get_admin_url('index.php', 'quick_press') . '";';
    }
    // Else if the 'tab' is set in the query variable.. then we can determine which pointer to display
    else {

        if ($tab != '' && in_array ($tab, array_keys ($tour))) {

            $show_pointer = true;

            if (isset ($tour[$tab]['id'])) {
                $id = $tour[$tab]['id'];
            }

            $options = array (
                'content' => $tour[$tab]['content'],
                'position' => array ('edge' => 'top', 'align' => 'left')
            );

            $button2 = false;
            $function = '';

            if (isset ($tour[$tab]['button2'])) {
                $button2 = $tour[$tab]['button2'];
            }
            if (isset ($tour[$tab]['function'])) {
                $function = $tour[$tab]['function'];
            }
        }
    }

    // If we are showing a pointer... let's load the jQuery.
    if ($show_pointer) {
        $this->make_pointer_script ($id, $options, __('Close', 'test_lang'), $button2, $function);
    }
}

ठीक है .. चलो यहाँ कुछ चीजों पर एक नज़र डालते हैं।

पहला, हमारी $tourसरणी। यह वह व्यूह है जो उपयोगकर्ता को प्रदर्शित होने वाले पहले पॉइंटर को इंगित करता है (जो बाद में इस पर अधिक दिखाई देता है)। इसलिए, आप दूसरे पॉइंटर के साथ शुरुआत करना चाहते हैं जिसे आप दिखाना चाहते हैं .. और अंतिम पॉइंटर के माध्यम से जारी रखें।

अगला, हमारे पास कुछ आइटम हैं जो बहुत महत्वपूर्ण हैं।

  1. $tourसरणी कुंजी अद्वितीय (; ऊपर के उदाहरण के रूप में quick_press, SITE_TITLE, quick_press_last) होना चाहिए।
  2. 'Id' कमांड आपको उस पॉइंटर के html एलिमेंट आईडी से मेल खाना चाहिए जिसे आप पॉइंटर से जोड़ना चाहते हैं।
  3. functionआदेश को फिर से लोड / खिड़की पुनर्स्थापित हो जाएगा। यह वह है जो अगले पॉइंटर को दिखाने के लिए उपयोग किया जाता है। हमें या तो खिड़की को फिर से लोड करना होगा, या इसे अगले व्यवस्थापक पृष्ठ पर स्थानांतरित करना होगा जहां एक संकेतक प्रदर्शित किया जाएगा।
  4. हम get_admin_url()फ़ंक्शन को दो चर के साथ चलाते हैं ; पहला व्यवस्थापक पृष्ठ है जहां हम आगे जाना चाहते हैं; और दूसरा सूचक की अद्वितीय सरणी कुंजी है जिसे हम प्रदर्शित करना चाहते हैं।

और नीचे, आपको वह कोड दिखाई देगा जो शुरू होता है if (!array_key_exists($tab, $tour)) {। यह वह जगह है जहाँ हम निर्धारित करते हैं कि क्या url क्वेरी चर सेट किया गया है। यदि यह नहीं है, तो हमें प्रदर्शित करने के लिए पहले पॉइंटर को परिभाषित करने की आवश्यकता है।

यह सूचक ठीक उसी id, content, button2, and functionवस्तुओं का उपयोग करता है जैसा कि $tourऊपर हमारे सरणी में उपयोग किया गया है। याद रखें, get_admin_url()फ़ंक्शन का दूसरा तर्क MUST में सरणी कुंजी के समान सटीक होना चाहिए $tour। यह वह है जो स्क्रिप्ट को अगले पॉइंटर पर जाने के लिए कहता है।

फ़ंक्शन का शेष भाग उपयोग किया जाता है यदि कोई क्वेरी चर पहले से ही url में सेट है। फ़ंक्शन के किसी भी अधिक को समायोजित करने की आवश्यकता नहीं है।

व्यवस्थापक Url प्राप्त करना अगला फ़ंक्शन वास्तव में एक सहायक फ़ंक्शन है ... जिसका उपयोग व्यवस्थापक url प्राप्त करने और पॉइंटर को आगे बढ़ाने के लिए किया जाता है।

// This function is used to reload the admin page.
// -- $page = the admin page we are passing (index.php or options-general.php)
// -- $tab = the NEXT pointer array key we want to display
function get_admin_url($page, $tab) {

    $url = admin_url();
    $url .= $page.'?tab='.$tab;

    return $url;
}

याद रखें, दो तर्क हैं; हम जिस व्यवस्थापक पृष्ठ पर जा रहे हैं .. और टैब। टैब वह $tourसरणी कुंजी होगी जिसे हम अगले पर जाना चाहते हैं। यह आवश्यक है

इसलिए, जब हम फ़ंक्शन को कॉल करते हैं get_admin_url()और दो चर पास करते हैं; पहला चर अगले व्यवस्थापक पृष्ठ को निर्धारित करता है .. और दूसरा चर निर्धारित करता है कि किस सूचक को प्रदर्शित करना है।

अंत में ... हम अंत में पाद लेख को व्यवस्थापक स्क्रिप्ट प्रिंट कर सकते हैं।

// Print footer scripts
function make_pointer_script ($id, $options, $button1, $button2=false, $function='') {

    ?>
    <script type="text/javascript">

        (function ($) {

            // Define pointer options
            var wp_pointers_tour_opts = <?php echo json_encode ($options); ?>, setup;

            wp_pointers_tour_opts = $.extend (wp_pointers_tour_opts, {

                // Add 'Close' button
                buttons: function (event, t) {

                    button = jQuery ('<a id="pointer-close" class="button-secondary">' + '<?php echo $button1; ?>' + '</a>');
                    button.bind ('click.pointer', function () {
                        t.element.pointer ('close');
                    });
                    return button;
                },
                close: function () {

                    // Post to admin ajax to disable pointers when user clicks "Close"
                    $.post (ajaxurl, {
                        pointer: 'test_wp_pointer',
                        action: 'dismiss-wp-pointer'
                    });
                }
            });

            // This is used for our "button2" value above (advances the pointers)
            setup = function () {

                $('<?php echo $id; ?>').pointer(wp_pointers_tour_opts).pointer('open');

                <?php if ($button2) { ?>

                    jQuery ('#pointer-close').after ('<a id="pointer-primary" class="button-primary">' + '<?php echo $button2; ?>' + '</a>');
                    jQuery ('#pointer-primary').click (function () {
                        <?php echo $function; ?>  // Execute button2 function
                    });
                    jQuery ('#pointer-close').click (function () {

                        // Post to admin ajax to disable pointers when user clicks "Close"
                        $.post (ajaxurl, {
                            pointer: 'test_wp_pointer',
                            action: 'dismiss-wp-pointer'
                        });
                    })
                <?php } ?>
            };

            if (wp_pointers_tour_opts.position && wp_pointers_tour_opts.position.defer_loading) {

                $(window).bind('load.wp-pointers', setup);
            }
            else {
                setup ();
            }
        }) (jQuery);
    </script>
    <?php
}
} 
$testWPpointers = new testWPpointers();

फिर, ऊपर कुछ भी बदलने की आवश्यकता नहीं है। यह स्क्रिप्ट पॉइंटर ओवरले विंडो में दो बटन को परिभाषित और आउटपुट करेगी। एक हमेशा "बंद" बटन होगा; और वर्तमान उपयोगकर्ता मेटा dismissed_pointersविकल्प को अपडेट करेगा ।

दूसरा बटन (एक्शन बटन) फ़ंक्शन को निष्पादित करेगा (हमारी विंडो स्थानांतरण विधि)।

और हम क्लास बंद कर देते हैं।

यहाँ यह पूरी तरह से कोड है। WP सूचक कक्षा

आप उस कॉपी को अपने देव स्थल पर कॉपी और पेस्ट कर सकते हैं और "डैशबोर्ड" पृष्ठ पर जा सकते हैं। यह टूर के माध्यम से आपका मार्गदर्शन करेगा।

याद रखें, यह थोड़ा भ्रमित करने वाला है कि पहला पॉइंटर कोड में अंतिम रूप से परिभाषित है। यह काम करने का तरीका है। सरणी आपके द्वारा उपयोग किए जाने वाले शेष सभी बिंदुओं को रखेगा।

याद रखें, 'id' एरे आइटम get_admin_url()केवल पिछले एरे आइटम 'फंक्शन' कमांड से फ़ंक्शन के दूसरे तर्क से मेल खाना चाहिए । यह इस प्रकार है कि संकेतकर्ता एक-दूसरे से 'बात' करते हैं और आगे बढ़ना जानते हैं।

का आनंद लें!! :)


यह प्यारा जोश है, बहुत बहुत धन्यवाद! मैं इसे आज़माता हूँ और देखता हूँ कि यह कितनी अच्छी तरह काम करता है। मुझे यह उजागर करना चाहिए कि जीएम का कोड वह है जो मैं इस इनाम को प्रदान करूंगा क्योंकि इसमें कुछ आवश्यक विशेषताएं हैं, जिनके लिए मैंने अनुरोध किया था और मेरा मानना ​​है कि गाइड बनाने के लिए महत्वपूर्ण है, विशेष रूप से wp-admin में कई पृष्ठों के लिए। बहरहाल, इस पर एक और दृष्टिकोण देखना बहुत अच्छा है और अन्य उपयोगकर्ताओं के लिए काम आएगा जो एक अच्छे समाधान की तलाश में हैं। जिज्ञासा से बाहर, आपने कहा कि बिंदुओं का उपयोग करने की बात आती है, तो मिश्रित भावनाओं का काफी विस्तार होता है?
क्रिस्टीन कूपर

2
कोई चिंता नहीं :) ठीक है, संकेत 'रास्ते में मिल सकता है' जब अतिरिक्त में उपयोग किया जाता है। कोई भी एक पृष्ठ पर नहीं जाना चाहता है और तीन या चार पॉइंटर्स डिस्प्ले है ... खासकर यदि वे असंबंधित हैं। कहते हैं दो अन्य प्लगइन्स पॉइंटर्स दिखा रहे हैं, फिर हम अधिक पॉइंटर्स जोड़ते हैं .. यह ओवरकिल बन सकता है। ज्यादातर लोग उन्हें संयम से इस्तेमाल करने के लिए कहते हैं ... लेकिन प्रत्येक अपने स्वयं के हैं :) खुशी है कि आप इसे ठीक से काम कर रहे हैं।
जॉश

1
यह भी भयानक जोश है, मैं इसे और अधिक लचीला बनाने के लिए 1 सुझाव दूंगा और यह वह जगह है जहां आप केवल कक्षा कोड के अंदर ही संग्रहीत करने के बजाय किसी सार्वजनिक फ़ंक्शन में सरणी में पास कर सकते हैं। दूसरा, पहला पॉइंटर, यह अलग कैसे होता है, इसे संशोधित करें ताकि यह पॉइंटर ऐरे में पहला एरो की / वैल्यू हो। सिर्फ एक दो विचार इसलिए इस वर्ग को किसी अन्य स्क्रिप्ट से बुलाया जा सकता है और बस पॉइंटर की सरणी में पास किया गया है। मैं अभी भी इसे वास्तव में पसंद करता हूं, साझा करने के लिए धन्यवाद मैं इसका उपयोग करूंगा!
जेसनडेविस

धन्यवाद @ तेजसवीवि। मैंने वास्तव में उस कोड को किसी अन्य प्लगइन से खींचा था जिसे मैंने किसी के लिए विकसित किया था। मुझे केवल इसे ठीक से काम करने में दिलचस्पी थी। लेकिन हां, मैं आपसे पूरी तरह सहमत हूं ... इसे साफ करने की जरूरत है। शायद मैं बाद में आज तक रुक जाऊंगा और फिर से गड़बड़ कर दूंगा :) आप रॉक, भाई!
जोश

यह अच्छा है, मुझे वास्तव में एडमिन पॉइंटर्स का उपयोग करने का कोई इरादा नहीं था, मुख्यतः क्योंकि वे एक दुःस्वप्न और 2 की तरह दिखते थे क्योंकि मेरे पास उनके लिए कोई वास्तविक उपयोग नहीं है, लेकिन आपकी कक्षा उन्हें अब उपयोग करने में इतना आसान बनाती है कि मुझे लगता है कि मैं उस वर्ग के साथ इतना आसान होने के साथ उनका उपयोग करना होगा! मुझे उस तरह की छोटी परियोजनाएँ / लाइब्रेरियाँ बहुत अच्छी
लगती हैं
हमारी साइट का प्रयोग करके, आप स्वीकार करते हैं कि आपने हमारी Cookie Policy और निजता नीति को पढ़ और समझा लिया है।
Licensed under cc by-sa 3.0 with attribution required.