WordPress 中 get_template_part 函数用法详解

get_template_part() 是 WordPress 中的一个函数，用于加载模板文件的一部分。它的用法如下：

get_template_part( $slug, $name = null );

其中，$slug 是模板文件的名称，而 $name 是可选参数，用于指定模板文件的某一部分。

例如，如果你有一个名为 header.php 的模板文件，你可以在主题的 index.php 文件中使用以下代码来加载该模板文件：

get_template_part( 'header' );

如果你希望加载模板文件的某一部分，你可以在 $slug 参数后面添加一个 - 和一个指定的名称。例如，如果你有一个名为 header-custom.php 的模板文件，你可以使用以下代码来加载该模板文件的某一部分：

get_template_part( 'header', 'custom' );

在这种情况下，WordPress 会在主题文件夹中查找包含 header 和 custom 的文件名的模板文件，并加载该文件。

通常情况下，你可以使用 get_template_part() 函数来加载主题中的共用模板文件，如头部、脚部和侧边栏等。这可以让你在主题中复用代码，并使用相同的模板文件来控制多个页面的布局。

get_template_part 函数示例

1. 使用 get_template_part 在主题的模板文件中加载一个特定的模板部分:

get_template_part( 'template-parts/content', 'page' );

这将加载主题目录中的 template-parts/content-page.php 文件。如果文件不存在，则不会加载任何内容。

2. 使用 get_template_part 在主题的模板文件中加载一个特定的模板部分，并在加载之前和之后调用特定的动作:

do_action( 'before_content_page' );
get_template_part( 'template-parts/content', 'page' );
do_action( 'after_content_page' );

这将加载 template-parts/content-page.php 文件，并在加载之前和之后调用 before_content_page 和 after_content_page 动作。这可以用于在加载模板部分之前或之后执行特定的代码。

3. 使用 get_template_part 在主题的模板文件中加载一个特定的模板部分，并在加载之后返回加载的模板部分的内容:

ob_start();
get_template_part( 'template-parts/content', 'page' );
$content = ob_get_clean();

这将加载 template-parts/content-page.php 文件，并将加载的内容存储在变量 $content 中。这可以用于在加载模板部分之后对其进行处理或使用。

4. 使用 get_template_part 在插件中加载插件目录中的模板部分:

get_template_part( 'template-parts/content', 'page', null, plugin_dir_path( __FILE__ ) );

5. 使用 get_template_part 加载模板部分时使用自定义的模板名称:

$template_name = 'custom-template';
get_template_part( 'template-parts/content', $template_name );

这将加载主题目录中的 template-parts/content-custom-template.php 文件。这可以用于在运行时动态加载不同的模板部分，而无需修改代码。

总之，get_template_part 函数是一个非常有用的工具，可以轻松地加载主题或插件中的模板部分。它允许你将模板的不同部分拆分成多个文件，以便更好地组织和维护你的代码。