Creating a Custom Directive for WordPress Post Listing on the Front End

redmaomail 2024-07-24 21:52 阅读数 64 #wordpress

重写后的标题为：creating a custom directive for wordpress post listing on the front end

在本系列的前一部分中，我们引导了 AngularJS 应用程序，为不同视图配置了路由，并围绕帖子、用户和类别的路由构建了服务。使用这些服务，我们现在终于能够从服务器获取数据来为前端提供动力。

在本系列的这一部分中，我们将致力于为帖子列表功能构建自定义 AngularJS 指令。在本系列的当前部分中，我们将：

介绍 AngularJS 指令以及为什么我们应该创建一个
规划帖子列表功能的指令及其所需的参数
为帖子列表创建自定义 AngularJS 指令及其模板

所以让我们首先介绍一下 AngularJS 指令以及为什么我们需要它们。

AngularJS 指令简介

AngularJS 中的指令是一种修改 HTML 元素行为和重用可重复代码块的方法。它们可用于修改 HTML 元素及其子元素的结构，因此它们是引入自定义 UI 小部件的完美方式。

在分析本系列第一部分中的线框图时，我们注意到帖子列表功能在三个视图中使用，即：

发布列表
作者简介
类别帖子列表

因此，我们可以创建一个自定义 AngularJS 指令，其中包含使用我们在本系列前面部分创建的服务来检索帖子的业务逻辑，而不是编写单独的功能来列出这三个页面上的帖子。除了业务逻辑之外，该指令还将包含在某些视图上列出帖子的渲染逻辑。也在该指令中定义了帖子分页和根据某些条件检索帖子的功能。

因此，为帖子列表功能创建自定义 AngularJS 指令允许我们仅在一个位置定义该功能，这将使我们将来更容易扩展或修改此功能，而无需更改其中的代码使用它的所有三个实例。

话虽如此，让我们开始为帖子列表功能编写自定义指令。

规划帖子列表的自定义 AngularJS 指令

在我们开始编写用于构建帖子列表功能指令的任何代码之前，让我们分析一下指令中所需的功能。

在最基本的层面上，我们需要一个可以在帖子列表、作者个人资料和类别页面的视图上使用的指令。这意味着我们将创建一个放置在 HTML 中的自定义 UI 小部件（或 DOM 标记），AngularJS 将根据我们为指令的特定实例提供的选项来处理其余的事情。

因此，我们将创建一个由以下标记标识的自定义 UI 小部件：

<post-listing></post-listing>

登录后复制

但是我们还需要这个指令是灵活的，即将参数作为输入并采取相应的行动。考虑用户个人资料页面，我们只希望显示属于该特定用户的帖子，或者类别页面，其中将列出属于该类别的帖子。这些参数可以通过以下两种方式提供：

在 URL 中作为参数
直接将指令作为属性值

在 URL 中提供参数似乎是 API 的本机，因为我们已经熟悉这样做了。因此，用户可以通过以下方式检索属于特定用户的一组帖子：

https://127.0.0.1:8080/#/posts?author=1

登录后复制

上述功能可以通过AngularJS提供的$routeParams服务来实现。我们可以在此处访问用户在 URL 中提供的参数。我们在本系列的前一部分中注册路由时已经研究过它。

至于直接向指令提供参数作为属性值，我们可以使用如下内容：

<post-listing post-args="{author=1}"></post-listing>

登录后复制

上面代码片段中的 post-args 属性采用参数来检索一组特定的帖子，目前它采用作者 ID。此属性可以采用任意数量的参数来检索 /wp/v2/posts 路由支持的帖子。因此，如果我们要检索由 ID 为 1 且属于 ID 10 类别的用户撰写的一组帖子，我们可以执行如下操作：

<post-listing post-args="{author=1, filter[cat]=10}"></post-listing>

登录后复制

上述代码中的 filter[cat] 参数用于检索属于某个类别的一组帖子。

分页也是使用帖子列表页面时的一个基本功能。该指令将处理后分页，并且此功能将由服务器返回的 X-WP-Total 和 X-WP-TotalPages 标头的值驱动与响应主体。因此，用户将能够在上一组帖子和下一组帖子之间来回导航。

确定了用于发布列表的自定义指令的实质内容后，我们现在已经有了相当坚实的基础来开始编写代码。

为帖子列表构建自定义指令

