ショートコードでAJAXを使用する


9

ランダムな引用を表示するショートコードに次のコードがあります。質問:ボタンに新しいランダムな引用を表示させる方法は?つまり、ボタンをクリックすると、新しい見積もりが表示されます(もちろん、ページを更新する必要はありません)。

function random_quote() {

    // quotes file
     $array = file("/path to txt file");

    // generate a random number between 0 and the total count of $array minus 1
    // we minus 1 from the total quotes because array indices start at 0 rather than 1 by default
    $r = rand(0,count($array)-1);

    // return the quote in the array with an indices of $r - our random number
    return $array[rand(0,count($array)-1)];
}

add_shortcode( 'randomquotes', 'random_quote');

WordPressでajaxを使用してページのコンテンツを更新する方法に興味がありますか?私の状況では、実際には正確にそうです。

英語が下手でごめんなさい。ご理解いただければ幸いです。ありがとう!

回答:


4

まず、これはWPSEの範囲内で非常に境​​界線です。
初期HTML出力をトリガーするショートコードは別として、これは実際には単なるAJAXです。

とにかく、それが言われている、これはそれが行われる方法です:

PHP

提供した上記のPHPスニペットが機能していると仮定して、ajax呼び出し用のphpファイルに以下を配置します。

/wp-content/themes/%your_theme%/js/ajax-load-quote.php

 <?php
 /* uncomment the below, if you want to use native WP functions in this file */
// require_once('../../../../wp-load.php');

 $array = file( $_POST['file_path'] ); // file path in $_POST, as from the js
 $r = rand( 0, count($array) - 1 );

 return '<p>' . $array[$r] . '</p>';
 ?>

将来の参考のため、およびこの回答を他の人に役立つwp-load.phpようにするために:ネイティブのWordPress機能を利用するために含める必要があることに注意してください。最も一般的なケースは、WP_Queryまたはのいずれかである可能性があります$wpdb

HTML構造

ページコンテンツ、ウィジェット、またはテンプレートファイル:

<div id="randomquotes">
    <p>I would rather have my ignorance than another man’s knowledge,
       because I have so much more of it.<br />
       -- Mark Twain, American author & Playwright</p>
</div>
<a id="newquote" class="button" href="#" title="Gimme a new one!">New Quote</a>

これは明らかに好みに合わせて調整できますが、この例では、これを使用します。
後でショートコードを介して上記を生成します。

jQuery

/wp-content/themes/%your_theme%/js/ajax-load-quote.js

function ajaxQuote() {
    var theQuote = jQuery.ajax({
        type: 'POST',
        url: ajaxParams.themeURI+'js/ajax-load-quote.php',
        /* supplying the file path to the ajax loaded php as a $_POST variable */
        data: { file_path: ajaxParams.filePath },
        beforeSend: function() {
            ajaxLoadingScreen(true,'#randomquotes');
        },
        success: function(data) {
            jQuery('#randomquotes').find('p').remove();
            jQuery('#randomquotes').prepend(data);
        },
        complete: function() {
            ajaxLoadingScreen(false,'#randomquotes');
        }
    });
    return theQuote;
}
/* Loading screen to be displayed during the process, optional */
function ajaxLoadingScreen(switchOn,element) {
    /* show loading screen */
    if (switchOn) {
        jQuery(''+element).css({
            'position': 'relative'
        });
        var appendHTML = '<div class="ajax-loading-screen appended">
            <img src="'+ajaxParams.themeURI+'images/ajax-loader.gif"
                alt="Loading ..." width="16" height="16" /></div>';
        if( jQuery(''+element).children('.ajax-loading-screen').length === 0 ) {
            jQuery(''+element).append(appendHTML);
        }
        jQuery(''+element).children('.ajax-loading-screen').first().css({
            'display': 'block',
            'visibility': 'visible',
            'filter': 'alpha(opacity=100)',
            '-ms-filter': '"progid:DXImageTransform.Microsoft.Alpha(Opacity=100)"',
            'opacity': '1'
        });
    } else {
        /* hide the loading screen */
        jQuery(''+element).children('.ajax-loading-screen').css({
            'display': '',
            'visibility': '',
            'filter': '',
            '-ms-filter': '',
            'opacity': ''
        });
        jQuery(''+element).css({
            'position': ''
        });
    }
}
/* triggering the above via the click event */
jQuery('#newquotes').click( function() {
    var theQuote = ajaxQuote();
    return false;
});

functions.phpにまとめる

上記のスニペット(以下に変更が含まれていることがわかります)の下に、以下を貼り付けます。

