Użyj AJAX jako shortcode

9

Mam następujący kod do shortcode, aby wyświetlić losową ofertę. Pytanie: jak sprawić, by przycisk wyświetlał nową losową wycenę? Mam na myśli, że naciśnięcie tego przycisku spowoduje wyświetlenie nowego cytatu (bez odświeżania strony, oczywiście).

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');

Interesuje mnie, jak możesz zaktualizować treść na stronie za pomocą ajax w WordPress? W mojej sytuacji, bo w rzeczywistości tak właśnie jest.

Przepraszam za mój zły angielski. Mam nadzieję, że mnie rozumiesz. Dzięki!

użytkownik23769
źródło

Odpowiedzi:

4

Po pierwsze, jest to bardzo granica w ramach WPSE, w ogóle.
Oprócz krótkiego kodu wyzwalającego początkowe wyjście HTML, tak naprawdę jest to tylko AJAX.

Tak czy inaczej, tak to się dzieje:

PHP

Zakładając, że powyższy fragment kodu PHP jest funkcjonalny, umieść go w pliku php dla wywołania ajax:

/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>';
 ?>

Do wykorzystania w przyszłości, aby ta odpowiedź była przydatna dla innych: Uwaga: wp-load.phpnależy ją uwzględnić, aby móc korzystać z natywnej funkcjonalności WordPress. Najbardziej powszechnym przypadkiem jest prawdopodobnie potrzeba WP_Queryalbo $wpdb.

Struktura HTML

W treści strony, widżecie lub pliku szablonu:

<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>

Możesz to oczywiście dostosować do swoich upodobań, ale na potrzeby tego przykładu właśnie o to idziemy.
Wygenerujemy powyższe za pomocą krótkiego kodu później.

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;
});

Złożenie go razem w functions.php

Pod powyższym fragmentem (poniżej znajdziesz go zmodyfikowany) wklej następujące elementy:

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' );

Opcjonalnie: css dla ekranu ładowania

.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;
}

Zasoby / Czytanie

Johannes Pille
źródło
1
Czy jest jakiś powód, aby nie korzystać z wbudowanego interfejsu API AJAX?
fuxia
@ toscho Szczerze mówiąc - niezbyt się z tym zaznajomiłem. Warto przeczytać?
Johannes Pille,
Tak, absolutnie. :) Dodam alternatywę.
fuxia
Doskonały! Dziękujemy! <br/> Skrypt będzie działał, jeśli ustawisz argument funkcji? Na przykład, aby mieć krótki kod i podać link do pliku tekstowego? <br/> function random_quote ($path) {      $ array = file ("$ path");<br/> ... [randomquote file = "http://exampe.com/file.txt"]<br/> Więc to zadziała? Nie jestem zbyt zorientowany w programowaniu.
user23769,
Zaktualizowałem odpowiedź. Teraz zawiera ścieżkę do pliku ustawianą przez shortcode [randomquotes path="path/to/file.txt"], przekazywaną do js, ​​a stamtąd do skryptu php.
Johannes Pille,
7

Możesz zarejestrować skrypt za pomocą krótkiego kodu. Zostanie wydrukowany w stopce, biorąc pod uwagę, że motyw zawiera wp_footer().

Jak to działa:

  1. Zarejestruj połączenie zwrotne shortcode za pomocą add_shortcode().
  2. W wywołaniu zwrotnym krótkiego kodu zarejestruj skrypt, a następnie zwróć wynik.
  3. W skrypcie dodaj przycisk aktualizacji, wyślij żądanie POST admin_url( 'admin-ajax.php' )i pobierz nowe dane. Wstaw zwrócone dane do elementu za pomocą krótkiego kodu.

Oto przykładowy skrypt, który to robi. Dwa pliki: klasa PHP i plik JavaScript. Oba powinny na przykład siedzieć w tym samym katalogu 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 );
});

Wynik w blogu:

wprowadź opis zdjęcia tutaj

fuxia
źródło
+1 i dzięki za powyższe. Zdecydowanie warto przeczytać. Myślę, że mam większość tego, co się dzieje powyżej, strony kodeksu są w moim planie czytania i prawdopodobnie i tak sprawdzę źródło. Mimo to pozwól mi odpowiedzieć na 2 szybkie pytania: widzę, że korzystanie z interfejsu API będzie dla mnie korzystne dla programisty (czyste, zwięzłe, powiązane ze środowiskiem (np. WP)). 1. Co powiesz na wydajność? Jakieś zalety lub wady w porównaniu do bezpośredniego korzystania z jQuery (jestem świadomy luki w wydajności w stosunku do prostych J) 2. Czy jest tak elastyczny? Czy mogę korzystać z tych samych wywołań zwrotnych i argumentów?
Johannes Pille,
@JohannesPille Wydajność nie jest doskonała . Z drugiej strony działasz teraz w przewidywalnym środowisku, inne wtyczki mogą ponownie używać Twojego kodu (haczyki, funkcje) i nie musisz wiedzieć, gdzie jest zainstalowana WP (katalog wtyczek / URL może znajdować się na innym serwer). Poza tym jest tak samo jak niestandardowe rozwiązanie.
fuxia
@toscho Kiedy włączona define('WP_DEBUG', true);w moim wp-config.php to rozwiązanie wygenerowany błąd: 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. Czy to jest krytyczne? Trochę to zmieniłem: wordpress.stackexchange.com/q/196332/25187
Iurie Malai
1
@Iurie Tak, tę metodę należy zadeklarować jako static. W tym celu dokonałem edycji mojego postu. Dzięki za powiadomienie. Nie pisałbym już takiego kodu. :)
fuxia