为帖子列表功能构建指令包括两个步骤：

创建用于检索帖子和处理其他内容的业务逻辑。
为这些帖子创建一个渲染视图以显示在页面上。

我们的自定义指令的业务逻辑将在指令声明中处理。为了在 DOM 上呈现数据，我们将创建一个用于列出帖子的自定义模板。让我们从指令声明开始。

指令声明

AngularJS 中的指令可以使用以下语法为模块声明：

/**
 * Creating a custom directive for posts listing
 */
quiescentApp.directive( 'postListing', [function() {
    return {

    };
}] );

登录后复制

在这里，我们使用模块中可用的 .directive() 方法在模块上声明指令。该方法将指令的名称作为第一个参数，并且该名称与元素标签的名称密切相关。由于我们希望 HTML 元素为，因此我们提供了标签名称的驼峰式表示形式。您可以在官方文档中了解有关 AngularJS 执行的规范化过程以匹配指令名称的更多信息。

我们在上面的代码中使用的用于声明指令的符号称为安全样式的依赖注入。在这种表示法中，我们提供了一个依赖项数组作为指令所需的第二个参数。目前，我们尚未为自定义指令定义任何依赖项。但由于我们需要 Posts 服务来检索帖子（我们在本系列的上一部分中创建的）以及本机 AngularJS 的 $routeParams 和 $location服务用于访问URL参数和当前路径，我们定义如下：

/**
 * Creating a custom directive for posts listing
 */
quiescentApp.directive( 'postListing', ['$routeParams', '$location', 'Posts', function( $routeParams, $location, Posts ) {
    return {
        restrict: 'E',
        scope: {
            postArgs: '='
        },
        link: function( $scope, $elem, $attr ) {
        
        }
    };
}] );

登录后复制

然后，这些依赖项可供定义为数组最后一个元素的函数使用。该函数返回一个包含指令定义的对象。目前，我们在指令定义对象中有两个属性，即 restrict 和 link。

restrict 选项定义了我们在代码中使用指令的方式，该选项可以有四个可能的值：

A：用于将指令用作现有 HTML 元素的属性。
E：用于使用指令作为元素名称。
C：用于使用指令作为类名。
M：用于将该指令用作 HTML 注释。

restrict 选项也可以接受上述四个值的任意组合。

由于我们希望指令成为新元素，因此我们将限制选项设置为 E。如果我们要使用预先存在的 HTML 元素上的属性来定义指令，那么我们可以将此选项设置为 A。在这种情况下，我们可以使用在 HTML 代码中定义该指令。

第二个 scope 属性用于修改指令的范围。默认情况下， scope 属性的值为 false，这意味着指令的范围与其父级的范围相同。当我们向它传递一个对象时，会为该指令创建一个隔离的范围，并且需要由其父级传递给该指令的任何数据都通过 HTML 属性传递。这就是我们在代码中所做的，我们使用的属性是 post-args，它被标准化为 postArgs。

scope 对象中的 postArgs 属性可以接受以下三个值中的任意一个：

=：表示传递给属性的值将被视为对象。
@：这意味着传递到属性的值将被视为纯字符串。
&：表示传递给属性的值将被视为函数。

由于我们选择使用 = 值，因此传递到 post-args 属性的任何值都将被视为 JSON 对象，我们可以使用该对象作为检索帖子的参数。

第三个属性 link 用于定义一个函数，该函数用于操作 DOM 并定义该指令所需的 API 和函数。该函数是处理指令所有逻辑的地方。

link 函数接受作用域对象、指令的 HTML 元素以及指令的 HTML 元素上定义的属性的对象的参数。目前，我们分别为范围对象和 HTML 元素传递两个参数 $scope 和 $elem 。

让我们在 $scope 属性上定义一些变量，我们将使用该变量在 DOM 上呈现帖子列表功能。

/**
 * Creating a custom directive for posts listing
 */
quiescentApp.directive( 'postListing', ['$routeParams', '$location', 'Posts', function( $routeParams, $location, Posts ) {
    return {
        restrict: 'E',
        scope: {
            postArgs: '='
        },
        link: function( $scope, $elem, $attr ) {
            // defining variables on the $scope object
            $scope.posts = [];
            $scope.postHeaders = {};
            $scope.currentPage = $routeParams.page ? Math.abs( $routeParams.page ) : 1;
            $scope.nextPage = null;
            $scope.previousPage = null;
            $scope.routeContext = $location.path();
        }
    };
}] );