function random_quote( $atts ) {
    /* extracts the value of shortcode argument path */
    extract( shortcode_atts( array(
        'path' => get_template_directory_uri() . '/quotes.txt' // default, if not set
    ), $atts ) );
    $array = file( $path );
    $r = rand( 0, count($array) - 1 );
    $output = '<div id="randomquotes">' .
            '<p>' . $array[$r] . '</p>' .
        '</div>' .
        '<a id="newquote" class="button" href="#" title="Gimme a new one!">New Quote</a>';
    /* enqueue the below registered script, if needed */
    wp_enqueue_script( 'ajax-quote' );
    /* supplying the file path to the script */
    wp_localize_script(
        'ajax-quote',
        'ajaxParams',
        array(
            'filePath' => $path,
            'themeURI' => get_template_directory_uri() . '/'
        )
    );
    return $output;
}
add_shortcode( 'randomquotes', 'random_quote');
/* register the js */
function wpse72974_load_scripts() {
    if ( ! is_admin() ) {
        wp_register_script(
           'ajax-quote', 
            get_template_directory_uri() . '/js/ajax-load-quote.js',
            array( 'jquery' ),
            '1.0',
            true
        );
    }
}
add_action ( 'init', 'wpse72974_load_scripts' );

オプション:ロード画面のCSS

.ajax-loading-screen {
    display: none;
    visibility: hidden;
    position: absolute;
    top: 0;
    right: 0;
    bottom: 0;
    left: 0;
    width: 100%;
    background: #ffffff; /* the background of your site or the container of the quote */
    filter: alpha(opacity=0);
    -ms-filter:"progid:DXImageTransform.Microsoft.Alpha(Opacity=0)";
    opacity: 0;
    -webkit-transition:  opacity .1s;
    -moz-transition:  opacity .1s;
    -ms-transition:  opacity .1s;
    -o-transition: opacity .1s;
    transition: opacity .1s;
    z-index: 9999;
}
.ajax-loading-screen img {
    position: absolute;
    top: 50%;
    left: 50%;
    margin: -8px 0 0 -8px;
}

リソース/読書


1
組み込みのAJAX APIを使用しない理由はありますか?
fuxia

@toscho正直なところ、あまり詳しくない。読む価値がありますか?
ヨハネスピレ

そのとおり。:)私は代替を追加します。
fuxia

