.pointer( 'open' );
すべてのポインターオブジェクトでJavaScript関数を呼び出しているので、すべてのポインターが同時に表示されるのは当然のことです...
とはいえ、なぜすべてのポインター(アクティブでないものも含む)を返しcustom_admin_pointers()
、アクティブなポインターがあるかどうかをチェックする追加の関数と、ポインターループ内のチェック(if ( $array['active'] ) {
)を追加してJavaScriptポインターを追加する理由がわかりません か否か。アクティブなポインタのみを返すだけの方が簡単ではありませんか?
さらに、すべての管理ページにそのJavaScriptを追加していますが、多すぎませんか?また、「#save-post」などの一部の要素は新しい投稿ページでのみ使用できるため、新しいポットページでのみポインタを追加した方がよいでしょうか。
最後に、JavaScriptとPHPが混同されているので、wp_localize_script
データをJavaScriptに渡すことを検討する必要があります。
計画:
- PHPのポインター定義を別のファイルに移動します。これにより、編集が簡単になり、PHPコードからマークアップを削除することもでき、すべてがより読みやすく、保守しやすくなります。
- ポインタではそれはポップアップが表示されるべき管理ページで設定するために使用されます「」プロパティを追加した構成:
post-new.php
、index.php
...
- ポインタ情報の読み込み、解析、フィルタリングを処理するクラスを記述します
- デフォルトの「削除」ボタンを「次へ」に変更するのに役立つ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;
すべてのポインター構成はこちらです。何かを変更する必要がある場合は、このファイルを開いて編集します。
ポインタを使用できる必要があるページの配列である「where」プロパティに注意してください。
プラグインによって生成されたページにポインターを表示したい場合は、以下に概説されているこの行を探し、そのすぐ下に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;
}
}
コードは非常にシンプルで、インターフェースが期待するとおりの動作をします。
ただし、クラス自体は何も実行せず、適切な引数を渡して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 );
} );
特別なことは何もありません。クラスを使用してポインターデータを取得し、一部のポインターがフィルターを通過する場合は、スタイルとスクリプトをエンキューします。次に、ボタンのローカライズされた「次へ」ラベルに沿って、ポインタデータをスクリプトに渡します。
では、「最も難しい」部分であるjsです。繰り返しになりますが、WordPressが使用するポインタープラグインがわからないことを強調したいと思います。そのため、誰かがそれを知っていれば、自分のコードで行うことをよりうまく行うことができます。
( 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はよりシンプルでよりよく整理されており、JavaScriptはより読みやすく、ポインタはより簡単に編集でき、さらに重要なことにすべてが機能します。