登录后复制

因此，我们在 $scope 对象上定义了六个属性，我们可以在 DOM 中访问它们。这些属性是：

$posts：保存服务器返回的 post 对象的数组。
$postHeaders：用于保存服务器将与响应正文一起返回的标头的对象。我们将使用它们来处理导航。
$currentPage：保存当前页码的整型变量。
$previousPage：保存上一页页码的变量。
$nextPage：保存下一页编号的变量。
$routeContext：用于使用 $location 服务访问当前路径。

我们之前为 HTML 属性定义的 postArgs 属性已在指令内的 $scope 对象上可用。

现在我们准备使用 Posts 服务向服务器发出请求以检索帖子。但在此之前，我们必须考虑用户作为 URL 参数提供的参数以及 post-args 属性中提供的参数。为此，我们将创建一个函数，使用 $routeParams 服务来提取 URL 参数，并将它们与通过 post-args 属性提供的参数合并：

/**
 * Creating a custom directive for posts listing
 */
quiescentApp.directive( 'postListing', ['$routeParams', '$location', 'Posts', function( $routeParams, $location, Posts ) {
    return {
        restrict: 'E',
        scope: {
            postArgs: '='
        },
        link: function( $scope, $elem, $attr ) {
            // defining variables on the $scope object
            $scope.posts = [];
            $scope.postHeaders = {};
            $scope.currentPage = $routeParams.page ? Math.abs( $routeParams.page ) : 1;
            $scope.nextPage = null;
            $scope.previousPage = null;
            $scope.routeContext = $location.path();
            
            // preparing query arguments
            var prepareQueryArgs = function() {
                var tempParams = $routeParams;
                delete tempParams.id;
                return angular.merge( {}, $scope.postArgs, tempParams );
            };
        }
    };
}] );

登录后复制

上述代码中的 prepareQueryArgs() 方法使用 angular.merge() 方法，该方法扩展了 $scope。 postArgs 对象与 $routeParams 对象。但在合并这两个对象之前，它首先使用 delete 运算符从 $routeParams 对象中删除 id 属性。这是必要的，因为我们将在类别和用户视图上使用此指令，并且我们不希望类别和用户 ID 被错误地解释为帖子 ID。

准备好查询参数后，我们终于准备好调用服务器并检索帖子，我们使用 Posts.query() 方法来执行此操作，该方法采用两个参数：< /p>

包含用于进行查询的参数的对象。
查询完成后执行的回调函数。

因此，我们将使用 prepareQueryArgs() 函数为查询参数准备一个对象，并在回调函数中设置上某些变量的值$scope 属性：

// make the request and query posts
Posts.query( prepareQueryArgs(), function( data, headers ) {
    $scope.posts = data;
    $scope.postHeaders = headers();
    $scope.previousPage = ( ( $scope.currentPage + 1 ) > $scope.postHeaders['x-wp-totalpages'] ) ? null : ( $scope.currentPage + 1 );
    $scope.nextPage = ( ( $scope.currentPage - 1 ) > 0 ) ? ( $scope.currentPage - 1 ) : null;
});

登录后复制

回调函数获取响应正文和响应标头的两个参数。这些分别由 data 和 headers 参数表示。

headers 参数是一个函数，它返回一个包含服务器响应标头的对象。

剩下的代码非常不言自明，因为我们正在设置 $scope.posts 数组的值。为了设置 $scope.previousPage 和 $scope.nextPage 变量的值，我们使用 x-wp-totalpages 属性postHeaders 对象。

现在我们准备使用指令的自定义模板在前端渲染这些数据。

为指令创建自定义模板

为了使我们的指令发挥作用，我们需要做的最后一件事是为帖子列表制作一个单独的模板并将其链接到指令。为此，我们需要修改指令声明并包含 templateUrl 属性，如下所示：

/**
 * Creating a custom directive for posts listing
 */
quiescentApp.directive( 'postListing', ['$routeParams', '$location', 'Posts', function( $routeParams, $location, Posts ) {
    return {
        restrict: 'E',
        scope: {
            postArgs: '='
        },
        templateUrl: 'views/directive-post-listing.html',
        link: function( $scope, $elem, $attr ) {
        
        }
    };
}] );

登录后复制

