Hinzufügen eines benutzerdefinierten Inhaltsvorlagenteils für einen benutzerdefinierten Beitragstyp in der Hauptabfrage mithilfe eines Plugins

Hintergrund

Leider hat get_template_part() function keinen geeigneten Filter, um das zu erreichen, was Sie wollen. Es ist möglich, den Aktions-Hook get_template_part_{$slug} zum Einfügen von Vorlagenteilen zu verwenden. Ohne Änderungen an Ihrem Thema oder einem untergeordneten Thema wird der ursprüngliche Vorlagenteil jedoch trotzdem hinzugefügt. Auf diese Weise können Sie vorhandene Schablonenteile nicht ersetzen.

Sie können jedoch das gewünschte Ergebnis erzielen, indem Sie eine der folgenden Optionen wählen:

Option 1: Verwenden Sie die Standard-CSS-Klassen:

Wenn Sie nur den Stil für den benutzerdefinierten Beitragstyp paper ändern möchten, können Sie einfach die von WordPress generierte CSS-Klasse verwenden. Jedes Standardthema in WordPress generiert $post_type- und type-{$post_type}-CSS-Klassen für den Beitragsinhalt. Der benutzerdefinierte Beitragstyp paper hat beispielsweise paper & type-paper CSS-Klassen, und der allgemeine post hat post und type-post CSS-Klassen. Auch auf der Homepage befindet sich die CSS-Klasse home im Body. Um paper-Einträge auf der Homepage auszurichten, können Sie die folgenden CSS-Regeln verwenden:

body.home .type-paper {
    /* Custom CSS for paper entries in the home page */
}

Option 2: CSS-Klassen ändern:

Wenn Ihnen die Standard-CSS-Klassen nicht ausreichen, können Sie CSS-Klassen auch mit dem post_class filter-Hook in Ihrem Plugin ändern (hinzufügen/entfernen). So was:

add_filter( 'post_class', 'paper_post_class' );
function paper_post_class( $class ) {
    if ( get_post_type() === 'paper' && is_home() ) {

        // remove these classes
        $remove = array( 'css-class-to-remove', 'another-class-to-remove' );
        $class = array_diff( $class, $remove );

        // add these classes
        $add = array( 'custom-paper', 'my-paper-class' );
        $class = array_merge( $add, $class );
    }
    return $class;
}

Auf diese Weise können Sie nicht benötigte CSS-Klassen für paper -Einträge entfernen und neue CSS-Klassen für paper -Einträge hinzufügen, ohne die Designdateien zu ändern. Verwenden Sie dann diese CSS-Klassen, um den Stil von paper-Einträgen nach Bedarf zu ändern.

Option 3: Ändern der Vorlage und der Vorlagenteile

Wenn Ihr gewünschter Stil nicht nur durch Targeting von CSS-Klassen geändert werden kann, können Sie die Template-Teile auch über Ihr Plugin ändern. Da das Ersetzen von durch get_template_part() hinzugefügten Vorlagenteilen durch Hooks nicht möglich ist, müssen Sie die Vorlage so ändern, dass Sie den Aufruf von get_template_part() über das Plugin ändern können.

Zu diesem Zweck können Sie Ihre Hook-Funktion auf pre_get_posts ausrichten und mit template_include filter hook die Homepage-Vorlage wie folgt ändern:

function add_custom_post_types_to_query( $query ) {
    if ( is_home() && $query->is_main_query() ) {
        $query->set( 'post_type', array( 'post', 'paper' ) );

        // now also change the home page template, but only when this condition matches
        add_filter( 'template_include', 'wpse258844_custom_template', 999 );
    }
}
add_action( 'pre_get_posts', 'add_custom_post_types_to_query' ); 

Verwenden Sie dann den folgenden CODE (ändern Sie ihn nach Bedarf):

// for better file management, use a separate "theme-{$theme_name_slug}" directory within your plugin directory
// so if the active theme name is "OnePress", the directory name will be "theme-onepress"
// This will save you a ton of headache if you change the theme,
// as different themes may use different function calls within the templates, which other themes may not have
define( 'wpse258844_TEMPLATE_DIR', plugin_dir_path( __FILE__ ) . sprintf( 'theme-%s/', sanitize_title( wp_get_theme() ) ) );

function wpse258844_custom_template( $template ) {
    // this file will replace your homepage template file
    $index_paper = wpse258844_TEMPLATE_DIR . 'custom-home.php';

    // file_exists() check may need clearing stat cache if you change file name, delete the file etc.
    // Once you are done, comment out or remove clearstatcache(); in production
    clearstatcache();

    if ( file_exists( $index_paper ) ) {
        $template = $index_paper;
    }
    return $template;
}

function wpse258844_get_template_part( $slug, $name = null ) {
    if( get_post_type() === 'paper' ) {

        // just to be consistant with get_template_part() function
        do_action( "get_template_part_{$slug}", $slug, $name );

        $located = '';
        $name = (string) $name;

        // file_exists() check may need clearing stat cache if you change file name, delete the file etc.
        // Once you are done, comment out or remove clearstatcache(); in production
        clearstatcache();

        if ( '' !== $name && file_exists( wpse258844_TEMPLATE_DIR . "{$slug}-{$name}.php" ) ) {
            $located = wpse258844_TEMPLATE_DIR . "{$slug}-{$name}.php";
        }
        else if ( file_exists( wpse258844_TEMPLATE_DIR . "{$slug}.php" ) ) {
            $located = wpse258844_TEMPLATE_DIR . "{$slug}.php";
        }

        if ( '' != $located ) {
            load_template( $located, false );
            return;
        }
    }

    get_template_part( $slug, $name );
}

Sobald du den obigen CODE in deinem Plugin hast (lies die Kommentare im CODE):

1. Erstellen Sie ein neues Verzeichnis in Ihrem Plugin-Verzeichnis, um die Theme-Vorlagendateien zu speichern, z. theme-onepress. Dies wird Ihnen in Zukunft helfen, wenn Sie Designänderungen mit einem anderen Thema testen möchten (ich nehme an, das ist der Hauptzweck all dieser Probleme;)).

2. Erstellen Sie im neuen Verzeichnis theme-onepress eine Datei mit dem Namen custom-home.php. Kopieren Sie den CODE der Homepage-Vorlage aus Ihrem Thema (möglicherweise index.php oder home.php oder was auch immer Ihr Thema für die Homepage-Vorlage verwendet).

3. Ändern Sie jetzt in custom-home.php den gesamten Aufruf von get_template_part in wpse258844_get_template_part. Der Parameter muss nicht geändert werden, nur der Funktionsname. Die Funktion wpse258844_get_template_part() im obigen CODE ist identisch mit der Funktion get_template_part() und greift auf das Standardverhalten zurück, wenn der benutzerdefinierte Vorlagenteil nicht im Verzeichnis theme-{$theme_name_slug} (z. B. theme-onepress) Ihres Plugins gefunden wird.

4. Ersetzen Sie abschließend die Vorlagenteile, die Sie ersetzen möchten, im Verzeichnis theme-{$theme_name_slug} Ihres Plugins.

   Wenn der ursprüngliche Aufruf beispielsweise get_template_part( 'template-parts/content', get_post_format() ) war und Sie den content.php-Vorlagenteil ersetzen möchten, platzieren Sie einfach eine Datei mit dem Namen content.php im theme-onepress/template-parts-Verzeichnis Ihres Plugins. Das heißt, das Verzeichnis theme-onepress verhält sich wie ein untergeordnetes Thema für Vorlagenteile - d. H. Einfaches Ersetzen durch Drop-In.