パーフェクト!ありがとう!<br/>関数の引数を設定すると、スクリプトは機能しますか?たとえば、テキストファイルへのリンクを提供するためにショートコードに入るには?<br/> function random_quote ($path) {      $ array = file ("$ path");<br/> ... [randomquote file = "http://exampe.com/file.txt"]<br/>それでうまくいくでしょうか?私はプログラミングに精通していません。
user23769 '18 / 11/18

答えを更新しました。これには、ショートコードによって設定され、js [randomquotes path="path/to/file.txt"]に渡され、そこからphpスクリプトに渡されるファイルパスが含まれています。
ヨハネスピレ

7

スクリプトをショートコードで登録できます。テーマにが含まれている場合、フッターに印刷されますwp_footer()

使い方:

  1. でショートコードコールバックを登録しますadd_shortcode()
  2. ショートコードコールバックで、スクリプトを登録し、出力を返します。
  3. スクリプトで更新ボタンを追加し、POSTリクエストをに送信してadmin_url( 'admin-ajax.php' )新しいデータをフェッチします。返されたデータをショートコードの要素に挿入します。

これを行うサンプルスクリプトを次に示します。2つのファイル:PHPクラスとJavaScriptファイル。両方とも同じディレクトリに配置する必要がありajax-shortcode-demoます。

ajax-shortcode-demo.php

<?php
/**
 * Plugin Name: AJAX Shortcode Demo
 * Description: How to use AJAX from a shortcode handler named <code>[ajaxdemo]</code>.
 */

add_action( 'wp_loaded', array ( 'Ajax_Shortcode_Demo', 'get_instance' ) );

class Ajax_Shortcode_Demo
{
    /**
     * Current plugin instance
     *
     * @type NULL|object
     */
    protected static $instance = NULL;

    /**
     * Unique action name to trigger our callback
     *
     * @type string
     */
    protected $ajax_action = 'load_demo_data';

    /**
     * CSS class for the shortcode, reused as JavaScript handle.
     *
     * Must be unique too.
     *
     * @type string
     */
    protected $shortcode_class = 'ajaxdemo';

    /**
     * Remeber if we had regsitered a script on a page already.
     *
     * @type boolean
     */
    protected $script_registered = FALSE;

    /**
     * Create a new instance.
     *
     * @wp-hook wp_loaded
     * @return  object $this
     */
    public static function get_instance()
    {
        NULL === self::$instance and self::$instance = new self;
        return self::$instance;
    }

    /**
     * Constructor. Register shortcode and AJAX callback handlers.
     */
    public function __construct()
    {
        add_shortcode( 'ajaxdemo', array ( $this, 'shortcode_handler' ) );

        // register the AJAX callback
        $callback = array ( $this, 'ajax_callback' );
        // user who are logged in
        add_action( "wp_ajax_$this->ajax_action", $callback );
        // anonymous users
        add_action( "wp_ajax_nopriv_$this->ajax_action", $callback );
    }

    /**
     * Render the shortcode.
     */
    public function shortcode_handler()
    {
        $this->register_scripts();

        return sprintf(
            '<div class="%1$s"><b>%2$s</b></div>',
            $this->shortcode_class,
            $this->get_rand()
        );
    }

    /**
     * Return AJAX result.
     *
     * Must 'echo' and 'die'.
     *
     * @wp-hook wp_ajax_$this->ajax_action
     * @wp-hook wp_ajax_nopriv_$this->ajax_action
     * @return int
     */
    public function ajax_callback()
    {
        echo $this->get_rand();
        exit;
    }

    /**
     * Random number.
     *
     * @return int
     */
    protected function get_rand()
    {
        return rand( 1, 1000 );
    }

    /**
     * Register script and global data object.
     *
     * The data will be printent before the linked script.
     */
    protected function register_scripts()
    {
        if ( $this->script_registered )
            return;

        $this->script_registered = TRUE;

        wp_register_script(
            // unique handle
            $this->shortcode_class,
            // script URL
            plugin_dir_url( __FILE__ ) . '/jquery-ajax-demo.js',
            // dependencies
            array ( 'jquery'),
            // version
            'v1',
            // print in footer
            TRUE
        );

        wp_enqueue_script( $this->shortcode_class );

        $data = array (
            // URL address for AJAX request
            'ajaxUrl'   => admin_url( 'admin-ajax.php' ),
            // action to trigger our callback
            'action'    => $this->ajax_action,
            // selector for jQuery
            'democlass' => $this->shortcode_class
        );

        wp_localize_script( $this->shortcode_class, 'AjaxDemo', $data );
    }
}

jquery-ajax-demo.js

jQuery( function( $ ) {

    var buttonClass = AjaxDemo.democlass + 'Button',
        // insert AJAX result into the shortcode element
        updateDemo = function( response ){          
            $( '.' + AjaxDemo.democlass ).find( 'b' ).html( response );
        },
        // fetch AJAX data
        loadDemo = function() {
            $.post( AjaxDemo.ajaxUrl, { action: AjaxDemo.action }, updateDemo );
        };

    // add an update button
    $( '.' + AjaxDemo.democlass )
        .append( ' <button class="' + buttonClass + '">New</button>' );

    // assign the clock handler to the button
    $( '.' + buttonClass ).click( loadDemo );
});

ブログ投稿の結果:

ここに画像の説明を入力してください


+1&上記をありがとう。必ず読んでおく価値があります。上記で起こっていることの大部分は理解できたと思います。コーデックスのページは私の読書予定にあり、とにかくソースをチェックアウトするでしょう。それでも、2つの簡単なフォローアップの質問をさせてください。APIを使用すると、プログラマー(クリーンで簡潔、環境(つまりWP)に結び付けられる)にとって有利になることがわかります。1.パフォーマンスはどうですか?jQueryを直接使用することと比較した利点または欠点(ストレートjs​​に対するパフォーマンスのギャップを認識しています)?2.柔軟性はありますか?つまり、同じコールバックと引数を使用できますか?
Johannes Pille、

@JohannesPilleパフォーマンスは完璧ではありません。一方、あなたは予測可能な環境で行動し、他のプラグインはコード(フック、関数)を再利用でき、WPがインストールされている場所を知る必要はありません(プラグインディレクトリ/ URLが異なる場合があります)サーバ)。それ以外は、カスタムソリューションと同じです。
fuxia

@toscho define('WP_DEBUG', true);wp-config.phpでを有効にすると、このソリューションはエラーを生成しましたStrict Standards: call_user_func_array() expects parameter 1 to be a valid callback, non-static method Ajax_Shortcode_Demo::get_instance() should not be called statically in /var/www/.../public_html/wp-includes/plugin.php on line 496。これは重要ですか?私は少し変更しました:wordpress.stackexchange.com/q/196332/25187
Iurie Malai

1
@Iurieええ、そのメソッドはとして宣言する必要がありますstatic。そのために投稿を編集しました。お知らせありがとうございます。このようなコードはもう記述しません。:)
fuxia
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.