上面代码中的 templateUrl 属性引用了 views 目录中名为 directive-post-listing.html 的文件。因此，在 views 文件夹中创建此文件并粘贴以下 HTML 代码：

<!-- post listing starts -->
<article class="post-entry">
    <h2 class="post-title"><a href="post-single.html">Good design is a lot like clear thinking made visual.</a></h2>
    <figure class="post-thumbnail">
        <img src="img/img-712-348.jpg" alt="Featured Image">
    </figure>
    <p class="post-meta">
        By <a href="author.html">Bilal Shahid</a> in <a href="category.html">Quotes</a>
    </p>
    <div class="post-content">
        <p>Created days forth. Dominion. Subdue very hath spirit us sixth fish creepeth also. First meat one forth above. You'll Fill for. Can't evening one lights won't. Great of make firmament image. Life his beginning blessed lesser meat spirit blessed seas created green great beginning can't doesn't void moving. Subdue evening make spirit lesser greater all living green firmament winged saw tree one divide wherein divided shall dry very lesser saw, earth the. Light their the.</p>
    </div>
</article>
<!-- post listing ends -->


<!-- pagination links start -->
<div class="post-pagination">
    <a href="#" class="button">Older Posts</a>
    <a href="#" class="button">Newer Posts</a>
</div>		
<!-- pagination links end -->

登录后复制

这是非常基本的 HTML 代码，表示单个帖子条目和帖子分页。我已从 views/listing.html 文件中复制了它。我们将使用一些 AngularJS 指令，包括 ng-repeat、ng-href、ng-src 和 ng -bind-html，显示当前驻留在指令的 $scope 属性中的数据。

将 HTML 代码修改为以下内容：

<!-- post listing starts -->
<article class="post-entry" ng-repeat="post in posts">
    <h2 class="post-title"><a ng-href="#/posts/{{post.slug}}">{{post.title.rendered}}</a></h2>
    <figure class="post-thumbnail" ng-show="post.quiescent_featured_image">
        <img ng-src="{{post.quiescent_featured_image}}" alt="Featured Image">
    </figure>
    <p class="post-meta">
        By <a ng-href="#/users/{{post.author}}">{{post.quiescent_author_name}}</a> 
        in <a ng-href="#/categories/{{category.term_id}}" ng-repeat="category in post.quiescent_categories">{{category.name}}{{$last ? '' : ', '}}</a>
    </p>
    <div class="post-content" ng-bind-html="post.excerpt.rendered"></div>
    </article>
<!-- post listing ends -->

登录后复制

上面的代码使用 ng-repeat 指令来迭代 $scope.posts 数组。指令声明中 $scope 对象上定义的任何属性都可以直接在模板中使用。因此，我们在模板中将 $scope.posts 数组直接引用为 posts 。

通过使用 ng-repeat 指令，我们确保 article.post-entry 容器将在中的每个帖子中重复posts 数组，每个帖子在内循环中被称为 post 。这个 post 对象包含服务器返回的 JSON 格式的数据，包含帖子标题、帖子 ID、帖子内容和特色图像链接等属性，这是同伴添加的附加字段插件。

在下一步中，我们将帖子标题、帖子链接和特色图像链接等值替换为 post 对象中的属性。

对于分页，将之前的代码替换为以下代码：

<!-- pagination links start -->
<div class="post-pagination">
    <a ng-href="#{{routeContext}}?page={{nextPage}}" class="button" ng-class="{'disabled': !nextPage}">Newer Posts</a>
    <a ng-href="#{{routeContext}}?page={{previousPage}}" class="button" ng-class="{'disabled': !previousPage}">Older Posts</a>
</div>		
<!-- pagination links end -->

登录后复制

我们首先访问我们在指令声明中定义的 routeContext 属性，并使用 ?page= 参数作为后缀，并使用 nextPage 和 previousPage 变量用于在帖子之间来回导航。我们还检查下一页或上一页链接是否不是 null，否则我们将 .disabled 类添加到 Zurb Foundation 提供的按钮。

现在我们已经完成了该指令，是时候对其进行测试了。我们通过在 HTML 中放置一个标签来实现这一点，最好位于

的上方标签。这样做意味着帖子列表将出现在页脚上方。不要担心格式和样式，我们将在本系列的下一部分中处理它们。

这就是为帖子列表功能创建自定义 AngularJS 指令的过程。